DELETE
/
credit-notes
/
{id}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

id
string
required

Credit Note ID

Response

200 - application/json
currency
enum<string>
required

Credit Note currency

Available options:
ARS,
AUD,
BRL,
CAD,
CHF,
CNY,
COP,
CZK,
DKK,
EUR,
GBP,
HKD,
ILS,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
customerBillingAddress
object
required

Customer's billing address

customerEmails
string[]
required

Customer's email addresses, used for sending the Credit Note if provided

customerId
string
required

The ID of the Customer this Credit Note is linked to

Customer's legal company name

customerShippingAddress
object
required

Customer's billing address

grossTotal
string
required

Gross total, in decimal format of the Invoice's currency

id
string
required

Credit Note ID

linkedServices
object[]
required

External services which are linked to this credit note

metadata
object[]
required

Mapping of key-value pairs to attach to the Credit Note. These are not interpreted by Sequence; they are present for your use alone.

netTotal
string
required

Net total, in decimal format of the Credit Note's currency

sequenceAccountId
string
required

Sequence Account ID

settings
object
required

Credit note settings

status
enum<string>
required

Credit Note status

Available options:
DRAFT,
FINAL,
IN_PROGRESS,
SENT,
VOIDED
totalTax
string
required

Total tax, in decimal format of the Credit Note's currency

accountingDate
string

Accounting date

billingPeriodEnd
string

Billing period end

billingPeriodStart
string

Billing period start

billingScheduleId
string

Subscription ID

creditNoteNumber
string

Credit Note number

customerTaxId
string

Customer's tax ID

invoiceId
string

Invoice ID

invoiceNumber
string

Invoice Number

issueDate
string

Issue date

memo
string

Credit Note memo

merchantDetails
object

Merchant details

purchaseOrderNumber
string

Purchase order number