Latest Live API
Version 2024-07-30
- GETList all Invoices
- POSTCreate an invoice
- GETGet an Invoice by ID
- PUTUpdate an invoice
- DELDelete an Invoice
- PATCHPatch an invoice
- GETDownload invoice PDF
- POSTFinalize and send invoice
- POSTFinalize invoice
- POSTSend invoice
- POSTSend a payment reminder for an invoice
- PUTUpdate payment status for an invoice
- POSTVoid an Invoice
- POSTConvert upcoming invoice to draft
- POSTMerge invoices
- POSTFix invoices billing runs
- POSTReconcile invoices with external integration
- POSTFinalize and mark invoice as sent without triggering actions
- GETList Currency Conversions for an Invoice
- GET
curl --request GET \
--url https://dev.seqhq.io/api/invoices \
--header 'Authorization: <authorization>'{
"items": [
{
"id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
"sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
"status": "DRAFT",
"currency": "GBP",
"invoiceNumber": "INV2",
"dueDate": "2022-11-05",
"purchaseOrderNumber": "PO123",
"reference": "ref",
"customerEmails": [
"[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",
"line2": "",
"town": "Springfield",
"state": "CA",
"postcode": "12345",
"country": "US"
},
"memo": "Thanks",
"paymentOptions": [
"BANK_TRANSFER"
],
"billingPeriod": {
"start": "2022-10-01",
"endInclusive": "2022-10-30"
},
"customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
"totalTax": "2",
"netTotal": "12",
"grossTotal": "10",
"metadata": [
{
"key": "example-label",
"value": "label-value"
}
],
"paymentStatus": "UNPAID",
"createdAt": "2022-10-30T00:00:00Z",
"creditNoteIds": [
"941272d1-f840-4e16-b698-0cd455c81e0e"
],
"linkedServices": [
{
"externalId": "ID",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z"
}
],
"merchantDetails": {
"address": {
"line1": "Flat 1",
"line2": "123 Fake Street",
"town": "New York",
"state": "NY",
"postcode": "AB1 2EF",
"country": "US"
},
"phoneNumber": "0800001066",
"email": "[email protected]",
"taxId": "TAX",
"iban": "GB33BUKB20201555555555",
"ukAccountDetails": {
"sortCode": "123456",
"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"
}
},
"legalCompanyName": "The Merchant",
"customFields": [],
"includeBeneficiaryAddressInPaymentDetails": false
},
"accountingDate": "2022-10-05",
"customerTaxStatus": "TAXED",
"renderSettings": {
"paymentLinkDisplay": "HIDE_PAYMENT_LINK"
},
"isCustomerArchived": false,
"updatedAt": "2022-10-30T00:00:00Z"
}
],
"pagination": {
"after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
"before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
"totalResultSize": 10
}
}List all Invoices
List all Invoices
curl --request GET \
--url https://dev.seqhq.io/api/invoices \
--header 'Authorization: <authorization>'{
"items": [
{
"id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
"sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
"status": "DRAFT",
"currency": "GBP",
"invoiceNumber": "INV2",
"dueDate": "2022-11-05",
"purchaseOrderNumber": "PO123",
"reference": "ref",
"customerEmails": [
"[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",
"line2": "",
"town": "Springfield",
"state": "CA",
"postcode": "12345",
"country": "US"
},
"memo": "Thanks",
"paymentOptions": [
"BANK_TRANSFER"
],
"billingPeriod": {
"start": "2022-10-01",
"endInclusive": "2022-10-30"
},
"customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
"totalTax": "2",
"netTotal": "12",
"grossTotal": "10",
"metadata": [
{
"key": "example-label",
"value": "label-value"
}
],
"paymentStatus": "UNPAID",
"createdAt": "2022-10-30T00:00:00Z",
"creditNoteIds": [
"941272d1-f840-4e16-b698-0cd455c81e0e"
],
"linkedServices": [
{
"externalId": "ID",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z"
}
],
"merchantDetails": {
"address": {
"line1": "Flat 1",
"line2": "123 Fake Street",
"town": "New York",
"state": "NY",
"postcode": "AB1 2EF",
"country": "US"
},
"phoneNumber": "0800001066",
"email": "[email protected]",
"taxId": "TAX",
"iban": "GB33BUKB20201555555555",
"ukAccountDetails": {
"sortCode": "123456",
"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"
}
},
"legalCompanyName": "The Merchant",
"customFields": [],
"includeBeneficiaryAddressInPaymentDetails": false
},
"accountingDate": "2022-10-05",
"customerTaxStatus": "TAXED",
"renderSettings": {
"paymentLinkDisplay": "HIDE_PAYMENT_LINK"
},
"isCustomerArchived": false,
"updatedAt": "2022-10-30T00:00:00Z"
}
],
"pagination": {
"after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
"before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
"totalResultSize": 10
}
}Headers
Your API credentials. Eg. Basic {credentials}.
Use this header to select an API version
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: CUSTOMER_LEGAL_COMPANY_NAME, GROSS_TOTAL, ACCOUNTING_DATE
Filter by invoice status. Options: IN_PROGRESS, DRAFT, FINAL, SENT, VOIDED
Filter by payment status. Options: UNPAID, PARTIALLY_PAID, PAID, UNCOLLECTIBLE
Filter by customer id.
Filter by billing schedule id.
Filter by due date before. Format: yyyy-MM-dd
Filter by due date after. Format: yyyy-MM-dd
Filter by sent date before. Format: yyyy-MM-dd
Filter by sent date after. Format: yyyy-MM-dd
Filter by invoice date before. Format: yyyy-MM-dd
Filter by invoice date after. Format: yyyy-MM-dd
Exclude invoices with zero quantity.
Get invoices for a specific currency (provide a comma-separated list)
Search invoices by invoice number (partial, case-insensitive match)
Filter by invoice number
Filter by net total amount
Response
OK
Invoices
Show child attributes
Show child attributes
Invoice ID
"ba37a392-7054-4dae-ab37-6fee9e23fe06"
Sequence Account ID
"af9b5988-1d7b-45f6-a188-326df5e59b24"
Invoice status
IN_PROGRESS, DRAFT, FINAL, SENT, VOIDED "DRAFT"
Invoice 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"
Customer's legal company name
"Facebook"
Customer's billing address
Show child attributes
Show child attributes
Address line 1
"Flat 1"
Town or city
"Yemen"
Postal code
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
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 "YE"
Address line 2
"15 Yemen Road"
State (required for USA only)
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 "CA"
{
"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
"Flat 1"
Town or city
"Yemen"
Postal code
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
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 "YE"
Address line 2
"15 Yemen Road"
State (required for USA only)
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 "CA"
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}The ID of the Customer this invoice is linked to
"b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a"
Total tax, in decimal format of the Invoice's currency
"2"
Net total, in decimal format of the Invoice's currency
"12"
Gross total, in decimal format of the Invoice's currency
"10"
Mapping of key-value pairs to attach to the Invoice. These are not interpreted by Sequence; they are present for your use alone.
[
{
"key": "example-label",
"value": "label-value"
}
]Invoice payment status
UNPAID, PARTIALLY_PAID, PAID, UNCOLLECTIBLE "UNPAID"
Creation time
"2022-10-30T00:00:00Z"
IDs of linked credit notes (if any)
["941272d1-f840-4e16-b698-0cd455c81e0e"]External services which are linked to this invoice
Show child attributes
Show child attributes
The ID of the related entity in external system
"123"
The connected service
Amazon_Redshift, GoCardless, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero, Avalara, Anrok, Attio, Numeral, Rillet "Xero"
The time that this was synced from the connected integration
"2022-06-28T16:47:00Z"
External URL
"https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
[
{
"externalId": "ID",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z"
}
]Accounting date
"2022-10-05"
Settings that control how the invoice is rendered.
Show child attributes
Show child attributes
Payment link display preference. By default, the payment link is shown.
SHOW_PAYMENT_LINK, HIDE_PAYMENT_LINK "SHOW_PAYMENT_LINK"
{ "paymentLinkDisplay": "HIDE_PAYMENT_LINK" }false
Last updated time
"2022-10-30T00:00:00Z"
Invoice number
"INV2"
Due date
"2022-11-05"
Purchase order number
"PO123"
Reference
"ref"
Invoice memo
"Thanks"
Invoice payment options
BANK_TRANSFER, LINK ["BANK_TRANSFER"]Billing period
{
"start": "2022-10-01",
"endInclusive": "2022-10-30"
}Merchant details
Show child attributes
Show child attributes
Customer's billing address
Show child attributes
Show child attributes
Address line 1
"Flat 1"
Town or city
"Yemen"
Postal code
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
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 "YE"
Address line 2
"15 Yemen Road"
State (required for USA only)
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 "CA"
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}Merchant's email
Merchant's legal company name
"The Merchant"
Include beneficiary address in payment details on invoice
false
Merchant's phone number
"0800001066"
Merchant's tax ID
"TAX60"
Merchant's IBAN, for receiving payment by bank transfer
"GB33BUKB20201555555555"
Merchant's UK bank account details, for receiving payment by UK bank transfer
{
"sortCode": "000000",
"accountNumber": "12345678"
}Merchant's US account details, for receiving payment by ACH
Show child attributes
Show child attributes
"12345678"
"John Doe"
"Chase"
"123456789"
{
"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
"12345678"
"John Doe"
"Chase"
"123456789"
"CHASUS33"
Customer's billing address
Show child attributes
Show child attributes
Address line 1
"Flat 1"
Town or city
"Yemen"
Postal code
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
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 "YE"
Address line 2
"15 Yemen Road"
State (required for USA only)
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 "CA"
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}{
"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
{
"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
"John Doe"
"12345678"
"12345"
"Chase"
Customer's billing address
Show child attributes
Show child attributes
Address line 1
"Flat 1"
Town or city
"Yemen"
Postal code
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
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 "YE"
Address line 2
"15 Yemen Road"
State (required for USA only)
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 "CA"
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}"123"
"CHASUS33"
Show child attributes
Show child attributes
"Chase"
Customer's billing address
Show child attributes
Show child attributes
Address line 1
"Flat 1"
Town or city
"Yemen"
Postal code
"YE1 2YE"
Country code (ISO 3166-1 alpha-2)
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 "YE"
Address line 2
"15 Yemen Road"
State (required for USA only)
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 "CA"
{
"line1": "Flat 1",
"line2": "15 Yemen Road",
"town": "Yemen",
"state": "CA",
"postcode": "YE1 2YE",
"country": "YE"
}"CHASUS33"
"123456789"
{
"bankName": "Chase",
"bankAddress": {
"line1": "JP Morgan Chase",
"town": "New York City",
"state": "NY",
"postcode": "10017",
"country": "US"
},
"swiftCode": "CHASUS33",
"routingNumber": "123456789"
}{
"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
"John Doe"
"12345678"
"CHASUS33"
"123456"
{
"legalName": "John Doe",
"accountNumber": "12345678",
"swiftCode": "CHASUS33",
"bsb": "123456"
}Merchant's logo image URL
"logo"
Merchant's primary colour (for invoice rendering)
"#000000"
{
"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
}Customer tax status
TAXED, TAX_EXEMPT, REVERSE_CHARGED "TAXED"
[
{
"id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
"sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
"status": "DRAFT",
"currency": "GBP",
"invoiceNumber": "INV2",
"dueDate": "2022-11-05",
"purchaseOrderNumber": "PO123",
"reference": "ref",
"customerEmails": ["[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",
"line2": "",
"town": "Springfield",
"state": "CA",
"postcode": "12345",
"country": "US"
},
"memo": "Thanks",
"paymentOptions": ["BANK_TRANSFER"],
"billingPeriod": {
"start": "2022-10-01",
"endInclusive": "2022-10-30"
},
"customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
"totalTax": "2",
"netTotal": "12",
"grossTotal": "10",
"metadata": [
{
"key": "example-label",
"value": "label-value"
}
],
"paymentStatus": "UNPAID",
"createdAt": "2022-10-30T00:00:00Z",
"creditNoteIds": ["941272d1-f840-4e16-b698-0cd455c81e0e"],
"linkedServices": [
{
"externalId": "ID",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z"
}
],
"merchantDetails": {
"address": {
"line1": "Flat 1",
"line2": "123 Fake Street",
"town": "New York",
"state": "NY",
"postcode": "AB1 2EF",
"country": "US"
},
"phoneNumber": "0800001066",
"email": "[email protected]",
"taxId": "TAX",
"iban": "GB33BUKB20201555555555",
"ukAccountDetails": {
"sortCode": "123456",
"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"
}
},
"legalCompanyName": "The Merchant",
"customFields": [],
"includeBeneficiaryAddressInPaymentDetails": false
},
"accountingDate": "2022-10-05",
"customerTaxStatus": "TAXED",
"renderSettings": { "paymentLinkDisplay": "HIDE_PAYMENT_LINK" },
"isCustomerArchived": false,
"updatedAt": "2022-10-30T00:00:00Z"
}
]Results pagination
Show child attributes
Show child attributes
Cursor for the page after this (if it exists)
"MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3"
Cursor for the page before this (if it exists)
"MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz"
Total number of entries across all pages
10
{
"after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
"before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
"totalResultSize": 10
}