v2

latestOpenAPI 3.0.42026-08-084694591.6 MB

Sales Order Refund Line Item

Get a list of refund lines items for a sales order

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

salesOrderIdstring required

List of refund line items for the given sales order id

idstring required

Unique id associated to this entity.

refundedLineIdstring required

The related, original line id that was refunded.

namestring required

The line item name.

descriptionstring nullable

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

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.

numberinteger

Line number