Skip to main content
POST
Create Invoice

Authorizations

Authorization
string
header
required

Use your app's API_KEY as the username, and leave the password blank

Path Parameters

connection_id
string<uuid>
required

ID of the connection to use for invoice creation

Query Parameters

request_id
string

A custom ID that can be used to identify the request and response. This could be your local ID for the request.

Example:

"1"

webhook_url
string<uri>

Optional URL to receive a webhook when the request is completed

Body

application/json
customer_list_id
string
required

Customer ListID for the invoice

transaction_date
string<date>
required

Invoice transaction date (YYYY-MM-DD)

lines
object[]
required

Invoice line items

Minimum array length: 1
class_list_id
string

Optional class ListID applied to the invoice (and line items unless overridden)

receivables_account_list_id
string

Optional accounts receivable account ListID

template_list_id
string

Optional invoice template ListID

ref_number
string

Optional user-defined reference number

bill_address
object

Optional bill-to address

ship_address
object

Optional ship-to address

purchase_order_number
string

Optional customer PO number

terms_list_id
string

Optional payment terms ListID

due_date
string<date>

Optional due date (YYYY-MM-DD)

memo
string

Optional memo for reports

customer_message_list_id
string

Optional customer message ListID

item_sales_tax_list_id
string

Optional tax item or tax group ListID applied to the entire invoice

customer_sales_tax_code_list_id
string

Optional customer sales tax code ListID applied to the invoice

is_pending
boolean

Whether the invoice is pending/draft

is_to_be_printed
boolean

Whether the invoice should be queued for print

is_to_be_emailed
boolean

Whether the invoice should be queued for email

Response

Invoice create request accepted and queued for processing. Returns a queued request object.

data
object