Skip to main content
POST
Preview an invoice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, see Authentication for more detail.

Body

application/json
previewType
enum<string>
required

Which rendering of the invoice to return

Available options:
INVOICE,
EMAIL,
SMS
Example:

"INVOICE"

lineItems
object[]
required

The invoice's line items

Minimum array length: 1
invoiceNumber
string

The invoice number; auto-derived when omitted

Example:

"HAR-1"

date
string<date>

The invoice date; defaults to today

Example:

"2025-07-26"

term
object

Payment term for the invoice

discount
object

Discount applied to the invoice

deposit
object

Deposit required for the invoice

paymentMethods
enum<string>[]

Payment methods accepted for the invoice

Payment methods accepted for the invoice

Available options:
CREDIT,
ACH,
DIRECT
notes
string

Notes for the invoice

customer
object

The customer being billed

attachments
object[]

Attachments included on the invoice

installments
object[]

Installments for the invoice

dimensionValueIds
string[]

Dimension values assigned to the invoice

Dimension values assigned to the invoice

Response

Success

result
enum<string>

The result of the action performed.

Available options:
SUCCESS,
FAILURE
data
string

The data generated by the action performed.