POST
/
credit-notes
/
{id}
/
finalize
curl --request POST \
  --url https://eu.sequencehq.com/api/credit-notes/{id}/finalize \
  --header 'Authorization: <authorization>'
{
  "id": "941272d1-f840-4e16-b698-0cd455c81e0e",
  "sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
  "status": "DRAFT",
  "invoiceId": "06c44e52-b8f4-4588-a2a6-001169ebf80e",
  "invoiceNumber": "INV00001",
  "currency": "GBP",
  "issueDate": "2022-11-05",
  "billingPeriodStart": "2022-10-01T00:00:00Z",
  "billingPeriodEnd": "2022-10-30T00:00:00Z",
  "creditNoteNumber": "CN00001",
  "purchaseOrderNumber": "PO123",
  "customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
  "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",
    "line2": "",
    "town": "Springfield",
    "state": "CA",
    "postcode": "12345",
    "country": "US"
  },
  "memo": "Thanks",
  "totalTax": "0",
  "netTotal": "0",
  "grossTotal": "0",
  "metadata": [],
  "linkedServices": [
    {
      "externalId": "ID",
      "externalService": "Xero",
      "syncTime": "2022-06-28T16:47:00Z"
    }
  ],
  "merchantDetails": {
    "address": {
      "line1": "Flat 1",
      "line2": "123 Fake Street",
      "town": "New York",
      "state": "NY",
      "postcode": "AB1 2EF",
      "country": "US"
    },
    "phoneNumber": "0800001066",
    "email": "donald@example.com",
    "taxId": "TAX",
    "iban": "GB33BUKB20201555555555",
    "ukAccountDetails": {
      "sortCode": "123456",
      "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"
      }
    },
    "legalCompanyName": "The Merchant",
    "customFields": [],
    "includeBeneficiaryAddressInPaymentDetails": false
  }
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Path Parameters

id
string
required

Credit Note Id

Query Parameters

creditNoteNumber
string

Credit note number

Response

200 - application/json
id
string
required

Credit Note ID

sequenceAccountId
string
required

Sequence Account ID

status
enum<string>
required

Credit Note status

Available options:
DRAFT,
FINAL,
SENT,
VOIDED
invoiceId
string

Invoice ID

invoiceNumber
string

Invoice Number

currency
enum<string>
required

Credit Note 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
issueDate
string

Issue date

billingPeriodStart
string

Billing period start

billingPeriodEnd
string

Billing period end

creditNoteNumber
string

Credit Note number

purchaseOrderNumber
string

Purchase order number

customerId
string
required

The ID of the Customer this Credit Note is linked to

customerEmails
string[]
required

Customer's email addresses, used for sending the Credit Note 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

Credit Note memo

totalTax
string
required

Total tax, in decimal format of the Credit Note's currency

netTotal
string
required

Net total, in decimal format of the Credit Note's currency

grossTotal
string
required

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

metadata
any[]
required

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

linkedServices
object[]
required

External services which are linked to this credit note

merchantDetails
object

Merchant details