Partial update quote line item

Endpoint for partially updating an existing quote 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
string
required
Query Params
string

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

Body Params

A line item of a quote.

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.

custom_fields
object

A mapping of custom field IDs to their values.

string

The detailed 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

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 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

The price per unit 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