Reporting tools
get_profitability
See revenue, cost, billable hours, and non-billable hours for a specified date range, broken down by a filter dimension.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | DateTime | Yes | Start of the date range. |
endDate | DateTime | Yes | End of the date range. |
filterBy | string | Yes | Dimension to group by: container, board, cycle, sku, jobrole, costcenter. |
Returns
A list ofFinanceProfitability entries with revenue, cost, billable/non-billable hours per dimension value.
get_time_code_hours_logged
See hours logged per time code for the specified time period.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | DateTime | Yes | Start of the date range. |
endDate | DateTime | Yes | End of the date range. |
Returns
A list ofFinanceChartData entries with time code and hours.
get_weekly_time_logs
Get total time logged per week, broken down by total, billable, and non-billable hours.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | DateTime | Yes | Start of the date range. |
endDate | DateTime | Yes | End of the date range. |
Returns
A list ofFinanceTimeWeekSummary entries per week.
get_work_estimate_logged
Get the top 100 items where time logged exceeds the work estimate, for the specified date range.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | DateTime | Yes | Start of the date range. |
endDate | DateTime | Yes | End of the date range. |
Returns
A list ofFinanceWorkEstimateTimeLogged entries with item details, estimate, and logged hours.
get_user_hours_summary
Per-user summary showing job role, total hours, billable hours, non-billable hours, and percentages.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | DateTime | Yes | Start of the date range. |
endDate | DateTime | Yes | End of the date range. |
Returns
A list ofFinanceTimeUserSummary entries per user.
get_item_billable_summary
Per-item billable hours, cost, revenue, gross margin, with container and board context.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | DateTime | Yes | Start of the date range. |
endDate | DateTime | Yes | End of the date range. |
Returns
A list ofFinanceBillableItem entries.
Metadata tools
get_job_role_list
Get the list of configured job roles.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofConfigJobRole objects with ID and name.
get_cost_center_list
Get the list of configured cost centers.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofConfigCostCenter objects with ID and name.
get_sku_list
Get the list of stock-keeping units (SKUs).| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofConfigSku objects with ID and name.
get_non_billable_time_code_list
Get the list of non-billable time codes.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofConfigNonBillable objects with ID and name.
get_billable_time_code_list
Get the list of billable time codes, as used when logging time to items.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofDataFieldListData with ID and value.
get_crm_list
Get the list of CRM customer records. Use these IDs for Picker fields withCrm scope.
| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofDataCrm objects with ID and name.