v1
latestOpenAPI 3.0.02026-07-261733191.1 MBList all Credit Notes
List all Credit Notes for this Sequence account
Query parameters
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).
Sort order. Default: DESC (descending, most often used for reverse chronological sorting).
Sort column. Default: creation time. Options: GROSS_TOTAL, CREDIT_NOTE_NUMBER, STATUS
Filter by credit note status. Options: DRAFT, FINAL, SENT, VOIDED
Filter by customer id.
Filter by sent date before. Format: yyyy-MM-dd
Filter by sent date after. Format: yyyy-MM-dd
Search credit notes by credit note number (partial, case-insensitive match)
Headers
Your API credentials. Eg. Basic {credentials}.
Use this header to select an API version
Response
OK
Example response
{
"items": [
{
"id": "af60cab3-812d-4250-a051-0fb7133a00c7",
"sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
"status": "DRAFT",
"invoiceId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"invoiceNumber": "INV00001",
"billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"currency": "GBP",
"issueDate": "2022-09-15",
"billingPeriodStart": "2022-10-01T00:00:00Z",
"billingPeriodEnd": "2022-10-30T00:00:00Z",
"creditNoteNumber": "CN00001",
"purchaseOrderNumber": "PO123",
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"customerEmails": [
"customer@example.com",
"customer.alias@example.com"
],
"customerLegalCompanyName": "Facebook",
"customerBillingAddress": {
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
},
"customerShippingAddress": {
"line1": "742 Evergreen Terrace",
"town": "Springfield",
"state": "CA",
"postcode": "12345",
"country": "US"
},
"memo": "Thanks",
"totalTax": "2.50",
"netTotal": "51.20",
"grossTotal": "101.23",
"metadata": [
{
"key": "example-label",
"value": "label-value"
}
],
"customerTaxId": "TAX123",
"linkedServices": [
{
"externalId": "123",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z",
"externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
}
],
"applicationStatus": "UNAPPLIED",
"merchantDetails": {
"address": {
"line1": "The White House",
"line2": "1600 Pennsylvania Avenue",
"town": "Washington, D.C.",
"state": "CA",
"postcode": "20500",
"country": "US"
},
"phoneNumber": "0800001066",
"email": "donald@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"
},
"swedishBankgiroDestination": {
"bankgiroNumber": "123-4567",
"accountName": "12345678"
},
"logoUrl": "logo",
"legalCompanyName": "The Merchant",
"primaryColour": "#000000",
"customFields": [
{
"key": "example-label",
"value": "label-value"
}
],
"includeBeneficiaryAddressInPaymentDetails": true
},
"settings": {
"generateCashCreditGrant": "ENABLED"
},
"accountingDate": "2022-09-30"
}
],
"pagination": {
"after": "ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==",
"before": "NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND",
"totalResultSize": 100
}
}