Tenant / Types/ Objects

Invoice

An invoice of the tenant

Fields

idID!

Unique primary key.

idID!

Unique primary key.

isEnabledBoolean!

Whether synchronization is enabled.

nameString!

Name of the integration.

autoSendTimeString!

Local time (HH:mm, in the timezone) of the daily automatic send.

billingRunTimeString!

Local time (HH:mm, in the timezone) of the daily billing run that bills inventory, fixed fees and minimums of closed periods.

Invoice cycle; null while nothing is saved, in which case every day is its own billing cycle.

MONTHLYWEEKLY
integrationIntegration

Invoicing integration that receives the invoices.

isAutoSendEnabledBoolean!

Whether invoices are sent automatically once a day after their period ended; invoices with charges that need attention are held.

isEnabledBoolean!

Whether invoicing is enabled.

isFreeLineFilterEnabledBoolean!

Whether lines with a zero amount are left out of the invoices.

isSendToClientEnabledBoolean!

Whether invoices are sent to the client after they are created in the invoicing system.

monthdayInt

Day of the month that starts a monthly cycle.

How draft invoices are released.

DRAFT_FIRST
timezoneString!

Timezone of the invoice cycles.

weekdayInt

ISO day of the week (1 = Monday) that starts a weekly cycle.

A list of Ledger edges.

pageInfoPageInfo!

Pagination information about the list of edges.

nameString!

Name of the organization

createdAtDateTimeTz!

When the invoice was created.

dueAtDate

Due at

idID!

Unique primary key.

issueCountInt!

Blocked charges of this client and business unit whose billing period overlaps the invoice period; they are missing from the invoice until resolved.

cursorString!

A unique cursor that can be used for pagination.

The InvoiceLine node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

numberString

Invoice number

candidates[Price!]!

All prices valid on the date for the client, its price lists and the list, newest first.

hasCurrencyConflictBoolean!

Whether the client's price lists price the item in different currencies, so no price list price applies.

pricePrice

Applied price; null when the item has no usable price.

priceListPriceList

Price list of the applied price, for PRICE_LIST.

priceableIdID!

ID of the priced item.

priceableTypePriceableType!

Type of the priced item.

FULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_OPTION

Where the applied price comes from.

CLIENTLISTPRICE_LIST

A list of BillingCharge edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ClientContact edges.

pageInfoPageInfo!

Pagination information about the list of edges.

The features associated with this client.

DEMOSUPPORT_AUTOMATIONSUPPORT_TICKETS

A list of FulfillmentService edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of InvoiceLineBillableFulfillment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of InvoiceLineBillableGoodsReceipt edges.

pageInfoPageInfo!

Pagination information about the list of edges.

idID!

Unique primary key.

A list of InvoiceContact edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Invoice edges.

pageInfoPageInfo!

Pagination information about the list of edges.

nameString!

Name of the client

A list of InvoiceLineBillableOrder edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of PriceList edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of InvoiceLineBillableReturnReceipt edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of InvoiceLineBillableShipment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of TenantShippingProduct edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of User edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Warehouse edges.

pageInfoPageInfo!

Pagination information about the list of edges.

periodEndAtDate

Last day of the billing period this invoice covers.

periodStartAtDate

First day of the billing period this invoice covers.

referenceString

Order / invoice reference

autoSendAtDateTimeTz

When the invoice is sent automatically; null when its business unit does not send automatically, the invoice is not open or it is held.

blockedReasonString

Why the invoice cannot be sent now (status, a dispatch in progress, or missing integration or invoice contact); null when it can be sent.

errorString

Error of the last failed dispatch attempt.

isAutoSendHeldBoolean!

Whether automatic sending holds this open invoice, because it cannot be sent (blockedReason) or has blocked charges (Invoice.issueCount).

Progress of sending the invoice through the invoicing connector.

CREATEDCREATINGFAILEDQUEUEDSENDINGSENT
sentAtDate

Sent at

Status of the invoice

CONCEPTDRAFTOPENORDERPAIDPENDING
currencyString!

ISO 4217 currency code

valueString!

Amount

currencyString!

ISO 4217 currency code

valueString!

Amount

updatedAtDateTimeTz!

When the invoice was last updated.