Sign in
Invoice Refund Line Item

Update a specific refund line item for an invoice

put/api/invoices/{invoiceId}/refund-line-items/{lineItemId}

Path parameters

invoiceIdstring required
lineItemIdstring required

Request body

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Response

Refund line item

idstring required

Unique id associated to this entity.

quantitynumber double required

The line item quantity

pricenumber double required

The line item price.

itemIdstring required

Item id associated with this line item.

namestring required

The name of the line item. Defaults to the item's description if none specified.

descriptionstring nullable

The refund line item description. Defaults to the item's description if none specified.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

salesOrderLineItemIdstring required

Id that references the sales order line item that was refunded.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

numberinteger

Line number