v1

latestOpenAPI 3.0.02026-07-261733191.1 MB

Credit Notes

Mark credit note as sent without triggering actions except revenue recognition

Finalizes a credit note (if not already finalized) and sets its status to SENT. Emails or notifications are not sent. Integration syncs do not happen. Journal entries are created for the credit note.

post/credit-notes/{id}/mark-as-sent

Path parameters

idstring required

Credit Note Id

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Response

idstring required

Credit Note ID

sequenceAccountIdstring required

Sequence Account ID

status'DRAFT' | 'FINAL' | 'IN_PROGRESS' | 'SENT' | 'VOIDED' required

invoiceIdstring

Invoice ID

invoiceNumberstring

Invoice Number

billingScheduleIdstring

Subscription ID

currency'AED' | 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'USD' | 'UYU' | 'ZAR' required

issueDatestring

Issue date

billingPeriodStartstring

Billing period start

billingPeriodEndstring

Billing period end

creditNoteNumberstring

Credit Note number

purchaseOrderNumberstring

Purchase order number

customerIdstring required

The ID of the Customer this Credit Note is linked to

customerEmailsstring[] required

Customer's email addresses, used for sending the Credit Note if provided

customerLegalCompanyNamestring required

Customer's legal company name

memostring

Credit Note memo

totalTaxstring required

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

netTotalstring required

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

grossTotalstring required

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

customerTaxIdstring

Customer's tax ID

applicationStatus'UNAPPLIED' | 'PARTIALLY_APPLIED' | 'FULLY_APPLIED' | 'UNKNOWN'

accountingDatestring

Accounting date

Example response

{
  "id": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
  "status": "SENT",
  "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",
    "customer.alias@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",
      "externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
    }
  ],
  "applicationStatus": "UNAPPLIED",
  "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",
    "iban": "GB33BUKB20201555555555",
    "ukAccountDetails": {
      "sortCode": "000000",
      "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"
      }
    },
    "caBankAccountDetails": {
      "transitNumber": "123",
      "institutionNumber": "12345",
      "accountNumber": "1234567"
    },
    "canadianInternationalDestination": {
      "legalName": "John Doe",
      "accountNumber": "12345678",
      "transitNumber": "12345",
      "bankName": "Chase",
      "bankAddress": {
        "line1": "JP Morgan Chase",
        "town": "New York City",
        "state": "NY",
        "postcode": "10017",
        "country": "US"
      },
      "institutionNumber": "123",
      "swiftCode": "CHASUS33",
      "intermediaryBank": {
        "bankName": "Chase",
        "bankAddress": {
          "line1": "JP Morgan Chase",
          "town": "New York City",
          "state": "NY",
          "postcode": "10017",
          "country": "US"
        },
        "swiftCode": "CHASUS33",
        "routingNumber": "123456789"
      }
    },
    "australianDestination": {
      "legalName": "John Doe",
      "accountNumber": "12345678",
      "swiftCode": "CHASUS33",
      "bsb": "123456"
    },
    "swedishBankgiroDestination": {
      "bankgiroNumber": "123-4567",
      "accountName": "12345678"
    },
    "logoUrl": "logo",
    "legalCompanyName": "The Merchant",
    "primaryColour": "#000000",
    "customFields": [
      {
        "key": "example-label",
        "value": "label-value"
      }
    ],
    "includeBeneficiaryAddressInPaymentDetails": true
  },
  "settings": {
    "generateCashCreditGrant": "ENABLED"
  },
  "accountingDate": "2022-09-30"
}