Get report
get_reportA Joist report for a date range: revenue, invoices, estimates or sales tax, with the period total. Returns one of the reports on Joist's Reports page for a date range, optionally for one client: revenue received per invoice (partial payments included), invoice statuses and balances, estimate statuses, or sales tax collected per tax. total is the report's total for the period. Joist updates report numbers once a day, so today's documents and payments show tomorrow. Reports are part of Joist Elite (and the trial). Pass next_cursor back as cursor.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Last day, up to a year after from. | |
| from | Yes | First day of the period. | |
| limit | No | ||
| client | No | Only this client, by exact name. | |
| cursor | No | next_cursor from the previous call. | |
| report | Yes | revenue (payments received per invoice, with balances at the start and end of the period), invoices (status, total, balance and due date), estimates (status, total, expiry) or sales_tax (tax collected per tax name and invoice). | |
| tax_name | No | sales_tax: only this tax, by name. |