GET
/
invoices
Header
Query
curl --request GET \
  --url https://eu.sequencehq.com/api/invoices \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "billingPeriodEnd": "2022-10-30",
      "billingPeriodStart": "2022-10-01",
      "createdAt": "2022-10-30T00:00:00Z",
      "creditNoteIds": [
        "941272d1-f840-4e16-b698-0cd455c81e0e"
      ],
      "currency": "GBP",
      "customerBillingAddress": {
        "country": "YE",
        "line1": "Flat 1",
        "line2": "15 Yemen Road",
        "postCode": "YE1 2YE",
        "state": "CA",
        "town": "Yemen"
      },
      "customerEmail": "customer@example.com",
      "customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
      "customerLegalCompanyName": "Facebook",
      "customerShippingAddress": {
        "country": "US",
        "line1": "742 Evergreen Terrace",
        "line2": "",
        "postCode": "12345",
        "state": "CA",
        "town": "Springfield"
      },
      "dueDate": "2022-11-05",
      "grossTotal": "0",
      "id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
      "invoiceNumber": "INV2",
      "linkedServices": [
        {
          "externalId": "ID",
          "externalService": "Xero",
          "syncTime": "2022-06-28T16:47:00Z"
        }
      ],
      "memo": "Thanks",
      "merchantDetails": {
        "address": {
          "country": "US",
          "line1": "The White House",
          "line2": "1600 Pennsylvania Avenue",
          "postCode": "20500",
          "town": "Washington, D.C."
        },
        "customFields": [],
        "email": "donald@example.com",
        "iban": "GB33BUKB20201555555555",
        "legalCompanyName": "The Merchant",
        "phoneNumber": "0800001066",
        "taxId": "TAX",
        "ukAccountDetails": {
          "accountNumber": "12345678",
          "sortCode": "123456"
        },
        "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": "0",
      "paymentOptions": [
        "BANK_TRANSFER"
      ],
      "paymentStatus": "UNPAID",
      "purchaseOrderNumber": "PO123",
      "sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
      "status": "DRAFT",
      "totalTax": "0"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

Headers

Authorizationrequired
string

Your API credentials. Eg. Basic {credentials}.

Idempotency-Key
string

Specifying a unique ID for this request here lets you retry it without risk of performing the same operation twice.

Query Parameters

before
string

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.

after
string

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.

limit
integer

Maximum number of objects to return per-page.

sortOrder
string

Sort order. Default: DESC (descending, most often used for reverse chronological sorting).

sortBy
string

Sort column. Default: creation time.

invoiceStatus
string

Filter by invoice status.

customerId
string

Filter by customer id.

dueBefore
string

Filter by due date before.

dueAfter
string

Filter by due date after.

sentBefore
string

Filter by sent date before.

sentAfter
string

Filter by sent date after.

Response

200 - application/json
itemsrequired
object[]
paginationrequired
object
Delete a DiscountCreate a new Invoice