PATCH
/
invoices
/
{id}
curl --request PATCH \
  --url https://eu.sequencehq.com/api/invoices/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  },
  "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"
}'
{
  "id": "6cedbb5e-4f77-4217-b8d4-020e7e4d33c9",
  "sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
  "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "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",
  "creditNoteIds": [
    "af60cab3-812d-4250-a051-0fb7133a00c7"
  ],
  "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": "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"
      }
    },
    "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"
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Path Parameters

id
string
required

Invoice ID

Body

application/json
dueDate
string

Due date

purchaseOrderNumber
string

Purchase order number

reference
string

Reference

customerEmails
string[]

Customer email addresses, used for sending the Invoice if provided

customerLegalCompanyName
string

Customer's legal company name

customerBillingAddress
object

Customer's billing address

customerShippingAddress
object

Customer's shipping address

memo
string

Invoice memo

paymentOptions
enum<string>[]

Invoice payment options

Available options:
BANK_TRANSFER,
LINK
billingPeriod
object

Billing period

metadata
object[]

Mapping of key-value pairs to attach to the Invoice. These are not interpreted by Sequence; they are present for your use alone.

creditBalances
string

Credit balances

billingRunId
string

Billing Run ID

accountingDate
string

Accounting date

Response

200 - application/json
id
string
required

Invoice ID

sequenceAccountId
string
required

Sequence Account ID

billingScheduleId
string

Billing Schedule ID

status
enum<string>
required

Invoice status

Available options:
IN_PROGRESS,
DRAFT,
FINAL,
SENT,
VOIDED
currency
enum<string>
required

Invoice currency

Available options:
ARS,
AUD,
BRL,
CAD,
CHF,
CNY,
COP,
CZK,
DKK,
EUR,
GBP,
HKD,
ILS,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
invoiceNumber
string

Invoice number

issueDate
string

Issue date

dueDate
string

Due date

purchaseOrderNumber
string

Purchase order number

reference
string

Reference

customerEmails
string[]
required

Customer email addresses, used for sending the Invoice if provided

customerLegalCompanyName
string
required

Customer's legal company name

customerBillingAddress
object
required

Customer's billing address

customerShippingAddress
object
required

Customer's shipping address

memo
string

Invoice memo

paymentOptions
enum<string>[]

Invoice payment options

Available options:
BANK_TRANSFER,
LINK
billingPeriod
object

Billing period

customerId
string
required

The ID of the Customer this invoice is linked to

totalTax
string
required

Total tax, in decimal format of the Invoice's currency

netTotal
string
required

Net total, in decimal format of the Invoice's currency

grossTotal
string
required

Gross total, in decimal format of the Invoice's currency

metadata
object[]
required

Mapping of key-value pairs to attach to the Invoice. These are not interpreted by Sequence; they are present for your use alone.

customerTaxId
string

Customer's tax ID

paymentStatus
enum<string>
required

Invoice payment status

Available options:
UNPAID,
PARTIALLY_PAID,
PAID,
UNCOLLECTIBLE
createdAt
string
required

Creation time

creditNoteIds
string[]
required

IDs of linked credit notes (if any)

linkedServices
object[]
required

External services which are linked to this invoice

merchantDetails
object

Merchant details

creditBalances
string

Credit balances

dunningStatus
enum<string>

Dunning status

Available options:
SCHEDULED,
COMPLETED,
FAILED,
NOT_REQUIRED
accountingDate
string
required

Accounting date

calculatedAt
string

Time this invoice was last calculated (applicable for invoices generated by billing engine only)

customerTaxStatus
enum<string>

Customer tax status

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED