Skip to main content
POST
/
credit-note-applications
Apply a Credit Note to an Invoice
curl --request POST \
  --url https://eu.sequencehq.com/api/credit-note-applications \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "invoiceId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "amount": 50,
  "currency": "USD",
  "creditNoteBalanceVersion": 3,
  "invoiceBalanceVersion": 7
}
'
{
  "ledgerTransactionId": "0192c1b6-7f3a-7000-8000-000000000001",
  "creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "invoiceId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "amount": 50,
  "currency": "USD",
  "appliedAt": "2026-05-28T12:34:56Z",
  "invoiceBalance": {
    "value": 150,
    "currency": "USD",
    "version": 8
  },
  "creditNoteBalance": {
    "value": 50,
    "currency": "USD",
    "version": 4
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sequencehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

​
Idempotency-Key
string
required

Unique ID for this request (max 255 characters). Retrying with the same ID is safe; the operation runs at most once.

​
Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Body

application/json
​
creditNoteId
string
required

The Credit Note to draw from

Example:

"af60cab3-812d-4250-a051-0fb7133a00c7"

​
invoiceId
string
required

The Invoice to apply credit to

Example:

"61b083e0-1faa-47ca-9aeb-6205da8f6c47"

​
amount
number
required

Amount to allocate from the Credit Note to the Invoice.

Example:

50

​
currency
enum<string>
required

Currency of the amount. Must match the Credit Note and Invoice currency.

Available options:
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
Example:

"GBP"

​
creditNoteBalanceVersion
integer<int64>
required

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

Example:

3

​
invoiceBalanceVersion
integer<int64>
required

Expected current balance version of the Invoice (for OCC)

Example:

7

Response

Created

​
ledgerTransactionId
string
required

Ledger transaction id that recorded the application

Example:

"0192c1b6-7f3a-7000-8000-000000000001"

​
creditNoteId
string
required
Example:

"af60cab3-812d-4250-a051-0fb7133a00c7"

​
invoiceId
string
required
Example:

"61b083e0-1faa-47ca-9aeb-6205da8f6c47"

​
amount
number
required

Amount applied

Example:

50

​
currency
enum<string>
required
Available options:
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
Example:

"GBP"

​
appliedAt
string<date-time>
required
Example:

"2026-05-28T12:34:56Z"

​
invoiceBalance
object
required
Example:
{
  "value": 150,
  "currency": "USD",
  "version": 8
}
​
creditNoteBalance
object
required
Example:
{
  "value": 150,
  "currency": "USD",
  "version": 8
}