Create simplified invoice line item

Endpoint for creating a new simplified invoice line item. Without a VAT TRN, the organization can't newly add a Sales rate above 0% or a Reverse charge rate, nor, in the UAE, a zero-rated rate; exempt and out-of-scope rates stay available. Such a request is refused with HTTP 400 and code vat_trn_required; see the tax_rate field.

Path Params
string
required
Query Params
string

Comma-separated related objects to return in full instead of as IDs. Accepted values: account, account.parent, cost_center, item, tax_rate. Nested relations are joined with a dot.

Body Params

A line item of a simplified invoice.

string

The account associated with this line item. Left out, a line the request adds (each line of a document create, a line of an update that matches no stored line by its tax rate and item or by its description, or one added through the line endpoint; a line an update sends again for a stored line is written as sent, a field it leaves out staying empty) takes the revenue account of its item, else the default revenue account of the contact; a bank account held in a currency other than the document's is skipped. A line that neither sends nor takes one is refused with code required. A bank account held in a currency other than the document's is refused.

string | null

The cost center associated with this line item. Left out, a line the request adds (each line of a document create, a line of an update that matches no stored line by its tax rate and item or by its description, or one added through the line endpoint; a line an update sends again for a stored line is written as sent, a field it leaves out staying empty) takes the default revenue cost center of the contact. null leaves the line without one.

string
required

The description of the line item.

double | null
≥ 0

The discount as the percentage.

string

The item associated with this line item.

string | null

The item unit of measure for this line item.

integer

The position of the line item within the document.

double
required

The quantity of the item or service.

string | null

The tax exemption reason of the line, as reporting to the tax authority needs it on a zero-rated or exempt line: a code the tax rate of the line offers (the TaxExemptionReasonCodes page lists them), or, on the KSA out-of-scope rate, the reason written out. On a rate that takes no reason, a reason sent is kept but not reported. null or "" clears the reason. Left out, a new line takes the default of its item, else the default of the contact (when the line is on the default revenue tax rate of the contact), else the default of its tax rate, else none. So does a line whose tax rate or item changes. Any other line keeps its reason, also when an update sends the lines again: each line is matched with the stored line that has its tax rate, item and description. On a paid cash invoice, a PATCH of the line that sends only this field changes it, until the cash invoice is reported (then 403 frozen_state_locked); report it again with POST /v1/simplified-invoices//tax-authority/report/.

string | null

The tax rate applied to this line item: the ID of the tax rate (tax_…). List the tax rates of the organization with GET /v1/tax-rates/. Add expand=line_items.tax_rate to get the full tax rate in the response. Left out, a line the request adds (each line of a document create, a line of an update that matches no stored line by its tax rate and item or by its description, or one added through the line endpoint; a line an update sends again for a stored line is written as sent, a field it leaves out staying empty) takes the revenue tax rate of its item, else the default revenue tax rate of the contact, else, without a VAT TRN on the organization, its Out of scope rate; a default rate the organization can't newly charge is skipped. null leaves the line without one. Without a VAT TRN on the organization, a local Sales rate above 0%, a Reverse charge rate, or, for a UAE organization, a zero-rated Sales rate is refused when newly set on a line, with HTTP 400 and code vat_trn_required; a line that already carries the rate keeps it, also when an update sends the lines again. Add the VAT TRN with PATCH /v1/organization/profile/ (financial_settings.tax_registration_number) or PATCH /v2/organizations/{id}/ (profile.tax_registration_number).

double
required

The unit amount of the item or service.

Headers
string

Client-provided UUID to uniquely identify a request

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

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