BigCommerce Docs

Get the stats of an invoice. Requires IP authentication.

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

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?

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	}