Create an invoice

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

Body

application/json

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

customerId

string

required

The ID of the Customer this invoice is linked to

accountingDate

string

Accounting date

billingPeriod

object

Billing period

billingRunId

string

Billing Run ID

billingScheduleId

string

Billing Schedule ID

creditBalances

string

Credit balances

customerBillingAddress

object

Customer's billing address

customerEmails

string[]

Customer email addresses, used for sending the Invoice if provided

customerLegalCompanyName

string

Customer's legal company name

customerShippingAddress

object

Customer's billing address

dueDate

string

Due date

memo

string

Invoice memo

metadata

object[]

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

paymentOptions

enum<string>[]

Invoice payment options

Available options:

BANK_TRANSFER,

LINK

purchaseOrderNumber

string

Purchase order number

reference

string

Reference

Response

201 - application/json

accountingDate

string

required

Accounting date

createdAt

string

required

Creation time

creditNoteIds

string[]

required

IDs of linked credit notes (if any)

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

customerBillingAddress

object

required

Customer's billing address

customerEmails

string[]

required

Customer email addresses, used for sending the Invoice if provided

customerId

string

required

The ID of the Customer this invoice is linked to

customerLegalCompanyName

string

required

Customer's legal company name

customerShippingAddress

object

required

Customer's billing address

grossTotal

string

required

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

string

required

Invoice ID

isCustomerArchived

boolean

required

linkedServices

object[]

required

External services which are linked to this invoice

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.

netTotal

string

required

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

paymentStatus

enum<string>

required

Invoice payment status

Available options:

UNPAID,

PARTIALLY_PAID,

PAID,

UNCOLLECTIBLE

renderSettings

object

required

Settings that control how the invoice is rendered.

sequenceAccountId

string

required

Sequence Account ID

status

enum<string>

required

Invoice status

Available options:

IN_PROGRESS,

DRAFT,

FINAL,

SENT,

VOIDED

totalTax

string

required

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

billingPeriod

object

Billing period

billingScheduleId

string

Billing Schedule ID

calculatedAt

string

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

creditBalances

string

Credit balances

customerTaxId

string

Customer's tax ID

customerTaxStatus

enum<string>

Customer tax status

Available options:

TAXED,

TAX_EXEMPT,

REVERSE_CHARGED

dueDate

string

Due date

dunningStatus

enum<string>

Dunning status

Available options:

SCHEDULED,

OVERDUE_CHECK_SCHEDULED,

COMPLETED,

FAILED,

NOT_REQUIRED

invoiceNumber

string

Invoice number

issueDate

string

Issue date

memo

string

Invoice memo

merchantDetails

object

Merchant details

merchantDetails.address

object

required

Customer's billing address

merchantDetails.customFields

object[]

required

merchantCustomFields

merchantDetails.email

string

required

Merchant's email

merchantDetails.includeBeneficiaryAddressInPaymentDetails

boolean

required

Include beneficiary address in payment details on invoice

merchantDetails.legalCompanyName

string

required

Merchant's legal company name

merchantDetails.australianDestination

object

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

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.accountNumber

string

required

merchantDetails.canadianInternationalDestination.bankAddress

object

required

Customer's billing address

merchantDetails.canadianInternationalDestination.bankName

string

required

merchantDetails.canadianInternationalDestination.institutionNumber

string

required

merchantDetails.canadianInternationalDestination.legalName

string

required

merchantDetails.canadianInternationalDestination.swiftCode

string

required

merchantDetails.canadianInternationalDestination.transitNumber

string

required

merchantDetails.canadianInternationalDestination.intermediaryBank

object

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress

object

required

Customer's billing address

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.line1

string

required

Address line 1

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.postcode

string

required

Postal code

merchantDetails.canadianInternationalDestination.intermediaryBank.bankAddress.town

string

required

Town or city

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.bankName

string

required

merchantDetails.canadianInternationalDestination.intermediaryBank.routingNumber

string

required

merchantDetails.canadianInternationalDestination.intermediaryBank.swiftCode

string

required

merchantDetails.iban

string

Merchant's IBAN, for receiving payment by bank transfer

merchantDetails.logoUrl

string

Merchant's logo image URL

merchantDetails.phoneNumber

string

Merchant's phone number

merchantDetails.primaryColour

string

Merchant's primary colour (for invoice rendering)

merchantDetails.taxId

string

Merchant's tax ID

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.accountName

string

required

merchantDetails.usWireDetails.accountNumber

string

required

merchantDetails.usWireDetails.bankAddress

object

required

Customer's billing address

merchantDetails.usWireDetails.bankName

string

required

merchantDetails.usWireDetails.bankRoutingNumber

string

required

merchantDetails.usWireDetails.swiftCode

string

required

paymentOptions

enum<string>[]

Invoice payment options

Available options:

BANK_TRANSFER,

LINK

purchaseOrderNumber

string

Purchase order number

reference

string

Reference

API Reference

Latest Live API

Version 2024-07-30

Create an invoice

Headers

Body

Response