Skip to main content

RefundLine

Represents a refund line

type RefundLine implements Node {
createdAt: DateTime!
updatedAt: DateTime!
id: ID!
chargedTo: RefundChargeToEnum!
currency: String!
lineScope: RefundLineScopeEnum!
lineType: RefundLineTypeEnum!
percentage: Float!
quantityFulfilled: Int!
quantityUnfulfilled: Int!
refund: Refund!
refundScope: RefundScope!
total: TaxedMoney!
}

Fields

RefundLine.createdAt ● DateTime! non-null scalar

RefundLine.updatedAt ● DateTime! non-null scalar

RefundLine.id ● ID! non-null scalar

The ID of the object

RefundLine.chargedTo ● RefundChargeToEnum! non-null enum

Indicates who is paying for the cost of this refund line

RefundLine.currency ● String! non-null scalar

Currency code that this refund line is in

RefundLine.lineScope ● RefundLineScopeEnum! non-null enum

How does this refund line apply to the original order

RefundLine.lineType ● RefundLineTypeEnum! non-null enum

How is this refund line amount calculated

RefundLine.percentage ● Float! non-null scalar

If configured as a percentage refund, this is the percentage of the scope value that is to be refunded. This is in the range [0. 100]

RefundLine.quantityFulfilled ● Int! non-null scalar

If configured as a quantity based refund, this is the number of fulfilled units refunded.

RefundLine.quantityUnfulfilled ● Int! non-null scalar

If configured as a quantity based refund, this is the number of unfulfilled units refunded.

RefundLine.refund ● Refund! non-null object

The refund this refund line is contained in

RefundLine.refundScope ● RefundScope! non-null union

The scope that this refund line applies to

RefundLine.total ● TaxedMoney! non-null object

The total for this refund line

Interfaces

Node interface

An object with an ID

Member Of

JournalEntry object ● RefundLineCountableEdge object

Was this page helpful?