Skip to main content
POST
Create an Invoice

Authorizations

Authorization
string
header
required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Body

application/json
discount
object
required

Global discount, after applying the line item discounts

invoiceDate
string<date-time>
required

The date of the invoice

dueDate
string<date-time>
required

The date of the due date

lineItems
object[]
required

The line items of the invoice

note
string
required

The notes of the invoice

counterParty
string
required

The id of the counterparty. Expected to be a valid object id like 666666666666666666666666

Pattern: ^[0-9A-Fa-f]{24}$
invoiceId
required

The id of the invoice or 'INCREMENTAL' to auto generate the invoice id

currency
string
required

The currency of the invoice.

purchaseOrderId
string | null

The id of the purchase order

payViaStripeAccountConnectionId
string | null

The id of the pay via stripe account connection. Expected to be a valid object id like 666666666666666666666666

Pattern: ^[0-9A-Fa-f]{24}$

Response

Create an Invoice executed successfully

message
string

Success message

metaData
object
data
object