Sum up invoices and payments for a period
summarize_paymentsSummarizes invoices for a chosen period, showing status counts, invoiced and received USD, and totals by network and token so you can review payment activity without paging through individual invoices.
Instructions
Sums up the invoices created in a period instead of paging through list_invoices: how many in each status, invoicedUsd (cancelled and expired left out), receivedUsd (confirmed payments that passed sanctions screening) and the money per network and token. Pass period (last_7_days, last_30_days, this_month, last_month or last_3_months) or both createdFrom and createdTo as UTC days; one call covers at most 92 days, so ask for a year in four quarters. Without store and with several stores you get one summary per store plus a total. Use list_invoices to see the invoices themselves. A failure comes back as an error with its code and what to do, for example rate_limited with the seconds to wait.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| store | No | Store id or exact store name from list_stores. Needed only when several stores are connected. | |
| period | No | A ready-made range of UTC days ending today. Leave out when giving dates. | |
| createdTo | No | Last UTC day, YYYY-MM-DD, included. | |
| createdFrom | No | First UTC day, YYYY-MM-DD, with createdTo. |