Payment
Requires access scope.
Represents the payment terms for an order or draft order.
Anchor to Fields and connectionsFields and connections
- Anchor to draftOrderdraft•
Order The draft order associated with the payment terms.
- •Boolean!non-null
Whether payment terms have a payment schedule that's due.
- Anchor to dueInDaysdue•
In Days Duration of payment terms in days based on the payment terms template used to create the payment terms.
- •ID!non-null
A globally-unique ID.
- Anchor to orderorder•
The order associated with the payment terms.
- Anchor to overdueoverdue•Boolean!non-null
Whether the payment terms have overdue payment schedules.
- Anchor to paymentSchedulespayment•
Schedules PaymentSchedule Connection!non-null List of schedules for the payment terms.
- Anchor to paymentTermsNamepayment•
Terms Name String!non-null The name of the payment terms template used to create the payment terms.
- Anchor to paymentTermsTypepayment•
Terms Type PaymentTerms Type!non-null The payment terms template type used to create the payment terms.
- Anchor to translatedNametranslated•
Name String!non-null The payment terms name, translated into the shop admin's preferred language.
Anchor to MutationsMutations
- •mutation
Create payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the
.- Anchor to paymentTermsAttributespayment•
Terms Attributes PaymentTerms Create Input!required The attributes used to create the payment terms.
- Anchor to referenceIdreference•
Id ID!required Specifies the reference orderId to add the payment terms for.
Arguments
- Anchor to paymentTermspayment•
Terms The created payment terms.
- Anchor to userErrorsuser•
Errors [PaymentTerms Create User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Update payment terms on an order. To update payment terms on a draft order, use a draft order mutation and include the request with the
.- Anchor to inputinput•Payment
Terms Update Input!required The input fields used to update the payment terms.
Arguments
- Anchor to paymentTermspayment•
Terms The updated payment terms.
- Anchor to userErrorsuser•
Errors [PaymentTerms Update User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields