Update credit note line item

Endpoint for updating an existing credit note line item.

Path Params
string
required
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 credit note.

string
required

The account associated with this line item.

string

The cost center associated with this line item.

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.

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 finalized, partly paid or paid credit note, a PATCH of the line that sends only this field changes it, until the credit note is reported (then 403 frozen_state_locked); report it again with POST /v1/credit-notes//tax-authority/report/.

string

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.

double
required

The unit amount of the item.

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