Service Contract Product Consumption Report

post

https://{dc-region}.zuperpro.com/api/reports/service_contract/product_consumption

Generate a comprehensive service contract product consumption 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 service contract UIDs to include (comma-separated)

filter_rules

string

Advanced filter rules JSON

filter.status

string

Service contract status (active/inactive/expired/cancelled)

filter.customer

string

Customer 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.start_date

string

Filter by contract start date

filter.end_date

string

Filter by contract end date

filter.service_contract_uid

string

Service contract UIDs (comma-separated)

filter.keyword

string

Search keyword

filter.is_deleted

boolean

Is service contract deleted

filter.is_active

boolean

Is service contract active

filter.name

string

Service contract names (comma-separated)

filter.description

string

Service contract descriptions (comma-separated)

filter.type

string

Service contract types (comma-separated)

filter.frequency

string

Service frequencies (daily/weekly/monthly/quarterly/yearly)

filter.amount_min

number

Minimum contract amount

filter.amount_max

number

Maximum contract amount

filter.monthly_amount_min

number

Minimum monthly amount

filter.monthly_amount_max

number

Maximum monthly amount

filter.job_count_min

number

Minimum job count

filter.job_count_max

number

Maximum job count

filter.completed_job_count_min

number

Minimum completed job count

filter.completed_job_count_max

number

Maximum completed job count

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

200Service Contract Product Consumption report generated successfully

400Bad request - Invalid parameters

401Unauthorized - Missing or invalid authentication