CostProfitSummaryDto - SodiumHQ API Schema

Properties

Name	Type	Description
totalMinutes	integer	Total minutes logged in the window
Total minutes logged in the window
billableMinutes	integer	Of those, the minutes marked billable
Of those, the minutes marked billable
costAmount	number	What the logged time cost the practice: all minutes at the stamped cost rates, the minutes per distinct rate valued to the penny
What the logged time cost the practice: all minutes at the stamped cost rates, the minutes per distinct rate valued to the penny
billableAmount	number	What the billable time is worth: billable minutes at the stamped charge-out rates, same rounding law — whether the time has been billed yet or not
What the billable time is worth: billable minutes at the stamped charge-out rates, same rounding law — whether the time has been billed yet or not
profitAmount	number	Billable value minus cost — negative when the time cost more than it can be billed for
Billable value minus cost — negative when the time cost more than it can be billed for
settledAmount	number	WIP the window's time has settled through billing or write-off (allocations against the entries in the window, whenever the disposal was recorded)
WIP the window's time has settled through billing or write-off (allocations against the entries in the window, whenever the disposal was recorded)
billedAmount	number	What clients were charged for that time on Sodium's billing lines. Time billed before the allocation model existed reads as billed at full value.
What clients were charged for that time on Sodium's billing lines. Time billed before the allocation model existed reads as billed at full value.
writtenOffAmount	number	Settled minus billed: time written off (negative is written on)
Settled minus billed: time written off (negative is written on)
recoveryRate	number	Billed as a share of the billable value, as a percentage. Null when there is no billable value. Money billed on account with no time behind it is not counted here; see the WIP Value report for job-level recovery.
Billed as a share of the billable value, as a percentage. Null when there is no billable value. Money billed on account with no time behind it is not counted here; see the WIP Value report for job-level recovery.
entryCount	integer	Number of time entries in the window
Number of time entries in the window
uncostedEntryCount	integer	Entries with no cost rate stamped — they contribute minutes but no cost (typically entries created before cost rates were set)
Entries with no cost rate stamped — they contribute minutes but no cost (typically entries created before cost rates were set)
unratedEntryCount	integer	Billable entries with no charge-out rate stamped — they contribute minutes but no billable value
Billable entries with no charge-out rate stamped — they contribute minutes but no billable value
groupCount	integer	Number of rows (groups) in the report
Number of rows (groups) in the report
startDate	string	The window the report covers (inclusive)
The window the report covers (inclusive)
endDate	string	The window end the report covers (inclusive)
The window end the report covers (inclusive)

JSON Example

{
  "totalMinutes": 0,
  "billableMinutes": 0,
  "costAmount": 0,
  "billableAmount": 0,
  "profitAmount": 0
}

Contained in Schemas

CostProfitReportDto The Cost & Profit report: what tracked time cost the practice over a period, what the billable porti...