Sign in
Invoices

Patch a sent invoice

Patch fields on a SENT invoice. Supports updating the purchase order number, customer billing address, memo, reference, and due date. Setting a due date records it as manually chosen and clears the invoice's stored payment terms, so it will not be recomputed from them later. The due date can be moved but not cleared: sending an explicit null for it is rejected.

patch/invoices/{id}/sent

Path parameters

idstring required

Invoice ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

purchaseOrderNumberstring
dueDatestring

Example request

{
  "purchaseOrderNumber": "PO-12345",
  "dueDate": "2026-09-29"
}

Response

OK

idstring required

Invoice ID

sequenceAccountIdstring required

Sequence Account ID

billingScheduleIdstring

Billing Schedule ID

status'IN_PROGRESS' | 'DRAFT' | 'FINAL' | 'SENT' | 'VOIDED' required
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
invoiceNumberstring

Invoice number

issueDatestring

Issue date

dueDatestring

Due date

purchaseOrderNumberstring

Purchase order number

referencestring

Reference

customerEmailsstring[] required

Customer email addresses, used for sending the Invoice if provided

customerLegalCompanyNamestring required

Customer's legal company name

memostring

Invoice memo

paymentOptionsInvoicePaymentOption[]

Invoice payment options

customerIdstring required

The ID of the Customer this invoice is linked to

totalTaxstring required

Total tax, in decimal format of the Invoice's currency

netTotalstring required

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

grossTotalstring required

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

customerTaxIdstring

Customer's tax ID

paymentStatus'UNPAID' | 'PARTIALLY_PAID' | 'PAID' | 'UNCOLLECTIBLE' required
createdAtstring required

Creation time

creditNoteIdsstring[] required

IDs of linked credit notes (if any)

creditBalancesstring

Credit balances

dunningStatus'SCHEDULED' | 'OVERDUE_CHECK_SCHEDULED' | 'COMPLETED' | 'FAILED' | 'NOT_REQUIRED'
accountingDatestring required

Accounting date

calculatedAtstring

Time this invoice was last calculated (applicable for invoices generated by billing engine only)

customerTaxStatus'TAXED' | 'TAX_EXEMPT' | 'REVERSE_CHARGED'
isCustomerArchivedboolean required
updatedAtstring required

Last updated time

Example response

{
  "id": "6cedbb5e-4f77-4217-b8d4-020e7e4d33c9",
  "sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
  "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "status": "DRAFT",
  "currency": "GBP",
  "invoiceNumber": "INV00001",
  "issueDate": "2022-09-15",
  "dueDate": "2022-09-30",
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "customerEmails": [
    "customer.user.a@example.com",
    "customer.user.b@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",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "billingPeriod": {
    "start": "2022-10-01",
    "endInclusive": "2022-10-30"
  },
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "totalTax": "2.50",
  "netTotal": "51.20",
  "grossTotal": "101.23",
  "metadata": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "customerTaxId": "TAX123",
  "paymentStatus": "UNPAID",
  "createdAt": "2022-10-30T00:00:00Z",
  "creditNoteIds": [
    "af60cab3-812d-4250-a051-0fb7133a00c7"
  ],
  "linkedServices": [
    {
      "externalId": "123",
      "externalService": "Xero",
      "syncTime": "2022-06-28T16:47:00Z",
      "externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
    }
  ],
  "merchantDetails": {
    "address": {
      "line1": "The White House",
      "line2": "1600 Pennsylvania Avenue",
      "town": "Washington, D.C.",
      "state": "CA",
      "postcode": "20500",
      "country": "US"
    },
    "phoneNumber": "0800001066",
    "email": "finance@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"
    },
    "logoUrl": "logo",
    "legalCompanyName": "The Merchant",
    "primaryColour": "#000000",
    "customFields": [
      {
        "key": "example-label",
        "value": "label-value"
      }
    ],
    "includeBeneficiaryAddressInPaymentDetails": false
  },
  "creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
  "dunningStatus": "SCHEDULED",
  "accountingDate": "2022-09-30",
  "calculatedAt": "2022-09-30T00:00:00Z",
  "customerTaxStatus": "TAXED",
  "renderSettings": {
    "paymentLinkDisplay": "HIDE_PAYMENT_LINK"
  },
  "isCustomerArchived": false,
  "updatedAt": "2022-09-30T00:00:00Z"
}

Changes