Create debit note line item

Endpoint for creating a new debit note line item.

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 debit note.

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 expense account of its item, else the default expense account of the contact; a line of an item that tracks inventory takes none, and 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 expense cost center of the contact. null leaves the line without one.

custom_fields
object

A mapping of custom field IDs to their values.

string
required

The line item description.

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 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 purchase tax rate of its item, else the default purchase tax rate of the contact. null leaves the line without one.

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