POST
/
credit-notes
/
{id}
/
finalize-and-send
curl --request POST \
  --url https://eu.sequencehq.com/api/credit-notes/{id}/finalize-and-send \
  --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"
  },
  "customerEmails": [
    "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",
    "includeBeneficiaryAddressInPaymentDetails": false,
    "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

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
billingPeriodEnd
string

Billing period end

billingPeriodStart
string

Billing period start

creditNoteNumber
string

Credit Note number

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

customerId
string
required

The ID of the Customer this Credit Note is linked to

customerLegalCompanyName
string
required

Customer's legal company name

customerShippingAddress
object
required
grossTotal
string
required

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

id
string
required

Credit Note ID

invoiceId
string

Invoice ID

invoiceNumber
string

Invoice Number

issueDate
string

Issue date

linkedServices
object[]
required

External services which are linked to this credit note

memo
string

Credit Note memo

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

netTotal
string
required

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

purchaseOrderNumber
string

Purchase order number

sequenceAccountId
string
required

Sequence Account ID

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

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