POST
/
credit-notes
/
{id}
/
void
Header
Path
Query
curl --request POST \
  --url https://eu.sequencehq.com/api/credit-notes/{id}/void \
  --header 'Authorization: <authorization>'
{
  "billingPeriodEnd": "2022-10-30T00:00:00Z",
  "billingPeriodStart": "2022-10-01T00:00:00Z",
  "creditNoteNumber": "CN00001",
  "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"
  },
  "grossTotal": "0",
  "id": "941272d1-f840-4e16-b698-0cd455c81e0e",
  "invoiceId": "06c44e52-b8f4-4588-a2a6-001169ebf80e",
  "invoiceNumber": "INV00001",
  "issueDate": "2022-11-05",
  "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": [],
  "netTotal": "0",
  "purchaseOrderNumber": "PO123",
  "sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
  "status": "DRAFT",
  "totalTax": "0"
}

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.

Path Parameters

idrequired
string

Credit Note ID

Query Parameters

creditNoteNumber
string

Credit note number

Response

200 - application/json
billingPeriodEnd
string
billingPeriodStart
string
creditNoteNumber
string
currencyrequired
enum<string>
Available options:
GBP,
EUR,
USD,
CAD,
ZAR,
ARS,
UYU,
COP,
MXN,
AUD
customerBillingAddressrequired
object
customerEmailrequired
string
customerIdrequired
string
customerLegalCompanyNamerequired
string
customerShippingAddressrequired
object
grossTotalrequired
string
idrequired
string
invoiceId
string
invoiceNumber
string
issueDate
string
linkedServicesrequired
object[]
memo
string
merchantDetails
object
metadatarequired
any[]
netTotalrequired
string
purchaseOrderNumber
string
sequenceAccountIdrequired
string
statusrequired
enum<string>
Available options:
DRAFT,
FINAL,
SENT,
VOIDED
totalTaxrequired
string