Skip to main content
PUT
/
invoices
/
{id}
/
payment-status
Update payment status for an invoice
curl --request PUT \
  --url https://dev.seqhq.io/api/invoices/{id}/payment-status \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentStatus": "PAID"
}
'
{
  "id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
  "sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
  "status": "DRAFT",
  "currency": "GBP",
  "invoiceNumber": "INV2",
  "dueDate": "2022-11-05",
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "customerEmails": [
    "customer@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",
    "line2": "",
    "town": "Springfield",
    "state": "CA",
    "postcode": "12345",
    "country": "US"
  },
  "memo": "Thanks",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "billingPeriod": {
    "start": "2022-10-01",
    "endInclusive": "2022-10-30"
  },
  "customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
  "totalTax": "2",
  "netTotal": "12",
  "grossTotal": "10",
  "metadata": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "paymentStatus": "UNPAID",
  "createdAt": "2022-10-30T00:00:00Z",
  "creditNoteIds": [
    "941272d1-f840-4e16-b698-0cd455c81e0e"
  ],
  "linkedServices": [
    {
      "externalId": "ID",
      "externalService": "Xero",
      "syncTime": "2022-06-28T16:47:00Z"
    }
  ],
  "merchantDetails": {
    "address": {
      "line1": "Flat 1",
      "line2": "123 Fake Street",
      "town": "New York",
      "state": "NY",
      "postcode": "AB1 2EF",
      "country": "US"
    },
    "phoneNumber": "0800001066",
    "email": "donald@example.com",
    "taxId": "TAX",
    "iban": "GB33BUKB20201555555555",
    "ukAccountDetails": {
      "sortCode": "123456",
      "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"
      }
    },
    "swedishBankgiroDestination": {
      "bankgiroNumber": "123-4567",
      "accountName": "The Merchant"
    },
    "legalCompanyName": "The Merchant",
    "customFields": [],
    "includeBeneficiaryAddressInPaymentDetails": false
  },
  "accountingDate": "2022-10-05",
  "customerTaxStatus": "TAXED",
  "renderSettings": {
    "paymentLinkDisplay": "HIDE_PAYMENT_LINK"
  },
  "isCustomerArchived": false,
  "updatedAt": "2022-10-30T00:00:00Z"
}

Headers

​
Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

​
Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

​
id
string
required

Invoice ID

Body

application/json
​
paymentStatus
enum<string>
required

Invoice payment status

Available options:
UNPAID,
PARTIALLY_PAID,
PAID,
UNCOLLECTIBLE
Example:

"UNPAID"

Response

OK

​
id
string
required

Invoice ID

Example:

"ba37a392-7054-4dae-ab37-6fee9e23fe06"

​
sequenceAccountId
string
required

Sequence Account ID

Example:

"af9b5988-1d7b-45f6-a188-326df5e59b24"

​
status
enum<string>
required

Invoice status

Available options:
IN_PROGRESS,
DRAFT,
FINAL,
SENT,
VOIDED
Example:

"DRAFT"

​
currency
enum<string>
required

Invoice currency

Available options:
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
Example:

"GBP"

​
customerEmails
string[]
required

Customer email addresses, used for sending the Invoice if provided

Example:
["customer@example.com"]
​
customerLegalCompanyName
string
required

Customer's legal company name

Example:

"Facebook"

​
customerBillingAddress
object
required

Customer's billing address

Example:
{
  "line1": "Flat 1",
  "line2": "15 Yemen Road",
  "town": "Yemen",
  "state": "CA",
  "postcode": "YE1 2YE",
  "country": "YE"
}
​
customerShippingAddress
object
required

Customer's billing address

Example:
{
  "line1": "Flat 1",
  "line2": "15 Yemen Road",
  "town": "Yemen",
  "state": "CA",
  "postcode": "YE1 2YE",
  "country": "YE"
}
​
customerId
string
required

The ID of the Customer this invoice is linked to

Example:

"b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a"

​
totalTax
string
required

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

Example:

"2"

​
netTotal
string
required

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

Example:

"12"

​
grossTotal
string
required

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

Example:

"10"

​
metadata
object[]
required

Mapping of key-value pairs to attach to the Invoice. These are not interpreted by Sequence; they are present for your use alone.

Example:
[
  {
    "key": "example-label",
    "value": "label-value"
  }
]
​
paymentStatus
enum<string>
required

Invoice payment status

Available options:
UNPAID,
PARTIALLY_PAID,
PAID,
UNCOLLECTIBLE
Example:

"UNPAID"

​
createdAt
string
required

Creation time

Example:

"2022-10-30T00:00:00Z"

​
creditNoteIds
string[]
required

IDs of linked credit notes (if any)

Example:
["941272d1-f840-4e16-b698-0cd455c81e0e"]
​
linkedServices
object[]
required

External services which are linked to this invoice

Example:
[
  {
    "externalId": "ID",
    "externalService": "Xero",
    "syncTime": "2022-06-28T16:47:00Z"
  }
]
​
accountingDate
string<date>
required

Accounting date

Example:

"2022-10-05"

​
renderSettings
object
required

Settings that control how the invoice is rendered.

Example:
{ "paymentLinkDisplay": "HIDE_PAYMENT_LINK" }
​
isCustomerArchived
boolean
required
Example:

false

​
updatedAt
string
required

Last updated time

Example:

"2022-10-30T00:00:00Z"

​
invoiceNumber
string

Invoice number

Example:

"INV2"

​
dueDate
string<date>

Due date

Example:

"2022-11-05"

​
purchaseOrderNumber
string

Purchase order number

Example:

"PO123"

​
reference
string

Reference

Example:

"ref"

​
memo
string

Invoice memo

Example:

"Thanks"

​
paymentOptions
enum<string>[]

Invoice payment options

Available options:
BANK_TRANSFER,
LINK
Example:
["BANK_TRANSFER"]
​
billingPeriod
object

Billing period

Example:
{
  "start": "2022-10-01",
  "endInclusive": "2022-10-30"
}
​
merchantDetails
object

Merchant details

Example:
{
  "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"
  },
  "swedishBankgiroDestination": {
    "bankgiroNumber": "123-4567",
    "accountName": "The Merchant"
  },
  "logoUrl": "logo",
  "legalCompanyName": "The Merchant",
  "primaryColour": "#000000",
  "customFields": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "includeBeneficiaryAddressInPaymentDetails": false
}
​
customerTaxStatus
enum<string>

Customer tax status

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED
Example:

"TAXED"