Credit Notes

Apply a Credit Note to an Invoice

Changed on

Allocates an amount from a Credit Note's balance to an Invoice's balance.

post/credit-note-applications

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/credit-note-applications
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

creditNoteIdstring required

The Credit Note to draw from

invoiceIdstring required

The Invoice to apply credit to

amountnumber required

Amount to allocate from the Credit Note to the Invoice.

currency'AED' | 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'USD' | 'UYU' | 'ZAR' required
creditNoteBalanceVersioninteger required

Expected current balance version of the Credit Note (for OCC)

invoiceBalanceVersioninteger required

Expected current balance version of the Invoice (for OCC)

Example request

{
  "creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "invoiceId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "amount": 50,
  "currency": "USD",
  "creditNoteBalanceVersion": 3,
  "invoiceBalanceVersion": 7
}

Response

OK

Changes

  • d01512162768Revision changes
    • breaking

      the response's property format changed from date-time to no format for status

    • warning

      deleted the header request parameter Idempotency-Key

    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version

    • info

      added the success response with the status

  • 12ab2101be2aRevision changes
    • breaking

      added the new required header request parameter Idempotency-Key

    • breaking

      removed the success response with the status

    • warning

      deleted the header request parameter sequence-version

    • info

      added the new optional header request parameter Sequence-Version