Sign in
Credit Notes

Void a Credit Note

Void a Credit Note

post/credit-notes/{id}/void

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

OK

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'
balancestring

Credit still available to apply, in decimal format of the Credit Note's currency. Omitted for credit notes with no ledger balance

balanceVersioninteger

Ledger version of the balance. Advances each time the balance changes; required when applying this Credit Note to an Invoice. Omitted for credit notes with no ledger balance

accountingDatestring

Accounting date

Example response

{
  "id": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
  "status": "FINAL",
  "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": "PARTIALLY_APPLIED",
  "balance": "51.23",
  "balanceVersion": 3,
  "applications": [
    {
      "invoiceId": "af60cab3-812d-4250-a051-0fb7133a00c7",
      "invoiceNumber": "INV00001",
      "amount": "50.00",
      "appliedAt": "2022-10-14T12:34:56Z"
    }
  ],
  "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"
}

Changes

Changed in 304 of the 714 revisions of this API.448627852

  • e520d2f95b7b17See the full diff
    • ▲

      the merchantDetails/customFields/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      added the optional property merchantDetails/australianDestination to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/caBankAccountDetails to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/canadianInternationalDestination to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/logoUrl to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/primaryColour to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property merchantDetails/customFields/items/key to the response with the 200 status

      response-required-property-added

    • ○

      added the required property merchantDetails/customFields/items/value to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d8d9b2c4fc1a351See the full diff
    • ▲

      the merchantDetails/customFields/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property merchantDetails/customFields/items/key from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property merchantDetails/customFields/items/value from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property merchantDetails/australianDestination from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/caBankAccountDetails from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/canadianInternationalDestination from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/logoUrl from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/primaryColour from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property merchantDetails/swedishBankgiroDestination to the response with the 200 status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 05cc0975497f117See the full diff
    • ▲

      the merchantDetails/customFields/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ●

      removed the optional property merchantDetails/swedishBankgiroDestination from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property merchantDetails/australianDestination to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/caBankAccountDetails to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/canadianInternationalDestination to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/logoUrl to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/primaryColour to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property merchantDetails/customFields/items/key to the response with the 200 status

      response-required-property-added

    • ○

      added the required property merchantDetails/customFields/items/value to the response with the 200 status

      response-required-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 97dc5c9c999635See the full diff
    • ▲

      the merchantDetails/customFields/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property merchantDetails/customFields/items/key from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property merchantDetails/customFields/items/value from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property merchantDetails/australianDestination from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/caBankAccountDetails from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/canadianInternationalDestination from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/logoUrl from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/primaryColour from the response with the 200 status

      response-optional-property-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 752919058af01See the full diff
    • ○

      added the optional property merchantDetails/swedishBankgiroDestination to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3cc58836dcea1See the full diff
    • ●

      removed the optional property merchantDetails/swedishBankgiroDestination from the response with the 200 status

      response-optional-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 750388fba85617See the full diff
    • ▲

      the merchantDetails/customFields/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      added the optional property merchantDetails/australianDestination to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/caBankAccountDetails to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/canadianInternationalDestination to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/logoUrl to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property merchantDetails/primaryColour to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property merchantDetails/customFields/items/key to the response with the 200 status

      response-required-property-added

    • ○

      added the required property merchantDetails/customFields/items/value to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7b5a09b43263351See the full diff
    • ▲

      the merchantDetails/customFields/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property merchantDetails/customFields/items/key from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property merchantDetails/customFields/items/value from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property merchantDetails/australianDestination from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/caBankAccountDetails from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/canadianInternationalDestination from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/logoUrl from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property merchantDetails/primaryColour from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property merchantDetails/swedishBankgiroDestination to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f43a20068f931See the full diff
    • ●

      removed the optional property merchantDetails/swedishBankgiroDestination from the response with the 200 status

      response-optional-property-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c226646741b51See the full diff
    • ○

      added the optional property merchantDetails/swedishBankgiroDestination to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog