PUT
/
invoices
/
{id}
/
payment-status
Header
Path
Body
curl --request PUT \
  --url https://eu.sequencehq.com/api/invoices/{id}/payment-status \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentStatus": "UNPAID"
}'
{
  "billingPeriodEnd": "2022-10-30",
  "billingPeriodStart": "2022-10-01",
  "createdAt": "2022-10-30T00:00:00Z",
  "creditNoteIds": [
    "941272d1-f840-4e16-b698-0cd455c81e0e"
  ],
  "currency": "GBP",
  "customerBillingAddress": {
    "country": "YE",
    "line1": "Flat 1",
    "line2": "15 Yemen Road",
    "postCode": "YE1 2YE",
    "state": "CA",
    "town": "Yemen"
  },
  "customerEmail": "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"
  },
  "dueDate": "2022-11-05",
  "grossTotal": "0",
  "id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
  "invoiceNumber": "INV2",
  "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",
    "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": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "netTotal": "0",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "paymentStatus": "UNPAID",
  "purchaseOrderNumber": "PO123",
  "sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
  "status": "DRAFT",
  "totalTax": "0"
}

Headers

Authorizationrequired
string

Your API credentials. Eg. Basic {credentials}.

Idempotency-Key
string

Specifying a unique ID for this request here lets you retry it without risk of performing the same operation twice.

Path Parameters

idrequired
string

Invoice ID

Body

application/json
paymentStatusrequired
enum<string>
Available options:
UNPAID,
PARTIALLY_PAID,
PAID,
UNCOLLECTIBLE

Response

200 - application/json
billingPeriodEnd
string
billingPeriodStart
string
createdAt
string
creditNoteIdsrequired
string[]
currencyrequired
enum<string>
Available options:
GBP,
EUR,
USD,
CAD,
ZAR,
ARS,
UYU,
COP,
MXN,
AUD
customerBillingAddressrequired
object
customerEmailrequired
string
customerIdrequired
string
customerLegalCompanyNamerequired
string
customerShippingAddressrequired
object
dueDate
string
grossTotalrequired
string
idrequired
string
invoiceNumber
string
linkedServicesrequired
object[]
memo
string
merchantDetails
object
metadatarequired
object[]
netTotalrequired
string
paymentOptions
enum<string>[]
Available options:
BANK_TRANSFER,
LINK
paymentStatusrequired
enum<string>
Available options:
UNPAID,
PARTIALLY_PAID,
PAID,
UNCOLLECTIBLE
purchaseOrderNumber
string
sequenceAccountIdrequired
string
statusrequired
enum<string>
Available options:
DRAFT,
FINAL,
SENT,
VOIDED
totalTaxrequired
string
Void an InvoiceCalculate invoice totals