Portfolio summary (dashboard KPIs)

GET/api/v1/contracts/summary

Business-wide contract KPIs aggregated in SQL across ALL contracts (not a capped page): total value, billed, recognized, deferred, and counts by status.

Operation ID: contract_portfolio_summary_api_v1_contracts_summary_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Responses

200Successful Response

Schema: SuccessEnvelope_ContractPortfolioSummary_

successboolean
messagestring
codestring
dataContractPortfolioSummary

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/contracts/summary

bash

curl -X GET 'https://api.ondayzero.com/api/v1/contracts/summary' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'