Invoices
Create an invoice
Latest Live API
- Account
- Billing
- Collections
- Customer
- Invoices
- Invoice Settings
- Invoices
- 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
- GET
- Invoice Line Items
- Credit Notes
- Credit Note Line Items
- Notifications
- Product
- Quote
- Taxes
- Usage
Version 2024-07-30
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
Invoices
Create an invoice
Create a new invoice
POST
/
invoices
curl --request POST \
--url https://eu.sequencehq.com/api/invoices \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"currency": "GBP",
"dueDate": "2022-09-30",
"purchaseOrderNumber": "PO123",
"reference": "ref",
"customerEmails": [
"customer.user.a@example.com",
"customer.user.b@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",
"paymentOptions": [
"BANK_TRANSFER"
],
"billingPeriod": {
"start": "2022-10-01",
"endInclusive": "2022-10-30"
},
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"metadata": [
{
"key": "example-label",
"value": "label-value"
}
],
"creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
"billingRunId": "53ff21c8-4872-46c4-83bf-517d54876945",
"accountingDate": "2022-09-30",
"attachmentAssetIds": [
"99874519-25ce-46ff-8823-093115aa7222"
]
}'
{
"id": "6cedbb5e-4f77-4217-b8d4-020e7e4d33c9",
"sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
"billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"billingRunId": "9c5fdd27-1f7a-41e7-ab67-14f65272a853",
"status": "DRAFT",
"currency": "GBP",
"invoiceNumber": "INV00001",
"issueDate": "2022-09-15",
"dueDate": "2022-09-30",
"purchaseOrderNumber": "PO123",
"reference": "ref",
"customerEmails": [
"customer.user.a@example.com",
"customer.user.b@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",
"paymentOptions": [
"BANK_TRANSFER"
],
"billingPeriod": {
"start": "2022-10-01",
"endInclusive": "2022-10-30"
},
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"totalTax": "2.50",
"netTotal": "51.20",
"grossTotal": "101.23",
"metadata": [
{
"key": "example-label",
"value": "label-value"
}
],
"customerTaxId": "TAX123",
"paymentStatus": "UNPAID",
"createdAt": "2022-10-30T00:00:00Z",
"updatedAt": "2022-10-30T00:00:00Z",
"creditNoteIds": [
"af60cab3-812d-4250-a051-0fb7133a00c7"
],
"linkedServices": [
{
"externalId": "123",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z",
"externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
}
],
"merchantDetails": {
"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
},
"creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
"dunningStatus": "SCHEDULED",
"accountingDate": "2022-09-30",
"calculatedAt": "2022-09-30T00:00:00Z",
"customerTaxStatus": "TAXED",
"renderSettings": {
"paymentLinkDisplay": "HIDE_PAYMENT_LINK"
},
"isCustomerArchived": false,
"attachmentAssets": [
{
"id": "4b36a61e-425e-4640-aa26-6224c577b613",
"createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
"type": "DOCUMENT",
"format": "PDF",
"fileName": "my-document.pdf",
"fileSizeBytes": 12345,
"url": "https://assets.sequencehq.com/6cedbb5e-4f77-4217-b8d4-020e7e4d33c9/documents/4B36A61E-425E-4640-AA26-6224C577B613.pdf",
"createdAt": "2022-06-28T16:47:00Z"
}
]
}
Headers
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
Available options:
2024-07-30
Body
application/json
Response
201
application/json
Created
The response is of type object
.
curl --request POST \
--url https://eu.sequencehq.com/api/invoices \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"currency": "GBP",
"dueDate": "2022-09-30",
"purchaseOrderNumber": "PO123",
"reference": "ref",
"customerEmails": [
"customer.user.a@example.com",
"customer.user.b@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",
"paymentOptions": [
"BANK_TRANSFER"
],
"billingPeriod": {
"start": "2022-10-01",
"endInclusive": "2022-10-30"
},
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"metadata": [
{
"key": "example-label",
"value": "label-value"
}
],
"creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
"billingRunId": "53ff21c8-4872-46c4-83bf-517d54876945",
"accountingDate": "2022-09-30",
"attachmentAssetIds": [
"99874519-25ce-46ff-8823-093115aa7222"
]
}'
{
"id": "6cedbb5e-4f77-4217-b8d4-020e7e4d33c9",
"sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
"billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"billingRunId": "9c5fdd27-1f7a-41e7-ab67-14f65272a853",
"status": "DRAFT",
"currency": "GBP",
"invoiceNumber": "INV00001",
"issueDate": "2022-09-15",
"dueDate": "2022-09-30",
"purchaseOrderNumber": "PO123",
"reference": "ref",
"customerEmails": [
"customer.user.a@example.com",
"customer.user.b@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",
"paymentOptions": [
"BANK_TRANSFER"
],
"billingPeriod": {
"start": "2022-10-01",
"endInclusive": "2022-10-30"
},
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"totalTax": "2.50",
"netTotal": "51.20",
"grossTotal": "101.23",
"metadata": [
{
"key": "example-label",
"value": "label-value"
}
],
"customerTaxId": "TAX123",
"paymentStatus": "UNPAID",
"createdAt": "2022-10-30T00:00:00Z",
"updatedAt": "2022-10-30T00:00:00Z",
"creditNoteIds": [
"af60cab3-812d-4250-a051-0fb7133a00c7"
],
"linkedServices": [
{
"externalId": "123",
"externalService": "Xero",
"syncTime": "2022-06-28T16:47:00Z",
"externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
}
],
"merchantDetails": {
"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
},
"creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
"dunningStatus": "SCHEDULED",
"accountingDate": "2022-09-30",
"calculatedAt": "2022-09-30T00:00:00Z",
"customerTaxStatus": "TAXED",
"renderSettings": {
"paymentLinkDisplay": "HIDE_PAYMENT_LINK"
},
"isCustomerArchived": false,
"attachmentAssets": [
{
"id": "4b36a61e-425e-4640-aa26-6224c577b613",
"createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
"type": "DOCUMENT",
"format": "PDF",
"fileName": "my-document.pdf",
"fileSizeBytes": 12345,
"url": "https://assets.sequencehq.com/6cedbb5e-4f77-4217-b8d4-020e7e4d33c9/documents/4B36A61E-425E-4640-AA26-6224C577B613.pdf",
"createdAt": "2022-06-28T16:47:00Z"
}
]
}