GET
/
credit-notes
curl --request GET \
  --url https://eu.sequencehq.com/api/credit-notes \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "id": "af60cab3-812d-4250-a051-0fb7133a00c7",
      "sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
      "status": "DRAFT",
      "invoiceId": "af60cab3-812d-4250-a051-0fb7133a00c7",
      "invoiceNumber": "INV00001",
      "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
      "currency": "GBP",
      "issueDate": "2022-09-15",
      "billingPeriodStart": "2022-10-01T00:00:00Z",
      "billingPeriodEnd": "2022-10-30T00:00:00Z",
      "creditNoteNumber": "CN00001",
      "purchaseOrderNumber": "PO123",
      "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
      "customerEmails": [
        "customer@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",
      "totalTax": "2.50",
      "netTotal": "51.20",
      "grossTotal": "101.23",
      "metadata": [
        {
          "key": "example-label",
          "value": "label-value"
        }
      ],
      "customerTaxId": "TAX123",
      "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": "donald@example.com",
        "taxId": "TAX60",
        "logoUrl": "logo",
        "legalCompanyName": "The Merchant",
        "primaryColour": "#000000",
        "customFields": [
          {
            "key": "example-label",
            "value": "label-value"
          }
        ],
        "includeBeneficiaryAddressInPaymentDetails": false
      }
    }
  ],
  "pagination": {
    "after": "ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==",
    "before": "NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND",
    "totalResultSize": 100
  }
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

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. Options: GROSS_TOTAL, CREDIT_NOTE_NUMBER, STATUS

creditNoteStatus
string

Filter by credit note status. Options: DRAFT, FINAL, SENT, VOIDED

customerId
string

Filter by customer id.

sentBefore
string

Filter by sent date before. Format: yyyy-MM-dd

sentAfter
string

Filter by sent date after. Format: yyyy-MM-dd

Response

200 - application/json
items
object[]
required

CreditNotes

pagination
object
required

Results pagination