Check unpaid and overdue invoices
get_receivables_summaryUse this when someone asks how much customers owe, what is unpaid or overdue, or how old unpaid invoices are. Returns open invoice count and amount, the invoices marked overdue, and age buckets by days past due, from the newest 500 invoices; partially paid ones are counted but left out of amounts. Not for chasing or charging a customer.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| businessId | Yes | Business id: 24 lowercase hexadecimal characters |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aging | Yes | Fully owed open invoices by days past their due date (issue date when none) as of asOfDate. Invoice and customer identifiers, exact dates, contacts, tax ids, addresses, notes, line text, bank or card data, processor data and payment actions are never returned. | |
| asOfDate | Yes | UTC calendar date in YYYY-MM-DD format | |
| currency | Yes | ISO 4217 alpha-3 business currency, or null when unset | |
| overdueAmount | Yes | ||
| openInvoiceCount | Yes | ||
| outstandingAmount | Yes | ||
| amountMissingCount | Yes | ||
| sourceInvoiceCount | Yes | ||
| overdueInvoiceCount | Yes | Fully owed invoices whose status is OVERDUE; a PENDING invoice past its due date is counted only in aging | |
| sourceInvoiceCountIsLowerBound | Yes | ||
| partiallyPaidCountExcludedFromAmount | Yes | Open partially paid invoices left out of every amount because their remaining balance is not stored |