Get an Invoice by ID

id

string

required

Invoice ID

sequenceAccountId

string

required

Sequence Account ID

status

enum<string>

required

Invoice status

Available options:

IN_PROGRESS,

DRAFT,

FINAL,

SENT,

VOIDED

currency

enum<string>

required

Invoice currency

Available options:

ARS,

AUD,

BRL,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

customerEmails

string[]

required

Customer email addresses, used for sending the Invoice if provided

customerLegalCompanyName

string

required

Customer's legal company name

customerBillingAddress

object

required

Customer's billing address

customerShippingAddress

object

required

Customer's billing address

customerId

string

required

The ID of the Customer this invoice is linked to

totalTax

string

required

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

netTotal

string

required

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

grossTotal

string

required

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

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.

paymentStatus

enum<string>

required

Invoice payment status

Available options:

UNPAID,

PARTIALLY_PAID,

PAID,

UNCOLLECTIBLE

createdAt

string

required

Creation time

creditNoteIds

string[]

required

IDs of linked credit notes (if any)

linkedServices

object[]

required

External services which are linked to this invoice

accountingDate

string

required

Accounting date

renderSettings

object

required

Settings that control how the invoice is rendered.

isCustomerArchived

boolean

required

isCustomerArchived

billingScheduleId

string

Billing Schedule ID

invoiceNumber

string

Invoice number

issueDate

string

Issue date

dueDate

string

Due date

purchaseOrderNumber

string

Purchase order number

reference

string

Reference

memo

string

Invoice memo

paymentOptions

enum<string>[]

Invoice payment options

Available options:

BANK_TRANSFER,

LINK

billingPeriod

object

Billing period

customerTaxId

string

Customer's tax ID

merchantDetails

object

Merchant details

merchantDetails.address

object

required

Customer's billing address

merchantDetails.email

string

required

Merchant's email

merchantDetails.legalCompanyName

string

required

Merchant's legal company name

merchantDetails.customFields

object[]

required

merchantCustomFields

merchantDetails.includeBeneficiaryAddressInPaymentDetails

boolean

required

Include beneficiary address in payment details on invoice

merchantDetails.phoneNumber

string

Merchant's phone number

merchantDetails.taxId

string

Merchant's tax ID

merchantDetails.iban

string

Merchant's IBAN, for receiving payment by bank transfer

merchantDetails.ukAccountDetails

object

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

merchantDetails.usAchDetails

object

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

merchantDetails.usWireDetails

object

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

merchantDetails.usWireDetails.accountNumber

string

required

merchantDetails.usWireDetails.accountName

string

required

merchantDetails.usWireDetails.bankName

string

required

merchantDetails.usWireDetails.bankRoutingNumber

string

required

merchantDetails.usWireDetails.swiftCode

string

required

merchantDetails.usWireDetails.bankAddress

object

required

Customer's billing address

merchantDetails.caBankAccountDetails

object

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

merchantDetails.canadianInternationalDestination

object

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

merchantDetails.canadianInternationalDestination.legalName

string

required

merchantDetails.canadianInternationalDestination.accountNumber

string

required

merchantDetails.canadianInternationalDestination.transitNumber

string

required

merchantDetails.canadianInternationalDestination.bankName

string

required

merchantDetails.canadianInternationalDestination.bankAddress

object

required

Customer's billing address

merchantDetails.canadianInternationalDestination.institutionNumber

string

required

merchantDetails.canadianInternationalDestination.swiftCode

string

required

merchantDetails.canadianInternationalDestination.intermediaryBank

object

merchantDetails.canadianInternationalDestination.intermediaryBank.bankName

string

required

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress

object

required

Customer's billing address

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.line1

string

required

Address line 1

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.town

string

required

Town or city

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.postcode

string

required

Postal code

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

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.line2

string

Address line 2

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

merchantDetails.canadianInternationalDestination.intermediaryBank.swiftCode

string

required

merchantDetails.canadianInternationalDestination.intermediaryBank.routingNumber

string

required

merchantDetails.australianDestination

object

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

merchantDetails.logoUrl

string

Merchant's logo image URL

merchantDetails.primaryColour

string

Merchant's primary colour (for invoice rendering)

creditBalances

string

Credit balances

dunningStatus

enum<string>

Dunning status

Available options:

SCHEDULED,

OVERDUE_CHECK_SCHEDULED,

COMPLETED,

FAILED,

NOT_REQUIRED

calculatedAt

string

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

customerTaxStatus

enum<string>

Customer tax status

Available options:

TAXED,

TAX_EXEMPT,

REVERSE_CHARGED

API Reference

Latest Live API

Version 2024-07-30

Get an Invoice by ID

Headers

Path Parameters

Response