DELETE
/
invoices
/
{id}
curl --request DELETE \
  --url https://eu.sequencehq.com/api/invoices/{id} \
  --header 'Authorization: <authorization>'
{
  "accountingDate": "2022-09-30",
  "billingPeriod": {
    "endInclusive": "2022-10-30",
    "start": "2022-10-01"
  },
  "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "calculatedAt": "2022-09-30T00:00:00Z",
  "createdAt": "2022-10-30T00:00:00Z",
  "creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
  "creditNoteIds": [
    "af60cab3-812d-4250-a051-0fb7133a00c7"
  ],
  "currency": "GBP",
  "customerBillingAddress": {
    "country": "YE",
    "line1": "Flat 1",
    "line2": "15 Yemen Road",
    "postcode": "YE1 2YE",
    "state": "CA",
    "town": "Yemen"
  },
  "customerEmails": [
    "customer.user.a@example.com",
    "customer.user.b@example.com"
  ],
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "customerLegalCompanyName": "Facebook",
  "customerShippingAddress": {
    "country": "US",
    "line1": "742 Evergreen Terrace",
    "postcode": "12345",
    "state": "CA",
    "town": "Springfield"
  },
  "customerTaxId": "TAX123",
  "dueDate": "2022-09-30",
  "dunningStatus": "SCHEDULED",
  "grossTotal": "101.23",
  "id": "6cedbb5e-4f77-4217-b8d4-020e7e4d33c9",
  "invoiceNumber": "INV00001",
  "issueDate": "2022-09-15",
  "linkedServices": [
    {
      "externalId": "123",
      "externalService": "Xero",
      "syncTime": "2022-06-28T16:47:00Z"
    }
  ],
  "memo": "Thanks",
  "merchantDetails": {
    "address": {
      "country": "US",
      "line1": "The White House",
      "line2": "1600 Pennsylvania Avenue",
      "postcode": "20500",
      "state": "CA",
      "town": "Washington, D.C."
    },
    "caBankAccountDetails": {
      "accountNumber": "1234567",
      "institutionNumber": "12345",
      "transitNumber": "123"
    },
    "canadianInternationalDestination": {
      "accountNumber": "12345678",
      "bankAddress": {
        "country": "US",
        "line1": "JP Morgan Chase",
        "postcode": "10017",
        "state": "NY",
        "town": "New York City"
      },
      "bankName": "Chase",
      "institutionNumber": "123",
      "intermediaryBank": {
        "bankAddress": {
          "country": "US",
          "line1": "JP Morgan Chase",
          "postcode": "10017",
          "state": "NY",
          "town": "New York City"
        },
        "bankName": "Chase",
        "routingNumber": "123456789",
        "swiftCode": "CHASUS33"
      },
      "legalName": "John Doe",
      "swiftCode": "CHASUS33",
      "transitNumber": "12345"
    },
    "customFields": [
      {
        "key": "example-label",
        "value": "label-value"
      }
    ],
    "email": "finance@example.com",
    "iban": "GB33BUKB20201555555555",
    "includeBeneficiaryAddressInPaymentDetails": false,
    "legalCompanyName": "The Merchant",
    "logoUrl": "logo",
    "phoneNumber": "0800001066",
    "primaryColour": "#000000",
    "taxId": "TAX60",
    "ukAccountDetails": {
      "accountNumber": "12345678",
      "sortCode": "000000"
    },
    "usAchDetails": {
      "accountName": "John Doe",
      "accountNumber": "12345678",
      "bankName": "Chase",
      "bankRoutingNumber": "123456789"
    },
    "usWireDetails": {
      "accountName": "John Doe",
      "accountNumber": "12345678",
      "bankAddress": {
        "country": "US",
        "line1": "JP Morgan Chase",
        "postcode": "10017",
        "state": "NY",
        "town": "New York City"
      },
      "bankName": "Chase",
      "bankRoutingNumber": "123456789",
      "swiftCode": "CHASUS33"
    }
  },
  "metadata": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "netTotal": "51.20",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "paymentStatus": "UNPAID",
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
  "status": "DRAFT",
  "totalTax": "2.50"
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Path Parameters

id
string
required

Invoice ID

Response

200 - application/json
accountingDate
string
required

Accounting date

billingPeriod
object
billingScheduleId
string

Billing Schedule ID

calculatedAt
string

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

createdAt
string
required

Creation time

creditBalances
string

Credit balances

creditNoteIds
string[]
required

IDs of linked credit notes (if any)

currency
enum<string>
required
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
customerBillingAddress
object
required
customerEmails
string[]
required

Customer email addresses, used for sending the Invoice if provided

customerId
string
required

The ID of the Customer this invoice is linked to

customerLegalCompanyName
string
required

Customer's legal company name

customerShippingAddress
object
required
customerTaxId
string

Customer's tax ID

dueDate
string

Due date

dunningStatus
enum<string>
Available options:
SCHEDULED,
COMPLETED,
FAILED,
NOT_REQUIRED
grossTotal
string
required

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

id
string
required

Invoice ID

invoiceNumber
string

Invoice number

issueDate
string

Issue date

linkedServices
object[]
required

External services which are linked to this invoice

memo
string

Invoice memo

merchantDetails
object
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.

netTotal
string
required

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

paymentOptions
enum<string>[]

Invoice payment options

Available options:
BANK_TRANSFER,
LINK
paymentStatus
enum<string>
required
Available options:
UNPAID,
PARTIALLY_PAID,
PAID,
UNCOLLECTIBLE
purchaseOrderNumber
string

Purchase order number

reference
string

Reference

sequenceAccountId
string
required

Sequence Account ID

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

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