RefundLineInput

Input for adding a refund line.

input RefundLineInput {
  chargedTo: RefundChargeToEnum!
  lineType: RefundLineTypeEnum!
  refundScope: ID!
  amount: PositiveDecimal
  percentage: PositiveDecimal
  quantity: Int
  quantityFulfilled: Int
  quantityUnfulfilled: Int
}

Fields

RefundLineInput.chargedTo ● RefundChargeToEnum! non-null enum

To whom the refund will be applied.

RefundLineInput.lineType ● RefundLineTypeEnum! non-null enum

Type of refund line calculation.

RefundLineInput.refundScope ● ID! non-null scalar

Reference ID of the instance to which refund will be applied. Allowed instances are NauticalOrder, Order, OrderLine.

RefundLineInput.amount ● PositiveDecimal scalar

Refund line amount (in order currency).

RefundLineInput.percentage ● PositiveDecimal scalar

Percentage of the scope to refund.

RefundLineInput.quantity ● Int scalar

Total quantity to refund (shorthand for fulfilled + unfulfilled).

RefundLineInput.quantityFulfilled ● Int scalar

Quantity of fulfilled items to refund.

RefundLineInput.quantityUnfulfilled ● Int scalar

Quantity of unfulfilled items to refund.

Member Of

refundLinesAdd mutation