Tenant / Types/ Objects

BillingCharge

Fields

currencyString!

ISO 4217 currency code

valueString!

Amount

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

chargeDateDate!

Charge date of the billing charge.

chargeKeyString!

Charge key of the billing charge.

createdAtDateTimeTz!

When the billing charge was created.

descriptionString!

Description of the billing charge.

idID!

Unique primary key.

idID!

Unique primary key.

invoicingIntegrations[Integration!]!

Integrations of the business unit that can receive invoices.

Invoicing configuration of the business unit.

Active ledgers synchronized from this business unit's configured invoicing integration.

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.

A list of InvoiceLine edges.

pageInfoPageInfo!

Pagination information about the list of edges.

numberString

Invoice number

appliedPrices[AppliedPrice!]!

Prices billing applies to this client on a date for the rules and tiers of a fulfillment service and/or the bases and options of a shipping product.

Billing charges prepared for this client.

Contacts for this tenant–client relationship. Contact roles do not grant application access.

The features associated with this client.

DEMOSUPPORT_AUTOMATIONSUPPORT_TICKETS

List fulfillment services provided by tenant

Shipped fulfillments of the client in a warehouse of the tenant.

Completed goods receipts of the client in a warehouse of the tenant.

idID!

Unique primary key.

Invoice contacts of the client.

Invoices issued for this client.

nameString!

Name of the client

Orders of the client.

Price lists attached to this client

Completed return receipts of the client in a warehouse of the tenant.

Shipped shipments of the client, to find the resource a support ticket is about.

List shipping products provided by tenant

Users with active access to the client organization.

List warehouses provided by tenant

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.

currencyString!

ISO 4217 currency code

valueString!

Amount

createdAtDateTimeTz!

When the invoice line was created.

descriptionString!

Description of the line

idID!

Unique primary key.

businessUnitBusinessUnit

Business unit that issues the invoice.

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.

The lines associated with this invoice.

numberString

Invoice number

organizationClient!

Organization for which the invoice is issued.

periodEndAtDate

Last day of the billing period this invoice covers.

periodStartAtDate

First day of the billing period this invoice covers.

referenceString

Order / invoice reference

Sending of the invoice: whether it can be sent, when it is sent automatically and the progress of a dispatch.

sentAtDate

Sent at

Status of the invoice

CONCEPTDRAFTOPENORDERPAIDPENDING
totalAmountMoney

Total amount excluding VAT.

totalAmountInclVatMoney

Total amount including VAT.

updatedAtDateTimeTz!

When the invoice was last updated.

A list of InvoiceLineItem edges.

pageInfoPageInfo!

Pagination information about the list of edges.

periodEndAtDate

Period end

periodStartAtDate

Period start

quantityFloat!

Quantity

currencyString!

ISO 4217 currency code

valueString!

Amount

updatedAtDateTimeTz!

When the invoice line was last updated.

isReprocessableBoolean!

Whether this billing charge can be reprocessed.

issueCodeString

Issue code of the billing charge.

codeString

Code of the ledger.

createdAtDateTimeTz!

When the ledger was created.

idID!

Unique primary key.

integrationReferenceString!

Integration reference of the ledger.

isActiveBoolean!

Whether this ledger is active.

nameString!

Name of the ledger.

syncedAtDateTimeTz

When the ledger was last synchronized.

updatedAtDateTimeTz!

When the ledger was last updated.

metadataMixed

Metadata of the billing charge.

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.

Origin of the billing charge.

CARRIER_PASS_THROUGHCREDITFIXED_FEEMANUALMINIMUM_ADJUSTMENTRESOURCESUBSCRIPTION
periodEndAtDate!

End of the billing period.

periodStartAtDate!

Start of the billing period.

Kind of price.

CLIENTLISTMANUALPASS_THROUGHPRICE_LISTSNAPSHOT
createdAtDateTimeTz!

When the price list was created.

Fulfillment services associated with this price list

idID!

Unique primary key.

nameString!

Name of the price list

Shipping products associated with this price list

updatedAtDateTimeTz!

When the price list was last updated.

Priceable of the billing charge.

priceableIdID

ID of the pricing source identified by priceableType.

Model type of the pricing source used for this billing charge.

CARRIER_CHARGE_MAPPINGCARRIER_INVOICE_LINE_CHARGEFULFILLMENTFULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERGOODS_RECEIPTINVENTORY_BILLING_PERIODORGANIZATIONRETURN_RECEIPTSHIPMENTSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_FUEL_SURCHARGESHIPPING_PRODUCT_OPTIONSUBSCRIPTION

Pricing mode of the billing charge.

CATALOGMANUALPASS_THROUGHSNAPSHOT
quantityString!

Quantity of the billing charge.

The resource associated with this billing charge.

Current status of the billing charge.

BLOCKEDINVOICEDPENDINGPROJECTEDREADY
subjectIdID!

ID of the subject identified by subjectType.

Model type of the subject that generated this billing charge.

CARRIER_CHARGE_MAPPINGCARRIER_INVOICE_LINE_CHARGEFULFILLMENTFULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERGOODS_RECEIPTINVENTORY_BILLING_PERIODORGANIZATIONRETURN_RECEIPTSHIPMENTSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_FUEL_SURCHARGESHIPPING_PRODUCT_OPTIONSUBSCRIPTION
currencyString!

ISO 4217 currency code

valueString!

Amount

updatedAtDateTimeTz!

When the billing charge was last updated.

idID!

Unique primary key.

invoicingIntegrations[Integration!]!

Integrations of the business unit that can receive invoices.

Invoicing configuration of the business unit.

Active ledgers synchronized from this business unit's configured invoicing integration.

nameString!

Name of the organization

createdAtDateTimeTz!

When the VAT profile was created.

descriptionString

Description of the VAT profile.

idID!

Unique primary key.

nameString!

Name of the VAT profile.

A list of VatProfileRule edges.

pageInfoPageInfo!

Pagination information about the list of edges.

updatedAtDateTimeTz!

When the VAT profile was last updated.