Headers
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
2024-07-30
Body
Credit Note currency
ARS
, AUD
, BRL
, BGN
, CAD
, CHF
, CLP
, CNY
, COP
, CZK
, DKK
, EGP
, EUR
, GBP
, HKD
, ILS
, INR
, ISK
, JPY
, KRW
, MXN
, NOK
, NZD
, PLN
, SEK
, SGD
, THB
, USD
, UYU
, ZAR
"GBP"
The ID of the Customer this Credit Note is linked to
"61b083e0-1faa-47ca-9aeb-6205da8f6c47"
Invoice ID
"af60cab3-812d-4250-a051-0fb7133a00c7"
Billing period start
"2022-10-01T00:00:00Z"
Billing period end
"2022-10-30T00:00:00Z"
Purchase order number
"PO123"
Customer's email addresses, used for sending the Credit Note if provided
[
"customer@example.com",
"customer.alias@example.com"
]
Customer's legal company name
"Facebook"
Customer's billing address
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}
Customer's billing address
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}
Credit Note memo
"Thanks"
Mapping of key-value pairs to attach to the Credit Note. These are not interpreted by Sequence; they are present for your use alone.
[
{
"key": "example-label",
"value": "label-value"
}
]
Customer's tax ID
"TAX123"
Response
Created
Credit Note ID
"af60cab3-812d-4250-a051-0fb7133a00c7"
Sequence Account ID
"68233908-402a-43b4-8952-1c2ab0ef0b25"
Credit Note status
DRAFT
, FINAL
, IN_PROGRESS
, SENT
, VOIDED
"DRAFT"
Credit Note currency
ARS
, AUD
, BRL
, BGN
, CAD
, CHF
, CLP
, CNY
, COP
, CZK
, DKK
, EGP
, EUR
, GBP
, HKD
, ILS
, INR
, ISK
, JPY
, KRW
, MXN
, NOK
, NZD
, PLN
, SEK
, SGD
, THB
, USD
, UYU
, ZAR
"GBP"
The ID of the Customer this Credit Note is linked to
"61b083e0-1faa-47ca-9aeb-6205da8f6c47"
Customer's email addresses, used for sending the Credit Note if provided
[
"customer@example.com",
"customer.alias@example.com"
]
Customer's legal company name
"Facebook"
Customer's billing address
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}
Customer's billing address
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}
Total tax, in decimal format of the Credit Note's currency
"2.50"
Net total, in decimal format of the Credit Note's currency
"51.20"
Gross total, in decimal format of the Invoice's currency
"101.23"
Mapping of key-value pairs to attach to the Credit Note. These are not interpreted by Sequence; they are present for your use alone.
[
{
"key": "example-label",
"value": "label-value"
}
]
External services which are linked to this credit note
[
{
"externalId": "123",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z"
}
]
Credit note settings
{ "generateCashCreditGrant": "ENABLED" }
Invoice ID
"af60cab3-812d-4250-a051-0fb7133a00c7"
Invoice Number
"INV00001"
Subscription ID
"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"
Issue date
"2022-09-15"
Billing period start
"2022-10-01T00:00:00Z"
Billing period end
"2022-10-30T00:00:00Z"
Credit Note number
"CN00001"
Purchase order number
"PO123"
Credit Note memo
"Thanks"
Customer's tax ID
"TAX123"
Merchant details
{
"address": {
"line1": "The White House",
"line2": "1600 Pennsylvania Avenue",
"town": "Washington, D.C.",
"state": "CA",
"postcode": "20500",
"country": "US"
},
"phoneNumber": "0800001066",
"email": "finance@example.com",
"taxId": "TAX60",
"iban": "GB33BUKB20201555555555",
"ukAccountDetails": {
"sortCode": "000000",
"accountNumber": "12345678"
},
"usAchDetails": {
"accountNumber": "12345678",
"accountName": "John Doe",
"bankName": "Chase",
"bankRoutingNumber": "123456789"
},
"usWireDetails": {
"accountNumber": "12345678",
"accountName": "John Doe",
"bankName": "Chase",
"bankRoutingNumber": "123456789",
"swiftCode": "CHASUS33",
"bankAddress": {
"line1": "JP Morgan Chase",
"town": "New York City",
"state": "NY",
"postcode": "10017",
"country": "US"
}
},
"caBankAccountDetails": {
"transitNumber": "123",
"institutionNumber": "12345",
"accountNumber": "1234567"
},
"canadianInternationalDestination": {
"legalName": "John Doe",
"accountNumber": "12345678",
"transitNumber": "12345",
"bankName": "Chase",
"bankAddress": {
"line1": "JP Morgan Chase",
"town": "New York City",
"state": "NY",
"postcode": "10017",
"country": "US"
},
"institutionNumber": "123",
"swiftCode": "CHASUS33",
"intermediaryBank": {
"bankName": "Chase",
"bankAddress": {
"line1": "JP Morgan Chase",
"town": "New York City",
"state": "NY",
"postcode": "10017",
"country": "US"
},
"swiftCode": "CHASUS33",
"routingNumber": "123456789"
}
},
"australianDestination": {
"legalName": "John Doe",
"accountNumber": "12345678",
"swiftCode": "CHASUS33",
"bsb": "123456"
},
"logoUrl": "logo",
"legalCompanyName": "The Merchant",
"primaryColour": "#000000",
"customFields": [
{
"key": "example-label",
"value": "label-value"
}
],
"includeBeneficiaryAddressInPaymentDetails": false
}
Accounting date
"2022-09-30"