Latest Live API
Version 2024-07-30
List all Credit Notes
Copy
Ask AI
curl --request GET \
--url https://dev.seqhq.io/api/credit-notes \
--header 'Authorization: <authorization>'Copy
Ask AI
{
"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": [
"[email protected]",
"[email protected]"
],
"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"
}
],
"merchantDetails": {
"address": {
"line1": "The White House",
"line2": "1600 Pennsylvania Avenue",
"town": "Washington, D.C.",
"state": "CA",
"postcode": "20500",
"country": "US"
},
"phoneNumber": "0800001066",
"email": "[email protected]",
"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
}
}Credit Notes
List all Credit Notes
List all Credit Notes for this Sequence account
GET
/
credit-notes
List all Credit Notes
Copy
Ask AI
curl --request GET \
--url https://dev.seqhq.io/api/credit-notes \
--header 'Authorization: <authorization>'Copy
Ask AI
{
"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": [
"[email protected]",
"[email protected]"
],
"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"
}
],
"merchantDetails": {
"address": {
"line1": "The White House",
"line2": "1600 Pennsylvania Avenue",
"town": "Washington, D.C.",
"state": "CA",
"postcode": "20500",
"country": "US"
},
"phoneNumber": "0800001066",
"email": "[email protected]",
"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
}
}Headers
Your API credentials. Eg. Basic {credentials}.
Use this header to select an API version
Available options:
2024-07-30 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, IN_PROGRESS, 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)
Response
OK
CreditNotes
Show child attributes
Show child attributes
Credit Note ID
Example:
"af60cab3-812d-4250-a051-0fb7133a00c7"
Sequence Account ID
Example:
"68233908-402a-43b4-8952-1c2ab0ef0b25"
Credit Note status
Available options:
DRAFT, FINAL, IN_PROGRESS, SENT, VOIDED Example:
"DRAFT"
Credit Note currency
Available options:
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 Example:
"GBP"
The ID of the Customer this Credit Note is linked to
Example:
"61b083e0-1faa-47ca-9aeb-6205da8f6c47"
Customer's email addresses, used for sending the Credit Note if provided
Example:
[
"[email protected]",
"[email protected]"
]Customer's legal company name
Example:
"Facebook"
Customer's billing address
Show child attributes
Show child attributes
Address line 1
Example:
"Flat 1"
Town or city
Example:
"Yemen"
Postal code
Example:
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Example:
"YE"
Address line 2
Example:
"15 Yemen Road"
State (required for USA only)
Available options:
AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT Example:
"CA"
Example:
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}Customer's billing address
Show child attributes
Show child attributes
Address line 1
Example:
"Flat 1"
Town or city
Example:
"Yemen"
Postal code
Example:
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Example:
"YE"
Address line 2
Example:
"15 Yemen Road"
State (required for USA only)
Available options:
AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT Example:
"CA"
Example:
{
"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
Example:
"2.50"
Net total, in decimal format of the Credit Note's currency
Example:
"51.20"
Gross total, in decimal format of the Invoice's currency
Example:
"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.
Example:
[
{
"key": "example-label",
"value": "label-value"
}
]External services which are linked to this credit note
Show child attributes
Show child attributes
The ID of the related entity in external system
Example:
"123"
The connected service
Available options:
Amazon_Redshift, GoCardless, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero, Avalara, Anrok, Attio, Numeral, Rillet Example:
"Xero"
The time that this was synced from the connected integration
Example:
"2022-06-28T16:47:00Z"
External URL
Example:
"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
Example:
[
{
"externalId": "123",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z"
}
]Credit note settings
Show child attributes
Show child attributes
Whether to generate a cash credit grant when sending this credit note
Available options:
ENABLED, DISABLED Example:
"ENABLED"
Example:
{ "generateCashCreditGrant": "ENABLED" }Invoice ID
Example:
"af60cab3-812d-4250-a051-0fb7133a00c7"
Invoice Number
Example:
"INV00001"
Subscription ID
Example:
"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"
Issue date
Example:
"2022-09-15"
Billing period start
Example:
"2022-10-01T00:00:00Z"
Billing period end
Example:
"2022-10-30T00:00:00Z"
Credit Note number
Example:
"CN00001"
Purchase order number
Example:
"PO123"
Credit Note memo
Example:
"Thanks"
Customer's tax ID
Example:
"TAX123"
Merchant details
Show child attributes
Show child attributes
Customer's billing address
Show child attributes
Show child attributes
Address line 1
Example:
"Flat 1"
Town or city
Example:
"Yemen"
Postal code
Example:
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Example:
"YE"
Address line 2
Example:
"15 Yemen Road"
State (required for USA only)
Available options:
AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT Example:
"CA"
Example:
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}Merchant's email
Example:
Merchant's legal company name
Example:
"The Merchant"
Include beneficiary address in payment details on invoice
Example:
false
Merchant's phone number
Example:
"0800001066"
Merchant's tax ID
Example:
"TAX60"
Merchant's IBAN, for receiving payment by bank transfer
Example:
"GB33BUKB20201555555555"
Merchant's UK bank account details, for receiving payment by UK bank transfer
Example:
{
"sortCode": "000000",
"accountNumber": "12345678"
}Merchant's US account details, for receiving payment by ACH
Show child attributes
Show child attributes
Example:
"12345678"
Example:
"John Doe"
Example:
"Chase"
Example:
"123456789"
Example:
{
"accountNumber": "12345678",
"accountName": "John Doe",
"bankName": "Chase",
"bankRoutingNumber": "123456789"
}Merchant's US account details, for receiving payment by wire transfer
Show child attributes
Show child attributes
Example:
"12345678"
Example:
"John Doe"
Example:
"Chase"
Example:
"123456789"
Example:
"CHASUS33"
Customer's billing address
Show child attributes
Show child attributes
Address line 1
Example:
"Flat 1"
Town or city
Example:
"Yemen"
Postal code
Example:
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Example:
"YE"
Address line 2
Example:
"15 Yemen Road"
State (required for USA only)
Available options:
AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT Example:
"CA"
Example:
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}Example:
{
"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"
}
}Merchant's Canadian account details, for receiving payment by Canadian bank transfer
Example:
{
"transitNumber": "123",
"institutionNumber": "12345",
"accountNumber": "1234567"
}Merchant's account details, for receiving payment to a Canadian bank via Wire transfer
Show child attributes
Show child attributes
Example:
"John Doe"
Example:
"12345678"
Example:
"12345"
Example:
"Chase"
Customer's billing address
Show child attributes
Show child attributes
Address line 1
Example:
"Flat 1"
Town or city
Example:
"Yemen"
Postal code
Example:
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Example:
"YE"
Address line 2
Example:
"15 Yemen Road"
State (required for USA only)
Available options:
AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT Example:
"CA"
Example:
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}Example:
"123"
Example:
"CHASUS33"
Show child attributes
Show child attributes
Example:
"Chase"
Customer's billing address
Show child attributes
Show child attributes
items.merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.line1
string
required
Address line 1
Example:
"Flat 1"
items.merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.town
string
required
Town or city
Example:
"Yemen"
items.merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.postcode
string
required
Postal code
Example:
"YE1 2YE"
items.merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.country
enum<string>
required
Country code (ISO 3166-1 alpha-2)
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Example:
"YE"
Address line 2
Example:
"15 Yemen Road"
items.merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.state
enum<string>
State (required for USA only)
Available options:
AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT Example:
"CA"
Example:
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}Example:
"CHASUS33"
items.merchantDetails.canadianInternationalDestination.intermediaryBank.routingNumber
string
required
Example:
"123456789"
Example:
{
"bankName": "Chase",
"bankAddress": {
"line1": "JP Morgan Chase",
"town": "New York City",
"state": "NY",
"postcode": "10017",
"country": "US"
},
"swiftCode": "CHASUS33",
"routingNumber": "123456789"
}Example:
{
"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"
}
}Merchant's account details, for receiving payment to a Canadian bank via Australian bank transfer
Show child attributes
Show child attributes
Example:
"John Doe"
Example:
"12345678"
Example:
"CHASUS33"
Example:
"123456"
Example:
{
"legalName": "John Doe",
"accountNumber": "12345678",
"swiftCode": "CHASUS33",
"bsb": "123456"
}Merchant's logo image URL
Example:
"logo"
Merchant's primary colour (for invoice rendering)
Example:
"#000000"
Example:
{
"address": {
"line1": "The White House",
"line2": "1600 Pennsylvania Avenue",
"town": "Washington, D.C.",
"state": "CA",
"postcode": "20500",
"country": "US"
},
"phoneNumber": "0800001066",
"email": "[email protected]",
"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
Example:
"2022-09-30"
Example:
[
{
"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": [
"[email protected]",
"[email protected]"
],
"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"
}
],
"merchantDetails": {
"address": {
"line1": "The White House",
"line2": "1600 Pennsylvania Avenue",
"town": "Washington, D.C.",
"state": "CA",
"postcode": "20500",
"country": "US"
},
"phoneNumber": "0800001066",
"email": "[email protected]",
"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"
}
]Results pagination
Show child attributes
Show child attributes
Copy this value to the after parameter of your next request to retrieve the next page of results
Example:
"ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw=="
Copy this value to the before parameter of your next request to retrieve the next page of results
Example:
"NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND"
Total number of entries across all pages
Example:
100
Example:
{
"after": "ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==",
"before": "NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND",
"totalResultSize": 100
}⌘I