Get Started

Dimensional P&L

GET/api/v1/accounting-dimensions/pnl

Profit & loss broken down by class or location for a date range.

Operation ID: dimensional_pnl_api_v1_accounting_dimensions_pnl_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

Query

dimension_typestringrequired

'class' or 'location'.

start_datestring · daterequired

Period start (inclusive).

end_datestring · daterequired

Period end (inclusive).

Responses

200Successful Response

Schema: DimensionalPnLResponse

dimension_typestringrequired

One of: class, location

start_datestring · daterequired
end_datestring · daterequired
rowsarray · DimensionalPnLRowrequiredDimensionalPnLRow
6 fields
dimension_idstring

Dimension UUID, or null for the unassigned bucket.

dimension_namestringrequired
codestring
revenueintegerrequired
expensesintegerrequired
net_incomeintegerrequired
totalsDimensionalPnLTotalsrequiredDimensionalPnLTotals
3 fields
revenueintegerrequired
expensesintegerrequired
net_incomeintegerrequired

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

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