Invoice GraphQL
Served by InvoiceModule on commercetools and InvoiceModule on medusa.
Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the invoice types page.
Types
| Type | Description |
|---|---|
InvoiceObject | An amount a company owes, issued as a document and settled separately from the orders it bills. |
InvoiceResultObject | Paginated result containing invoices |
InvoiceStatusCountObject | The number of invoices in one status |
InvoiceStatusTypeEnum | Where an invoice stands, derived on read from what has been collected against it. |
Fields on other types
This domain adds these fields to types that another domain defines.
BusinessUnit
| Field | Type | Description |
|---|---|---|
invoice | Invoice | One invoice of this company, by idArguments: id |
invoices | InvoiceResult! | Invoices billed to this company, newest first. Visible to whoever may see
the company's orders: a standalone invoice belongs to no order, so whether
it is the caller's own cannot be asked of it.Arguments: page, pageSize, searchTerm, status, invoiceDateFrom, invoiceDateUntil |
Customer
| Field | Type | Description |
|---|---|---|
invoice | Invoice | One invoice billed to this person, by id.
The signed-in caller's own, whichever customer this field was reached
through: a Customer is addressable by email, and answering with somebody
else's invoice because their address was asked for is not a question this
should be able to answer.Arguments: id |
invoices | InvoiceResult! | Invoices billed to this person rather than to a company, newest firstArguments: page, pageSize, searchTerm, status, invoiceDateFrom, invoiceDateUntil |