Get entity invoice metrics
mercoa_get_entity_invoice_metricsRead-only
Get aggregate invoice metrics (totals/counts, grouped by currency) for an entity's payables/receivables — for AP/AR dashboards and aging. GET /entity/{entityId}/invoice-metrics.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | Search by vendor name, invoice number, check number, or amount. | |
| status | No | Invoice status filter (e.g. NEW, SCHEDULED, PAID). | |
| endDate | No | End date filter (ISO 8601). | |
| groupBy | No | Additional grouping (e.g. by status). | |
| payerId | No | Filter by payer ID(s). | |
| currency | No | Currency code(s) to filter on, e.g. USD. | |
| dateType | No | Date type to filter by (e.g. CREATED_AT, DUE_DATE). | |
| entityId | Yes | Entity ID or foreign ID. | |
| vendorId | No | Filter by vendor ID(s). | |
| invoiceId | No | Filter by invoice ID(s) or foreign ID(s). | |
| startDate | No | Start date filter (ISO 8601). | |
| approverId | No | Filter by assigned approver user ID(s). | |
| returnByDate | No | Group metrics by date, e.g. CREATION_DATE or DUE_DATE. | |
| excludePayables | No | Only return receivables (exclude payables). | |
| excludeReceivables | No | Only return payables (exclude receivables). | |
| returnByDateFrequency | No | Frequency for date grouping (e.g. DAILY, MONTHLY). |