ZUzuper

Get Invoices Summary (Kanban)

Changed on

Groups all invoices matching the given filter by invoice_status and returns counts/totals per status. Always zero-fills all 9 statuses (DRAFT, READY_TO_INVOICE, AWAIT_PAYMENT, PARTIALLY_PAID, PAID, BAD_DEBT, ARCHIVED, CLOSED, CANCELED) even when empty — unlike the analogous Estimate endpoint, no status is ever filtered out. Amounts rounded to the company's decimal_roundoff config.

post/invoice/summary

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/invoice/summary
  • Auth
    API key in header x-api-key

Request body

sort'ASC' | 'DESC'
sort_by'created_at' | 'updated_at' | 'invoice_date' | 'due_date' | 'total' | 'amount_paid' | 'amount_due'
filter_rulesobject[]
filter_rule_operator'AND' | 'OR'
preferred_timezonestring

Response

200

Changes