v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB

Credit Note Line Items

Update credit note line item

Endpoint for updating an existing credit note line item.

put/credit-notes/{credit_note_id}/line-items/{id}/

Path parameters

credit_note_idstring required

idstring required

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

accountstring required

The account associated with this line item.

cost_centerstring

The cost center associated with this line item.

created_tsstring date-time required

The timestamp in UTC when the line item was created.

custom_fieldsobject

A mapping of custom field IDs to their values.

descriptionstring required

The line item description.

discountnumber double nullable

The discount as the percentage.

idstring required

The unique identifier of the line item.

itemstring

The item associated with this line item.

item_unit_of_measurestring nullable

The item unit of measure for this line item.

legacy_idstring required

[Deprecated] The legacy identifier of the line item.

line_amountnumber double required

The total amount for this line item.

modified_tsstring date-time required

The timestamp in UTC when the line item was last modified.

orderinteger

quantitynumber double required

The quantity of the item.

tax_amountnumber double required

The tax amount for this line item.

tax_ratestring

The tax rate applied to this line item.

unit_amountnumber double required

The unit amount of the item.

Response

accountstring required

The account associated with this line item.

cost_centerstring

The cost center associated with this line item.

created_tsstring date-time required

The timestamp in UTC when the line item was created.

custom_fieldsobject

A mapping of custom field IDs to their values.

descriptionstring required

The line item description.

discountnumber double nullable

The discount as the percentage.

idstring required

The unique identifier of the line item.

itemstring

The item associated with this line item.

item_unit_of_measurestring nullable

The item unit of measure for this line item.

legacy_idstring required

[Deprecated] The legacy identifier of the line item.

line_amountnumber double required

The total amount for this line item.

modified_tsstring date-time required

The timestamp in UTC when the line item was last modified.

orderinteger

quantitynumber double required

The quantity of the item.

tax_amountnumber double required

The tax amount for this line item.

tax_ratestring

The tax rate applied to this line item.

unit_amountnumber double required

The unit amount of the item.