Sign in
Sales Order Refund Line Item

Create a refund line item on a sales order

post/api/sales-orders/{salesOrderId}/refund-line-items

Path parameters

salesOrderIdstring required

Request body

descriptionstring nullable

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

refundedLineIdstring required

The related, original line id that was refunded.

refundQuantitynumber double required

The quantity to be refunded.

refundAmountnumber double required

The refund amount.

accountingCodeIdstring nullable

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

refundReasonCodeIdstring nullable

Refund reason code key identifier. Please reference /api/refund-reason-codes endpoint.

isReturnboolean nullable

Indicate if a return is expected.

returnQuantitynumber double nullable

The quantity to be returned.

externalReferencesobject nullable

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

Response

Refund line item added to sales order

idstring required

The id of the created record