Create Invoice

This API endpoint create an invoice and automatically assigns it to given recipient to pay

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Template Usage

When creating an invoice using a template (by specifying templateId), certain fields will be automatically populated from the template unless it is not explicitly overridden in the request:

  • lineItems
  • memo
  • taxPercentage
  • currency

Payment Preferences

The paymentMethodPreferences array allows you to specify:

  • Which payment methods are accepted (paymentMethodTypes)
  • If transaction fee would be paid by the client/company, or by your account

Line Items

When creating line items, you must provide:

For one-off items:

  • amount (required) - Amount in cents
  • description (optional) - Description of the item
  • quantity (required) - Quantity of the item (supports decimals)

For recurring price items:

  • priceId (required) - ID of the Prices object
  • quantity (required) - Quantity of the item (supports decimals)

All line items must have either:

  • amount + quantity for one-off items, OR
  • priceId + quantityfor recurring price items

This makes it clearer that quantity is always required, and description is optional only for one-off line items.

Body Params
string

Unique ID of the invoice template to use. If provided, template values will be used for lineItems, memo, and taxPercentage.

string

Deprecated in favor of clientId and companyId.

lineItems
array of objects

Array of line items. Required if templateId is not provided.

lineItems
string

Memo (arbitrary string) attached to the invoice, often used for display.

int32
required

The number of days from when the invoice is created until it is due. Max value is 30.

float

Tax percentage to apply to the invoice amount.

paymentMethodPreferences
array of objects
required

Array of preferences which specify which payment methods are allowed and how transaction fees are handled for each payment method

paymentMethodPreferences*
string

The ID of the client this invoice is assigned to. Leave empty if assigning to a company.

string

The ID of the company this invoice is assigned. This is required when an invoice is assigned to a client with more than one company.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json