For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP

GraphQL B2B Queries

invoiceStats

Example Query

1 query ExampleQuery($status: Int!, $companyIds: [Int], $decimalPlaces: Int) {
2   invoiceStats(status: $status, companyIds: $companyIds, decimalPlaces: $decimalPlaces) {
3     totalBalance
4     overDueBalance
5     hasDueInvoice
6     hasOverDueInvoice
7   }
8 }

Variables

1 {
2   "status": 0,
3   "companyIds": [],
4   "decimalPlaces": 0
5 }

Example response

1 {
2   "data": {
3     "invoiceStats": {
4       "totalBalance": 0,
5       "overDueBalance": 0,
6       "hasDueInvoice": true,
7       "hasOverDueInvoice": true
8     }
9   }
10 }

Get the stats of an invoice. Requires IP authentication.

Was this page helpful?

invoice

invoiceCustomerInformation

Arguments

statusIntegerRequired

The invoice status.
(0-open, 1-partial paid, 2-completed).
This field is required.

companyIdslist of optional IntegersOptional

Filter by one or more company IDs.

decimalPlacesIntegerOptional

The decimal places, not required

Returns

an optional InvoiceStatsType

totalBalanceDouble

The total balance of invoice.

overDueBalanceDouble

Amount not paid when the invoice is due.

hasDueInvoiceBoolean

Has due invoice?

hasOverDueInvoiceBoolean

Has over due invoice?