Create an invoice

post

https://{hostname}/api/v1/invoice

Creates an invoice addressed to exactly one of recipientContact or
recipientBusiness. Send application/json, or multipart/form-data
with a JSON data field plus one or more files (PDF or image, max
25 MB each) to attach documents. Sending the same externalId again
later updates the invoice instead of creating a duplicate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The fields used to create or update an invoice. Exactly one of recipientContact or recipientBusiness is required.

externalId

string

The invoice's identifier in your system. Send it again on a later request to update the same record.

merchant

object

required

The merchant billing the invoice.

recipientContact

object

The contact the invoice is addressed to. Mutually exclusive with recipientBusiness.

recipientBusiness

object

The business the invoice is addressed to. Mutually exclusive with recipientContact.

type

string

enum

The document type.

Allowed:

referenceNumber

string

required

Your human-readable reference for the invoice.

invoiceName

string

An optional display name for the invoice.

issueDate

date-time

required

The date the invoice was issued (ISO 8601).

dueDate

date-time | null

The date payment is due (ISO 8601). Null for open-ended requests.

totalAmount

number

required

≥ 0

The total amount due, in the invoice's currency.

amountPaid

number

≥ 0

The amount already paid.

status

string

enum

The invoice's current status.

Allowed:

isPartial

boolean

Whether the invoice has been partially paid.

requiresSignature

boolean

Whether the invoice requires a signature before payment.

paymentLink

uri

A hosted link where the recipient can pay the invoice.

note

string

An optional note shown with the invoice.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Invoice created.

400The request was malformed or failed validation.

401The credential is missing, invalid, expired, or not permitted on this endpoint.

409A unique-constraint conflict (e.g. duplicate EIN, website, or externalId).

500An unexpected server error occurred. Retry the request; if the problem persists, contact support.