Update payment status for an invoice

PUT

invoices

{id}

payment-status

curl --request PUT \
  --url https://eu.sequencehq.com/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"
      }
    },
    "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

string

required

Invoice ID

Body

application/json

paymentStatus

enum<string>

required

Invoice payment status

Available options:

UNPAID,

PARTIALLY_PAID,

PAID,

UNCOLLECTIBLE

Example:

"UNPAID"

Response

200

application/json

string

required

Invoice ID

Example:

"6cedbb5e-4f77-4217-b8d4-020e7e4d33c9"

sequenceAccountId

string

required

Sequence Account ID

Example:

"68233908-402a-43b4-8952-1c2ab0ef0b25"

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,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

customerEmails

string[]

required

Customer email addresses, used for sending the Invoice if provided

Example:

[
  "customer.user.a@example.com",
  "customer.user.b@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:

"61b083e0-1faa-47ca-9aeb-6205da8f6c47"

totalTax

string

required

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

Example:

"2.50"

netTotal

string

required

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

Example:

"51.20"

grossTotal

string

required

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

Example:

"101.23"

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:

["af60cab3-812d-4250-a051-0fb7133a00c7"]

linkedServices

object[]

required

External services which are linked to this invoice

Example:

[
  {
    "externalId": "123",
    "externalService": "Xero",
    "syncTime": "2022-06-28T16:47:00Z",
    "externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
  }
]

accountingDate

string

required

Accounting date

Example:

"2022-09-30"

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-09-30T00:00:00Z"

billingScheduleId

string

Billing Schedule ID

Example:

"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"

invoiceNumber

string

Invoice number

Example:

"INV00001"

issueDate

string

Issue date

Example:

"2022-09-15"

dueDate

string

Due date

Example:

"2022-09-30"

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"
}

customerTaxId

string

Customer's tax ID

Example:

"TAX123"

merchantDetails

object

Merchant details

merchantDetails.address

object

required

Customer's billing address

Example:

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

merchantDetails.email

string

required

Merchant's email

Example:

"finance@example.com"

merchantDetails.legalCompanyName

string

required

Merchant's legal company name

Example:

"The Merchant"

merchantDetails.customFields

object[]

required

merchantCustomFields

Example:

[
  {
    "key": "example-label",
    "value": "label-value"
  }
]

merchantDetails.includeBeneficiaryAddressInPaymentDetails

boolean

required

Include beneficiary address in payment details on invoice

Example:

false

merchantDetails.phoneNumber

string

Merchant's phone number

Example:

"0800001066"

merchantDetails.taxId

string

Merchant's tax ID

Example:

"TAX60"

merchantDetails.iban

string

Merchant's IBAN, for receiving payment by bank transfer

Example:

"GB33BUKB20201555555555"

merchantDetails.ukAccountDetails

object

Merchant's UK bank account details, for receiving payment by UK bank transfer

Example:

{
  "sortCode": "000000",
  "accountNumber": "12345678"
}

merchantDetails.usAchDetails

object

Merchant's US account details, for receiving payment by ACH

Example:

{
  "accountNumber": "12345678",
  "accountName": "John Doe",
  "bankName": "Chase",
  "bankRoutingNumber": "123456789"
}

merchantDetails.usWireDetails

object

Merchant's US account details, for receiving payment by wire transfer

merchantDetails.usWireDetails.accountNumber

string

required

Example:

"12345678"

merchantDetails.usWireDetails.accountName

string

required

Example:

"John Doe"

merchantDetails.usWireDetails.bankName

string

required

Example:

"Chase"

merchantDetails.usWireDetails.bankRoutingNumber

string

required

Example:

"123456789"

merchantDetails.usWireDetails.swiftCode

string

required

Example:

"CHASUS33"

merchantDetails.usWireDetails.bankAddress

object

required

Customer's billing address

Example:

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

Example:

{
  "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"
  }
}

merchantDetails.caBankAccountDetails

object

Merchant's Canadian account details, for receiving payment by Canadian bank transfer

Example:

{
  "transitNumber": "123",
  "institutionNumber": "12345",
  "accountNumber": "1234567"
}

merchantDetails.canadianInternationalDestination

object

Merchant's account details, for receiving payment to a Canadian bank via Wire transfer

merchantDetails.canadianInternationalDestination.legalName

string

required

Example:

"John Doe"

merchantDetails.canadianInternationalDestination.accountNumber

string

required

Example:

"12345678"

merchantDetails.canadianInternationalDestination.transitNumber

string

required

Example:

"12345"

merchantDetails.canadianInternationalDestination.bankName

string

required

Example:

"Chase"

merchantDetails.canadianInternationalDestination.bankAddress

object

required

Customer's billing address

Example:

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

merchantDetails.canadianInternationalDestination.institutionNumber

string

required

Example:

"123"

merchantDetails.canadianInternationalDestination.swiftCode

string

required

Example:

"CHASUS33"

merchantDetails.canadianInternationalDestination.intermediaryBank

object

merchantDetails.canadianInternationalDestination.intermediaryBank.bankName

string

required

Example:

"Chase"

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress

object

required

Customer's billing address

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.line1

string

required

Address line 1

Example:

"Flat 1"

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.town

string

required

Town or city

Example:

"Yemen"

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.postcode

string

required

Postal code

Example:

"YE1 2YE"

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.country

enum<string>

required

Country code (ISO 3166-1 alpha-2)

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

Example:

"YE"

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.line2

string

Address line 2

Example:

"15 Yemen Road"

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.state

enum<string>

State (required for USA only)

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DC,

DE,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AB,

BC,

MB,

NB,

NL,

NS,

NT,

NU,

ON,

PE,

QC,

SK,

YT

Example:

"CA"

Example:

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

merchantDetails.canadianInternationalDestination.intermediaryBank.swiftCode

string

required

Example:

"CHASUS33"

merchantDetails.canadianInternationalDestination.intermediaryBank.routingNumber

string

required

Example:

"123456789"

Example:

{
  "bankName": "Chase",
  "bankAddress": {
    "line1": "JP Morgan Chase",
    "town": "New York City",
    "state": "NY",
    "postcode": "10017",
    "country": "US"
  },
  "swiftCode": "CHASUS33",
  "routingNumber": "123456789"
}

Example:

{
  "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"
  }
}

merchantDetails.australianDestination

object

Merchant's account details, for receiving payment to a Canadian bank via Australian bank transfer

Example:

{
  "legalName": "John Doe",
  "accountNumber": "12345678",
  "swiftCode": "CHASUS33",
  "bsb": "123456"
}

merchantDetails.logoUrl

string

Merchant's logo image URL

Example:

"logo"

merchantDetails.primaryColour

string

Merchant's primary colour (for invoice rendering)

Example:

"#000000"

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"
  },
  "logoUrl": "logo",
  "legalCompanyName": "The Merchant",
  "primaryColour": "#000000",
  "customFields": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "includeBeneficiaryAddressInPaymentDetails": false
}

creditBalances

string

Credit balances

Example:

"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)"

dunningStatus

enum<string>

Dunning status

Available options:

SCHEDULED,

OVERDUE_CHECK_SCHEDULED,

COMPLETED,

FAILED,

NOT_REQUIRED

Example:

"SCHEDULED"

calculatedAt

string

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

Example:

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

customerTaxStatus

enum<string>

Customer tax status

Available options:

TAXED,

TAX_EXEMPT,

REVERSE_CHARGED

Example:

"TAXED"

Send a payment reminder for an invoice Void an Invoice

curl --request PUT \
  --url https://eu.sequencehq.com/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"
      }
    },
    "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"
}

API Reference

Latest Live API

Version 2024-07-30

Update payment status for an invoice

Headers

Path Parameters

Body

Response