Invoice Summary Report

post

https://{dc-region}.zuperpro.com/api/reports/invoice/summary

Generate a comprehensive invoice summary report with detailed filtering options

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

from_date

string

required

Start date (YYYY-MM-DD)

to_date

string

required

End date (YYYY-MM-DD)

date_type

string

Defaults to scheduled_date

skip_date_range

boolean

Defaults to false

include_uid

string

Specific invoice UIDs to include (comma-separated)

filter_rules

string

Advanced filter rules JSON

filter.status

string

Invoice status (draft/sent/paid/overdue/cancelled)

filter.customer

string

Customer UIDs (comma-separated)

filter.job

string

Job UIDs (comma-separated)

filter.property

string

Property UIDs (comma-separated)

filter.organization

string

Organization UIDs (comma-separated)

filter.created_by

string

Creator user UIDs (comma-separated)

filter.created_at

string

Filter by creation date

filter.updated_at

string

Filter by update date

filter.due_date

string

Filter by due date

filter.payment_date

string

Filter by payment date

filter.invoice_uid

string

Invoice UIDs (comma-separated)

filter.team_uid

string

Team UIDs (comma-separated)

filter.keyword

string

Search keyword

filter.is_deleted

boolean

Is invoice deleted

filter.is_active

boolean

Is invoice active

filter.payment_status

string

Payment status (pending/paid/partial/overdue)

filter.payment_method

string

Payment methods (comma-separated)

filter.custom_field

string

Custom field values (comma-separated)

filter.amount_min

number

Minimum invoice amount

filter.amount_max

number

Maximum invoice amount

filter.tax_amount_min

number

Minimum tax amount

filter.tax_amount_max

number

Maximum tax amount

filter.discount_min

number

Minimum discount amount

filter.discount_max

number

Maximum discount amount

filter.paid_amount_min

number

Minimum paid amount

filter.paid_amount_max

number

Maximum paid amount

filter.balance_min

number

Minimum balance amount

filter.balance_max

number

Maximum balance amount

filter.product

string

Product UIDs (comma-separated)

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Invoice Summary report generated successfully

400Bad request - Invalid parameters

401Unauthorized - Missing or invalid authentication