Get Started

Single project profitability

GET/api/v1/projects/{project_id}/profitability

Revenue, expense, and net profit for one project.

Operation ID: single_project_profitability_api_v1_projects__project_id__profitability_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.

Parameters

Path

project_idstringrequired

Query

start_datestring · daterequired

Period start (inclusive).

end_datestring · daterequired

Period end (inclusive).

Responses

200Successful Response

Schema: ProjectProfitabilityResponse

start_datestring · daterequired
end_datestring · daterequired
rowsarray · ProjectProfitabilityRowrequiredProjectProfitabilityRow
6 fields
project_idstring

Project UUID, or null for the unassigned bucket.

project_namestringrequired
codestring
revenueintegerrequired
expensesintegerrequired
net_incomeintegerrequired
totalsProjectProfitabilityTotalsrequiredProjectProfitabilityTotals
3 fields
revenueintegerrequired
expensesintegerrequired
net_incomeintegerrequired

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject