FUfulcrumpro
Sales Order Refund Line Item

Update a specific refund line item for a sales order

Changed on
put/api/sales-orders/{salesOrderId}/refund-line-items/{lineItemId}

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/sales-orders/{salesOrderId}/refund-line-items/{lineItemId}
  • Auth
    none declared

Path parameters

salesOrderIdstring required
lineItemIdstring required

Request body

descriptionstring nullable

The refund line item description.

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

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

Changes

  • 6fc46fb4f45bRevision changes
    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status (media type: application/problem+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json-patch+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: text/json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/*+json)

  • 68a3cf300a5dRevision changes
    • info

      added the new optional request property // (media type: application/json-patch+json)

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: text/json)

    • info

      added the new optional request property // (media type: application/*+json)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/problem+json)