CreditMemo

Implements

Connections

items (CreditMemoItemConnection)

The CreditMemoItems associated with this CreditMemo.

Argument Type Description
ref [String!]

External reference to the CreditMemoItem. Must be unique.

type [String]

Type of the CreditMemoItem, typically used by the Orchestration Engine to determine the workflow that should be applied.

description [String]

Description of the CreditMemoItem.

orderItem OrderItemLinkInput
returnOrderItem ReturnOrderItemLinkInput
product ProductLinkInput
createdOn DateRange
updatedOn DateRange
first Int

Returns the first n elements from the list

last Int

Returns the last n elements from the list

before String

Returns the elements in the list that come before the specified global ID

after String

Returns the elements in the list that come after the specified global ID

payments (PaymentConnection)

The Payments associated with this CreditMemo.

Argument Type Description
ref [String!]

External reference of the object. Must be unique.

type [String!]

Type of the Payment, typically used by the Orchestration Engine to determine the workflow that should be applied. For Payment a sample value for this is DEFAULT.

status [String!]

Status of the Payment

retailer RetailerLinkInput
workflow WorkflowLinkInput
workflowRef [String!]

DEPRECATED, please use the field workflow instead - The reference of the workflow.

workflowVersion [Int!]

DEPRECATED, please use the field workflow instead - The version of the workflow.

createdOn DateRange
updatedOn DateRange
first Int

Returns the first n elements from the list

last Int

Returns the last n elements from the list

before String

Returns the elements in the list that come before the specified global ID

after String

Returns the elements in the list that come after the specified global ID

Fields

id (ID!)

ID of the object.

createdOn (DateTime)

Date and time of creation.

updatedOn (DateTime)

Date and time of last update.

ref (String!)

External reference to the CreditMemo. Must be unique.

attributes ([Attribute])

A list of attributes associated with the CreditMemo. This can be used to extend the existing data structure with additional data.

type (String)

Type of the CreditMemo, typically used by the Orchestration Engine to determine the workflow that should be applied.

status (String)

Status of the CreditMemo.

billingAccount (BillingAccount)

BillingAccount associated with the CreditMemo.

invoice (Invoice)

Invoice associated with this CreditMemo.

order (OrderLink)

Reference to an Order associated with the CreditMemo.

returnOrder (ReturnOrderLink)

Reference to a ReturnOrder associated with the CreditMemo.

issueDate (DateTime)

Issue date

currency (CurrencyLink)

Reference to the currency type. Generally, the standard ISO-4217 is used.

defaultTaxType (TaxType)

Default tax type

subTotalAmount (AmountType)

Sub-total amount

totalTax (AmountType)

Total tax

totalAmount (AmountType)

Total amount

totalBalance (AmountType)

Total balance

workflow (WorkflowLink)

The reference to the workflow associated.

workflowRef (String)
Deprecation notice

No longer supported

DEPRECATED, please use the field workflow instead - The reference of the workflow.

workflowVersion (String)
Deprecation notice

No longer supported

DEPRECATED, please use the field workflow instead - The version of the workflow.