invoices
Create invoice
post/api/v1/documents/contracts/invoices
Headers
x-api-keystring nullable
Request body
currency'USD' | 'EUR' | 'GBP' | 'JPY' | 'CHF' | 'CAD' | 'AUD' | 'NZD' | 'SEK' | 'NOK' | 'AED' | 'HKD'
Supported invoice/contract currencies. G10 majors + AED/HKD.
commentstring nullable
emailMessagestring nullable
invoicePrefixstring
Prefix for auto-generated invoice_number, e.g. "INV" → "INV-0001".
issuedDatestring date nullable
dueDatestring date nullable
itemsobject[]
documentIdsstring[] nullable
contractorEmailstring required
contractorDisplayNamestring required
clientEmailstring required
clientDisplayNamestring required
banksstring[] nullable
onchainboolean
Response
Successful Response
idstring uuid required
onchainTransactionIdstring nullable
amountstring required
discountstring nullable
currency'USD' | 'EUR' | 'GBP' | 'JPY' | 'CHF' | 'CAD' | 'AUD' | 'NZD' | 'SEK' | 'NOK' | 'AED' | 'HKD' required
Supported invoice/contract currencies. G10 majors + AED/HKD.
commentstring nullable
emailMessagestring nullable
invoiceNumberstring nullable
periodNumberinteger nullable
issuedDatestring date nullable
dueDatestring date nullable
itemsobject[]
status'draft' | 'sent' | 'paid' | 'cancelled' | 'client_paid' | 'client_declined' required
Invoice status.
invoiceLinkstring nullable
paidAtstring date-time nullable
createdAtstring date-time required
updatedAtstring date-time required