Invoice

Implements

Connections

items (InvoiceItemConnection)

The InvoiceItems associated with this Invoice.

Argument Type Description
ref [String!]

External reference to the InvoiceItem. Must be unique.

type [String]

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

description [String]

A description of the source item. In the case of product source items this can be the name.

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

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 Invoice. Must be unique.

attributes ([Attribute])

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

workflow (WorkflowLink)

The reference to the workflow associated.

type (String)

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

status (String)

Status of the Invoice.

billingAccount (BillingAccount)

The BillingAccount associated with the Invoice.

order (OrderLink)

Reference to the Order associated with this Invoice.

fulfilment (FulfilmentLink)

Reference to the Fulfilment associated with this Invoice.

creditMemos ([CreditMemo])

A list of associated credit memos that have been used to adjust this invoice in favour of the billing account

issueDate (DateTime)

The date on which this invoice was formally issued.

dueDate (DateTime)

The date on which this invoice is due for completion.

currency (CurrencyLink)

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

defaultTaxType (TaxType)

The default Tax Type for this invoice. Individual invoice items can override.

subTotalAmount (AmountType)

The total amount of this invoice excluding tax.

totalTax (AmountType)

The total amount of tax for this invoice

totalAmount (AmountType)

The total amount of this invoice including tax

totalBalance (AmountType)

The total amount of this invoice yet to be paid. (This caters for multi-part payments and payment milestones)

workflowRef (String)
Deprecation notice

No longer supported

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

workflowVersion (Int)
Deprecation notice

No longer supported

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