API Documentation
Reports ¶
/reports endpoints are routes that support multigrouping.
For each report, there are listed supported group parameters. Available filters are the same as for the source object (task report has all the filters available for tasks). All reports endpoints support filter operations.
Example for passing a group param: /reports/task_reports?group=organization,task.
All /reports endpoints support grouping by date period. Available date periods for grouping are: year, quarter, month, week and day. Grouping by date period can be done like this: reports/task_reports?group=organization,created_at:month,task. For each report endpoint, there is a list of supported dates which can be used for grouping by date period.
Booking Reports ¶
Supported group params
-
booking
-
person
-
service
-
event
-
service_type
-
pricing_type_id
-
budget
-
project
-
responsible
-
company
-
project_type
-
organization
-
people_custom_fields
Supported date period dates
- date
GET /api/v2/reports/booking_reports
Requests
GET /api/v2/reports/booking_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "booking-report-booking-61-d41d8cd98f00b204e9800998ecf8427e",
"type": "new_booking_reports",
"attributes": {
"group": "booking",
"count": 1,
"time": 640,
"start_date": "2020-08-11",
"end_date": "2020-08-11",
"pricing_type_id": null,
"project_type": null,
"total_recognized_time": null,
"average_recognized_margin": null,
"people_custom_fields": {},
"formula_fields": {},
"date_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"average_blended_rate": null,
"average_blended_rate_default": null,
"average_blended_rate_normalized": null,
"total_recognized_revenue": null,
"total_recognized_revenue_default": null,
"total_recognized_revenue_normalized": null,
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_recognized_profit": null,
"total_recognized_profit_default": null,
"total_recognized_profit_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"booking": {
"data": {
"type": "bookings",
"id": "61"
}
},
"person": {
"data": null
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"event": {
"data": null
},
"budget": {
"data": null
},
"project": {
"data": null
},
"company": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "61",
"type": "bookings",
"attributes": {
"hours": 6,
"time": 360,
"started_on": "2020-08-11",
"ended_on": "2020-08-11",
"note": null,
"total_hours": 0,
"total_time": 0,
"percentage": null,
"created_at": "2020-08-11T01:05:23.118+02:00",
"updated_at": "2020-08-11T01:05:23.118+02:00",
"people_custom_fields": null,
"approved": true,
"approved_at": "2020-08-11T01:05:23.118+02:00",
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"booking_method_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"service": {
"data": {
"type": "services",
"id": "19"
}
},
"event": {
"data": null
},
"person": {
"data": {
"type": "people",
"id": "1260"
}
},
"creator": {
"data": {
"type": "people",
"id": "1257"
}
},
"updater": {
"data": {
"type": "people",
"id": "1257"
}
},
"approver": {
"data": {
"type": "people",
"id": "1257"
}
},
"rejecter": {
"data": null
},
"origin": {
"data": null
}
}
},
{
"id": "19",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"pricing_type_id": 1,
"worked_time": 0,
"unapproved_time": 0,
"billable_time": 0,
"estimated_time": null,
"booked_time": 0,
"budgeted_time": 0,
"profit_margin": 100,
"unit_id": 2,
"quantity": "1.0",
"discount": null,
"future_booked_time": 0,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null,
"price": 100000,
"price_default": 125000,
"price_normalized": 100000,
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"discount_amount": 0,
"discount_amount_default": 0,
"discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "75"
}
},
"deal": {
"data": {
"type": "deals",
"id": "126"
}
}
}
},
{
"id": "1260",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1218@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:23.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:23.083+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"company": {
"data": {
"type": "companies",
"id": "1691"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1257",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1215@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:23.000+02:00",
"last_seen_at": "2020-08-11T01:05:23.460+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:22.895+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"company": {
"data": {
"type": "companies",
"id": "1687"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "75",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
}
}
},
{
"id": "126",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-08-11",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 100,
"discount": null,
"email_key": "779458ab4415292935feded4794c43bc",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 200,
"forecasted_time_usage": 0,
"budget_usage": 100,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-08-11T01:05:23.020+02:00",
"note": null,
"sales_closed_at": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"services_revenue": 100000,
"services_revenue_default": 125000,
"services_revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 100000,
"pending_invoicing_default": 125000,
"pending_invoicing_normalized": 100000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 100000,
"forecasted_revenue_default": 125000,
"forecasted_revenue_normalized": 100000,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 100000,
"forecasted_profit_default": 125000,
"forecasted_profit_normalized": 100000,
"forecasted_budget_used": 200000,
"forecasted_budget_used_default": 250000,
"forecasted_budget_used_normalized": 200000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"creator": {
"data": {
"type": "people",
"id": "1257"
}
},
"company": {
"data": {
"type": "companies",
"id": "1689"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1259"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "2770"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1691",
"type": "companies",
"attributes": {
"name": "Client1152",
"default_currency": null,
"created_at": "2020-08-11T01:05:23.077+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1687",
"type": "companies",
"attributes": {
"name": "Organization540",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:22.893+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1689",
"type": "companies",
"attributes": {
"name": "Client1150",
"default_currency": null,
"created_at": "2020-08-11T01:05:22.952+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1259",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1217@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:22.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:22.985+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"company": {
"data": {
"type": "companies",
"id": "1690"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2770",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
}
}
},
{
"id": "1690",
"type": "companies",
"attributes": {
"name": "Client1151",
"default_currency": null,
"created_at": "2020-08-11T01:05:22.979+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 540
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/booking_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/booking_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get booking reportsGET/api/v2/reports/booking_reports
Budget Reports ¶
Supported group params
-
budget
-
company
-
responsible
-
subsidiary
-
contract
-
project
-
status
-
project_type
-
organization
-
recurring
-
custom_fields
Supported date period dates
-
date
-
created_at
-
closed_at
-
end_date
-
last_activity_at
-
delivered_on
GET /api/v2/reports/budget_reports
Requests
GET /api/v2/reports/budget_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "budget-report-budget-128-d41d8cd98f00b204e9800998ecf8427e",
"type": "budget_reports",
"attributes": {
"group": "budget",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"status": null,
"project_type": null,
"total_worked_time": 0,
"total_billable_time": 0,
"total_estimated_time": 0,
"total_budgeted_time": 0,
"total_estimated_remaining_time": 0,
"total_unapproved_time": 0,
"total_future_booked_time": 0,
"total_forecasted_billable_time": 0,
"average_forecasted_margin": null,
"average_forecasted_budget_usage": null,
"average_forecasted_time_usage": null,
"average_profit_margin": null,
"average_budget_usage": null,
"average_forecasted_budget_overrun": null,
"recurring": false,
"custom_fields": {},
"formula_fields": {},
"date_period": null,
"created_at_period": null,
"closed_at_period": null,
"end_date_period": null,
"last_activity_at_period": null,
"delivered_on_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_revenue": 0,
"total_revenue_default": 0,
"total_revenue_normalized": 0,
"total_services_revenue": 0,
"total_services_revenue_default": 0,
"total_services_revenue_normalized": 0,
"total_work_cost": 0,
"total_work_cost_default": 0,
"total_work_cost_normalized": 0,
"total_expense": 0,
"total_expense_default": 0,
"total_expense_normalized": 0,
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_profit": 0,
"total_profit_default": 0,
"total_profit_normalized": 0,
"total_budget_total": 0,
"total_budget_total_default": 0,
"total_budget_total_normalized": 0,
"total_budget_used": 0,
"total_budget_used_default": 0,
"total_budget_used_normalized": 0,
"total_budget_remaining": 0,
"total_budget_remaining_default": 0,
"total_budget_remaining_normalized": 0,
"total_invoiced": 0,
"total_invoiced_default": 0,
"total_invoiced_normalized": 0,
"total_pending_invoicing": 0,
"total_pending_invoicing_default": 0,
"total_pending_invoicing_normalized": 0,
"average_actual_rate": null,
"average_actual_rate_default": null,
"average_actual_rate_normalized": null,
"average_invoiced_rate": null,
"average_invoiced_rate_default": null,
"average_invoiced_rate_normalized": null,
"total_future_revenue": 0,
"total_future_revenue_default": 0,
"total_future_revenue_normalized": 0,
"total_future_budget_used": 0,
"total_future_budget_used_default": 0,
"total_future_budget_used_normalized": 0,
"total_future_cost": 0,
"total_future_cost_default": 0,
"total_future_cost_normalized": 0,
"total_forecasted_revenue": 0,
"total_forecasted_revenue_default": 0,
"total_forecasted_revenue_normalized": 0,
"total_forecasted_cost": 0,
"total_forecasted_cost_default": 0,
"total_forecasted_cost_normalized": 0,
"total_forecasted_profit": 0,
"total_forecasted_profit_default": 0,
"total_forecasted_profit_normalized": 0,
"total_forecasted_budget_used": 0,
"total_forecasted_budget_used_default": 0,
"total_forecasted_budget_used_normalized": 0,
"total_expense_billable": 0,
"total_expense_billable_default": 0,
"total_expense_billable_normalized": 0,
"total_forecasted_budget_overrun": 0,
"total_forecasted_budget_overrun_default": 0,
"total_forecasted_budget_overrun_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"budget": {
"data": {
"type": "deals",
"id": "128"
}
},
"contract": {
"data": null
},
"project": {
"data": null
},
"company": {
"data": null
},
"responsible": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "128",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-08-11",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": false,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "43df04f70b67e21b27908eff86f1f9a9",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"future_booked_time": 0,
"probability": 100,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-08-11T01:05:23.855+02:00",
"note": null,
"sales_closed_at": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"creator": {
"data": {
"type": "people",
"id": "1264"
}
},
"company": {
"data": {
"type": "companies",
"id": "1697"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1265"
}
},
"deal_status": {
"meta": {
"included": false
}
},
"project": {
"data": {
"type": "projects",
"id": "266"
}
},
"lost_reason": {
"meta": {
"included": false
}
},
"contract": {
"data": null
},
"contact": {
"meta": {
"included": false
}
}
}
},
{
"id": "1264",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1222@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:23.000+02:00",
"last_seen_at": "2020-08-11T01:05:23.889+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:23.660+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"company": {
"data": {
"type": "companies",
"id": "1696"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1697",
"type": "companies",
"attributes": {
"name": "Client1157",
"default_currency": null,
"created_at": "2020-08-11T01:05:23.736+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1265",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1223@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:23.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:23.750+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"company": {
"data": {
"type": "companies",
"id": "1698"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "266",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"company": {
"data": {
"type": "companies",
"id": "1700"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1266"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1696",
"type": "companies",
"attributes": {
"name": "Organization541",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:23.658+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1698",
"type": "companies",
"attributes": {
"name": "Client1158",
"default_currency": null,
"created_at": "2020-08-11T01:05:23.745+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1700",
"type": "companies",
"attributes": {
"name": "Client1160",
"default_currency": null,
"created_at": "2020-08-11T01:05:23.813+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1266",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1224@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:23.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:23.787+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"company": {
"data": {
"type": "companies",
"id": "1699"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1699",
"type": "companies",
"attributes": {
"name": "Client1159",
"default_currency": null,
"created_at": "2020-08-11T01:05:23.782+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 541
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/budget_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/budget_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get budget reportsGET/api/v2/reports/budget_reports
Company Reports ¶
Supported group params
-
company, key: :company_id
-
status
-
organization
-
custom_fields
Supported date period dates
- created_at
GET /api/v2/reports/company_reports
Requests
GET /api/v2/reports/company_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "company-report-company-1701-d41d8cd98f00b204e9800998ecf8427e",
"type": "company_reports",
"attributes": {
"group": "company",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"status": null,
"custom_fields": {},
"created_at_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 542
}
},
"company": {
"data": {
"type": "companies",
"id": "1701"
}
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "1701",
"type": "companies",
"attributes": {
"name": "Organization542",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:24.138+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 542
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/company_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/company_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get company reportsGET/api/v2/reports/company_reports
Deal Reports ¶
Supported group params
-
deal
-
company
-
responsible
-
subsidiary
-
sales_status_id
-
deal_status
-
lost_reason
-
organization
-
custom_fields
-
contact
Supported date period dates
-
date
-
created_at
-
last_activity_at
-
sales_status_updated_at
-
sales_closed_at
GET /api/v2/reports/deal_reports
Requests
GET /api/v2/reports/deal_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "deal-report-deal-129-d41d8cd98f00b204e9800998ecf8427e",
"type": "deal_reports",
"attributes": {
"group": "deal",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"sales_status_id": null,
"total_worked_time": 0,
"total_billable_time": 0,
"total_estimated_time": 0,
"total_budgeted_time": 0,
"total_estimated_remaining_time": 0,
"custom_fields": {},
"formula_fields": {},
"date_period": null,
"created_at_period": null,
"last_activity_at_period": null,
"sales_closed_at_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_revenue": 0,
"total_revenue_default": 0,
"total_revenue_normalized": 0,
"total_services_revenue": 0,
"total_services_revenue_default": 0,
"total_services_revenue_normalized": 0,
"total_projected_revenue": 0,
"total_projected_revenue_default": 0,
"total_projected_revenue_normalized": 0,
"total_work_cost": 0,
"total_work_cost_default": 0,
"total_work_cost_normalized": 0,
"total_expense": 0,
"total_expense_default": 0,
"total_expense_normalized": 0,
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_profit": 0,
"total_profit_default": 0,
"total_profit_normalized": 0,
"total_budget_total": 0,
"total_budget_total_default": 0,
"total_budget_total_normalized": 0,
"total_budget_used": 0,
"total_budget_used_default": 0,
"total_budget_used_normalized": 0,
"total_invoiced": 0,
"total_invoiced_default": 0,
"total_invoiced_normalized": 0,
"total_pending_invoicing": 0,
"total_pending_invoicing_default": 0,
"total_pending_invoicing_normalized": 0,
"average_actual_rate": 0,
"average_actual_rate_default": 0,
"average_actual_rate_normalized": 0,
"average_rate": 0,
"average_rate_default": 0,
"average_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 543
}
},
"deal": {
"data": {
"type": "deals",
"id": "129"
}
},
"company": {
"data": null
},
"responsible": {
"data": null
},
"subsidiary": {
"data": null
},
"deal_status": {
"data": null
},
"lost_reason": {
"data": null
},
"contact": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "129",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-08-11",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "761ddb7c978769e5c0257c37b6bae752",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-08-11T01:05:24.351+02:00",
"note": null,
"sales_closed_at": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 543
}
},
"creator": {
"data": {
"type": "people",
"id": "1268"
}
},
"company": {
"data": {
"type": "companies",
"id": "1703"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1269"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "2787"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1268",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1226@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:24.000+02:00",
"last_seen_at": "2020-08-11T01:05:24.378+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:24.276+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 543
}
},
"company": {
"data": {
"type": "companies",
"id": "1702"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1703",
"type": "companies",
"attributes": {
"name": "Client1161",
"default_currency": null,
"created_at": "2020-08-11T01:05:24.298+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 543
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1269",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1227@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:24.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:24.313+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 543
}
},
"company": {
"data": {
"type": "companies",
"id": "1704"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2787",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 543
}
}
}
},
{
"id": "1702",
"type": "companies",
"attributes": {
"name": "Organization543",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:24.275+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 543
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1704",
"type": "companies",
"attributes": {
"name": "Client1162",
"default_currency": null,
"created_at": "2020-08-11T01:05:24.307+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 543
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/deal_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/deal_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get deal reportsGET/api/v2/reports/deal_reports
Expense Reports ¶
Supported group params
-
expense
-
deal
-
service_type
-
project
-
company
-
person
-
responsible
-
status
-
invoiced
-
approval_status
-
reimbursement
-
organization
-
vendor
Supported date period dates
-
date
-
pay_on
-
paid_on
GET /api/v2/reports/expense_reports
Requests
GET /api/v2/reports/expense_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "expense-report-expense-42-d41d8cd98f00b204e9800998ecf8427e",
"type": "expense_reports",
"attributes": {
"group": "expense",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"status": null,
"quote_type": null,
"invoiced": false,
"approval_status": null,
"average_profit_margin": null,
"reimbursement": null,
"date_period": null,
"pay_on_period": null,
"paid_on_period": null,
"formula_fields": {},
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_amount": 12500,
"total_amount_default": 12500,
"total_amount_normalized": 12500,
"total_profit": -12500,
"total_profit_default": -12500,
"total_profit_normalized": -12500,
"total_billable_amount": 0,
"total_billable_amount_default": 0,
"total_billable_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
},
"expense": {
"data": {
"type": "expenses",
"id": "42"
}
},
"deal": {
"data": null
},
"project": {
"data": null
},
"company": {
"data": null
},
"service_type": {
"data": null
},
"vendor": {
"data": null
},
"person": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "42",
"type": "expenses",
"attributes": {
"name": "test name",
"date": "2020-08-11",
"pay_on": null,
"paid_on": null,
"position": 1,
"invoiced": false,
"approved": false,
"approved_at": null,
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"deleted_at": null,
"reimbursable": null,
"reimbursed_on": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000,
"billable_amount": 0,
"billable_amount_default": 0,
"billable_amount_normalized": 0,
"profit": -10000,
"profit_default": -12500,
"profit_normalized": -10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
},
"deal": {
"data": {
"type": "deals",
"id": "130"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "77"
}
},
"person": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "1270"
}
},
"approver": {
"data": null
},
"rejecter": {
"data": null
},
"vendor": {
"data": null
},
"attachment": {
"data": null
}
}
},
{
"id": "130",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-08-11",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "2c28616a7b9eec05b7a1952dd1e73f20",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-08-11T01:05:24.617+02:00",
"note": null,
"sales_closed_at": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 10000,
"cost_default": 12500,
"cost_normalized": 10000,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": -10000,
"profit_default": -12500,
"profit_normalized": -10000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 10000,
"expense_default": 12500,
"expense_normalized": 10000,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 10000,
"forecasted_cost_default": 12500,
"forecasted_cost_normalized": 10000,
"forecasted_profit": -10000,
"forecasted_profit_default": -12500,
"forecasted_profit_normalized": -10000,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
},
"creator": {
"data": {
"type": "people",
"id": "1270"
}
},
"company": {
"data": {
"type": "companies",
"id": "1706"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1271"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "2793"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "77",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
}
}
},
{
"id": "1270",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1228@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:24.000+02:00",
"last_seen_at": "2020-08-11T01:05:24.665+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:24.547+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
},
"company": {
"data": {
"type": "companies",
"id": "1705"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1706",
"type": "companies",
"attributes": {
"name": "Client1163",
"default_currency": null,
"created_at": "2020-08-11T01:05:24.569+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1271",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1229@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:24.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:24.583+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
},
"company": {
"data": {
"type": "companies",
"id": "1707"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2793",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
}
}
},
{
"id": "1705",
"type": "companies",
"attributes": {
"name": "Organization544",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:24.545+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1707",
"type": "companies",
"attributes": {
"name": "Client1164",
"default_currency": null,
"created_at": "2020-08-11T01:05:24.578+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 544
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/expense_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/expense_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get expense reportsGET/api/v2/reports/expense_reports
Finanacial Item Reports ¶
Supported group params
-
financial_item
-
person
-
service
-
service_type
-
budget
-
project
-
company
-
pricing_type
-
project_type
-
future
-
organization
Supported date period dates
- date
GET /api/v2/reports/financial_item_reports
Requests
GET /api/v2/reports/financial_item_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "financial-item-report-financial_item-time_entry-3-d41d8cd98f00b204e9800998ecf8427e",
"type": "financial_item_reports",
"attributes": {
"group": "financial_item",
"financial_item_id": 3,
"financial_item_type": "time_entry",
"total_time": 480,
"total_billable_time": 480,
"total_recognized_time": null,
"pricing_type_id": null,
"project_type_id": null,
"average_profit_margin": null,
"future": null,
"approval_status": null,
"date_period": null,
"formula_fields": {},
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_revenue": null,
"total_revenue_default": null,
"total_revenue_normalized": null,
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_profit": null,
"total_profit_default": null,
"total_profit_normalized": null,
"average_blended_rate": null,
"average_blended_rate_default": null,
"average_blended_rate_normalized": null,
"total_budget_used": 0,
"total_budget_used_default": 0,
"total_budget_used_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"person": {
"data": null
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"company": {
"data": null
},
"project": {
"data": null
},
"time_entry": {
"data": {
"type": "time_entries",
"id": "3"
}
},
"booking_item": {
"data": null
},
"expense": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "3",
"type": "time_entries",
"attributes": {
"date": "2020-08-11",
"created_at": "2020-08-11T01:05:25.036+02:00",
"time": 480,
"billable_time": 480,
"note": "test note",
"track_method_id": 1,
"tracking_type_id": null,
"started_at": null,
"timer_started_at": null,
"approved": false,
"approved_at": null,
"updated_at": "2020-08-11T01:05:25.036+02:00",
"invoiced": false,
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"overhead_cost": 0,
"overhead_cost_default": 0,
"overhead_cost_normalized": 0,
"internal_overhead_cost": 0,
"internal_overhead_cost_default": 0,
"internal_overhead_cost_normalized": 0,
"facility_overhead_cost": 0,
"facility_overhead_cost_default": 0,
"facility_overhead_cost_normalized": 0,
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"person": {
"data": {
"type": "people",
"id": "1273"
}
},
"service": {
"data": {
"type": "services",
"id": "21"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "1272"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "1273",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1231@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:24.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:24.878+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"company": {
"data": {
"type": "companies",
"id": "1709"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "21",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"pricing_type_id": 1,
"worked_time": 480,
"unapproved_time": 480,
"billable_time": 0,
"estimated_time": null,
"booked_time": 0,
"budgeted_time": 0,
"profit_margin": 100,
"unit_id": 2,
"quantity": "1.0",
"discount": null,
"future_booked_time": 0,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null,
"price": 100000,
"price_default": 125000,
"price_normalized": 100000,
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"discount_amount": 0,
"discount_amount_default": 0,
"discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "78"
}
},
"deal": {
"data": {
"type": "deals",
"id": "131"
}
}
}
},
{
"id": "1272",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1230@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:25.000+02:00",
"last_seen_at": "2020-08-11T01:05:25.105+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:24.845+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"company": {
"data": {
"type": "companies",
"id": "1708"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1709",
"type": "companies",
"attributes": {
"name": "Client1165",
"default_currency": null,
"created_at": "2020-08-11T01:05:24.872+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "78",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
}
}
},
{
"id": "131",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-08-11",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 100,
"discount": null,
"email_key": "eafb0f67bf167630d2354e581f0576e3",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 200,
"forecasted_time_usage": 0,
"budget_usage": 100,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 480,
"time_to_close": null,
"unapproved_entries_count": 1,
"rejected_entries_count": 0,
"estimated_remaining_time": -480,
"unapproved_time": 480,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-08-11T01:05:24.968+02:00",
"note": null,
"sales_closed_at": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"services_revenue": 100000,
"services_revenue_default": 125000,
"services_revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 100000,
"pending_invoicing_default": 125000,
"pending_invoicing_normalized": 100000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"actual_rate": 12500,
"actual_rate_default": 15625,
"actual_rate_normalized": 12500,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 100000,
"forecasted_revenue_default": 125000,
"forecasted_revenue_normalized": 100000,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 100000,
"forecasted_profit_default": 125000,
"forecasted_profit_normalized": 100000,
"forecasted_budget_used": 200000,
"forecasted_budget_used_default": 250000,
"forecasted_budget_used_normalized": 200000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"creator": {
"data": {
"type": "people",
"id": "1272"
}
},
"company": {
"data": {
"type": "companies",
"id": "1710"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1274"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "2799"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1708",
"type": "companies",
"attributes": {
"name": "Organization545",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:24.843+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1710",
"type": "companies",
"attributes": {
"name": "Client1166",
"default_currency": null,
"created_at": "2020-08-11T01:05:24.909+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1274",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1232@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:24.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:24.926+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"company": {
"data": {
"type": "companies",
"id": "1711"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2799",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
}
}
},
{
"id": "1711",
"type": "companies",
"attributes": {
"name": "Client1167",
"default_currency": null,
"created_at": "2020-08-11T01:05:24.919+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 545
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/financial_item_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/financial_item_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get financial item reportsGET/api/v2/reports/financial_item_reports
Invoice Reports ¶
Supported group params
-
invoice
-
company
-
subsidiary
-
sent_status
-
payment_status
-
overdue_status
-
invoice_aging
-
invoice_status
-
organization
-
custom_fields
Supported date period dates
-
invoiced_on
-
pay_on
-
sent_on
-
delivery_on
-
paid_on
GET /api/v2/reports/invoice_reports
Requests
GET /api/v2/reports/invoice_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "invoice-report-invoice-57-d41d8cd98f00b204e9800998ecf8427e",
"type": "invoice_reports",
"attributes": {
"group": "invoice",
"count": 1,
"sent_status": null,
"payment_status": null,
"overdue_status": null,
"invoice_status": null,
"invoice_aging": null,
"average_due_in": "10.0",
"average_paid_in": null,
"currency_id": null,
"year": null,
"quarter": null,
"month": null,
"week": null,
"custom_fields": {},
"formula_fields": {},
"invoiced_on_period": null,
"pay_on_period": null,
"sent_on_period": null,
"delivery_on_period": null,
"paid_on_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_amount": 0,
"total_amount_default": 0,
"total_amount_normalized": 0,
"total_amount_tax": 0,
"total_amount_tax_default": 0,
"total_amount_tax_normalized": 0,
"total_amount_with_tax": 0,
"total_amount_with_tax_default": 0,
"total_amount_with_tax_normalized": 0,
"total_amount_paid": 0,
"total_amount_paid_default": 0,
"total_amount_paid_normalized": 0,
"total_amount_written_off": 0,
"total_amount_written_off_default": 0,
"total_amount_written_off_normalized": 0,
"total_amount_unpaid": 0,
"total_amount_unpaid_default": 0,
"total_amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 546
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "57"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "57",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2020-08-11",
"sent_on": null,
"pay_on": "2020-08-21",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "89f2d52020f44f3e56e4d04b4ab1477c",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-08-11T01:05:25.467+02:00",
"custom_fields": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 546
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1713"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "12"
}
},
"creator": {
"data": {
"type": "people",
"id": "1275"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "1713",
"type": "companies",
"attributes": {
"name": "Client1168",
"default_currency": null,
"created_at": "2020-08-11T01:05:25.459+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 546
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "12",
"type": "document_types",
"attributes": {
"name": "Standard Document Type",
"tax1_name": "VAT",
"tax1_value": "25.0",
"tax2_name": null,
"tax2_value": null,
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"deleted_at": null,
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 546
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "90"
}
}
}
},
{
"id": "1275",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1233@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:25.000+02:00",
"last_seen_at": "2020-08-11T01:05:25.493+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:25.428+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 546
}
},
"company": {
"data": {
"type": "companies",
"id": "1712"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "90",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary90",
"invoice_number_format": null,
"deleted_at": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 546
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "1712",
"type": "companies",
"attributes": {
"name": "Organization546",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:25.426+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 546
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/invoice_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/invoice_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get invoice reportsGET/api/v2/reports/invoice_reports
Payment Reports ¶
Supported group params
-
payment
-
invoice
-
company
-
subsidiary
-
organization
Supported date period dates
- paid_on
GET /api/v2/reports/payment_reports
Requests
GET /api/v2/reports/payment_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "payment-report-payment-12-d41d8cd98f00b204e9800998ecf8427e",
"type": "payment_reports",
"attributes": {
"group": "payment",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"date_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_amount": 12500,
"total_amount_default": 12500,
"total_amount_normalized": 12500
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 547
}
},
"payment": {
"data": {
"type": "payments",
"id": "12"
}
},
"invoice": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"deal": {
"meta": {
"included": false
}
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "12",
"type": "payments",
"attributes": {
"paid_on": "2020-08-11",
"written_off_on": null,
"note": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 547
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "58"
}
}
}
},
{
"id": "58",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2020-08-11",
"sent_on": null,
"pay_on": "2020-08-21",
"delivery_on": null,
"paid_on": "2020-08-11",
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "b2e209847e8a16fef86ecc5443a8f87a",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-08-11T01:05:25.807+02:00",
"custom_fields": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 10000,
"amount_paid_default": 12500,
"amount_paid_normalized": 10000,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": -10000,
"amount_unpaid_default": -12500,
"amount_unpaid_normalized": -10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 547
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1715"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "13"
}
},
"creator": {
"data": {
"type": "people",
"id": "1276"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "1715",
"type": "companies",
"attributes": {
"name": "Client1169",
"default_currency": null,
"created_at": "2020-08-11T01:05:25.794+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 547
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "13",
"type": "document_types",
"attributes": {
"name": "Standard Document Type",
"tax1_name": "VAT",
"tax1_value": "25.0",
"tax2_name": null,
"tax2_value": null,
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"deleted_at": null,
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 547
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "91"
}
}
}
},
{
"id": "1276",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1234@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:25.000+02:00",
"last_seen_at": "2020-08-11T01:05:25.863+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:25.744+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 547
}
},
"company": {
"data": {
"type": "companies",
"id": "1714"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "91",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary91",
"invoice_number_format": null,
"deleted_at": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 547
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "1714",
"type": "companies",
"attributes": {
"name": "Organization547",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:25.740+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 547
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/payment_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/payment_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get payment reportsGET/api/v2/reports/payment_reports
Person Reports ¶
Supported group params
-
person
-
company
-
subsidiary
-
role_id
-
type
-
status
-
organization
-
custom_fields
Supported date period dates
-
created_at
-
joined_at
GET /api/v2/reports/person_reports
Requests
GET /api/v2/reports/person_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "person-report-person-1277-d41d8cd98f00b204e9800998ecf8427e",
"type": "person_reports",
"attributes": {
"group": "person",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"role_id": null,
"status": null,
"type": null,
"custom_fields": {},
"created_at_period": null,
"joined_at_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 548
}
},
"person": {
"data": {
"type": "people",
"id": "1277"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "1277",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1235@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:26.000+02:00",
"last_seen_at": "2020-08-11T01:05:26.166+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:26.117+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 548
}
},
"company": {
"data": {
"type": "companies",
"id": "1716"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1716",
"type": "companies",
"attributes": {
"name": "Organization548",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:26.114+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 548
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/person_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/person_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get person reportsGET/api/v2/reports/person_reports
Project Reports ¶
Supported group params
-
project
-
company
-
project_manager
-
project_status
-
project_type
-
public_access
-
organization
-
custom_fields
Supported date period dates
-
created_at
-
last_activity_at
GET /api/v2/reports/project_reports
Requests
GET /api/v2/reports/project_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "project-report-project-267-d41d8cd98f00b204e9800998ecf8427e",
"type": "project_reports",
"attributes": {
"group": "project",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"project_status": null,
"project_type": null,
"public_access": null,
"total_worked_time": null,
"total_estimated_time": null,
"average_profit_margin": null,
"custom_fields": {},
"formula_fields": {},
"created_at_period": null,
"last_activity_at_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_revenue": null,
"total_revenue_default": null,
"total_revenue_normalized": null,
"total_cost": null,
"total_cost_default": null,
"total_cost_normalized": null,
"total_profit": null,
"total_profit_default": null,
"total_profit_normalized": null,
"total_pending_invoicing": null,
"total_pending_invoicing_default": null,
"total_pending_invoicing_normalized": null,
"total_needs_invoicing": 0,
"total_needs_invoicing_default": 0,
"total_needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 549
}
},
"project": {
"data": {
"type": "projects",
"id": "267"
}
},
"company": {
"data": null
},
"project_manager": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "267",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 549
}
},
"company": {
"data": {
"type": "companies",
"id": "1719"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1279"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1719",
"type": "companies",
"attributes": {
"name": "Client1171",
"default_currency": null,
"created_at": "2020-08-11T01:05:26.470+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 549
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1279",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1237@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:26.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:26.443+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 549
}
},
"company": {
"data": {
"type": "companies",
"id": "1718"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1718",
"type": "companies",
"attributes": {
"name": "Client1170",
"default_currency": null,
"created_at": "2020-08-11T01:05:26.437+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 549
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/project_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/project_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get project reportsGET/api/v2/reports/project_reports
Service Reports ¶
Supported group params
-
service
-
budget
-
service_type
-
company
-
responsible
-
subsidiary
-
project
-
budget_status
-
project_type
-
organization
-
recurring
-
budget_custom_fields
-
pricing_type
-
billable
Supported date period dates
- date
GET /api/v2/reports/service_reports
Requests
GET /api/v2/reports/service_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "service-report-service-22-d41d8cd98f00b204e9800998ecf8427e",
"type": "service_reports",
"attributes": {
"group": "service",
"count": 1,
"budget_status": null,
"project_type": null,
"pricing_type": null,
"billable": null,
"total_booked_time": 0,
"total_worked_time": 0,
"total_billable_time": 0,
"total_estimated_time": null,
"total_budgeted_time": 0,
"total_estimated_remaining_time": null,
"total_unapproved_time": 0,
"total_future_booked_time": 0,
"total_forecasted_billable_time": 0,
"average_forecasted_margin": "100.0",
"average_forecasted_budget_usage": "200.0",
"average_forecasted_time_usage": null,
"average_profit_margin": "100.0",
"average_budget_usage": "100.0",
"average_discount": null,
"recurring": false,
"budget_custom_fields": {},
"formula_fields": {},
"date_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_revenue": 125000,
"total_revenue_default": 125000,
"total_revenue_normalized": 125000,
"total_price": 100000,
"total_price_default": 100000,
"total_price_normalized": 100000,
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_profit": 125000,
"total_profit_default": 125000,
"total_profit_normalized": 125000,
"total_budget_total": 125000,
"total_budget_total_default": 125000,
"total_budget_total_normalized": 125000,
"total_budget_used": 125000,
"total_budget_used_default": 125000,
"total_budget_used_normalized": 125000,
"total_budget_remaining": 0,
"total_budget_remaining_default": 0,
"total_budget_remaining_normalized": 0,
"average_actual_rate": null,
"average_actual_rate_default": null,
"average_actual_rate_normalized": null,
"average_hourly_rate": null,
"average_hourly_rate_default": null,
"average_hourly_rate_normalized": null,
"total_future_revenue": 0,
"total_future_revenue_default": 0,
"total_future_revenue_normalized": 0,
"total_future_budget_used": 125000,
"total_future_budget_used_default": 125000,
"total_future_budget_used_normalized": 125000,
"total_future_cost": 0,
"total_future_cost_default": 0,
"total_future_cost_normalized": 0,
"total_forecasted_revenue": 125000,
"total_forecasted_revenue_default": 125000,
"total_forecasted_revenue_normalized": 125000,
"total_forecasted_cost": 0,
"total_forecasted_cost_default": 0,
"total_forecasted_cost_normalized": 0,
"total_forecasted_profit": 125000,
"total_forecasted_profit_default": 125000,
"total_forecasted_profit_normalized": 125000,
"total_forecasted_budget_used": 250000,
"total_forecasted_budget_used_default": 250000,
"total_forecasted_budget_used_normalized": 250000,
"total_discount_amount": 0,
"total_discount_amount_default": 0,
"total_discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
},
"service": {
"data": {
"type": "services",
"id": "22"
}
},
"budget": {
"data": null
},
"service_type": {
"data": null
},
"contract": {
"meta": {
"included": false
}
},
"project": {
"data": null
},
"company": {
"data": null
},
"responsible": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "22",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"pricing_type_id": 1,
"worked_time": 0,
"unapproved_time": 0,
"billable_time": 0,
"estimated_time": null,
"booked_time": 0,
"budgeted_time": 0,
"profit_margin": 100,
"unit_id": 2,
"quantity": "1.0",
"discount": null,
"future_booked_time": 0,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null,
"price": 100000,
"price_default": 125000,
"price_normalized": 100000,
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"discount_amount": 0,
"discount_amount_default": 0,
"discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "79"
}
},
"deal": {
"data": {
"type": "deals",
"id": "132"
}
}
}
},
{
"id": "79",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
}
}
},
{
"id": "132",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-08-11",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 100,
"discount": null,
"email_key": "0dc7bbbf5555bef32fffa77f26ee9cf9",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 200,
"forecasted_time_usage": 0,
"budget_usage": 100,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-08-11T01:05:26.698+02:00",
"note": null,
"sales_closed_at": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"services_revenue": 100000,
"services_revenue_default": 125000,
"services_revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 100000,
"pending_invoicing_default": 125000,
"pending_invoicing_normalized": 100000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 100000,
"forecasted_revenue_default": 125000,
"forecasted_revenue_normalized": 100000,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 100000,
"forecasted_profit_default": 125000,
"forecasted_profit_normalized": 100000,
"forecasted_budget_used": 200000,
"forecasted_budget_used_default": 250000,
"forecasted_budget_used_normalized": 200000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
},
"creator": {
"data": {
"type": "people",
"id": "1280"
}
},
"company": {
"data": {
"type": "companies",
"id": "1721"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1281"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "2825"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1280",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1238@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:26.000+02:00",
"last_seen_at": "2020-08-11T01:05:26.749+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:26.635+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
},
"company": {
"data": {
"type": "companies",
"id": "1720"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1721",
"type": "companies",
"attributes": {
"name": "Client1172",
"default_currency": null,
"created_at": "2020-08-11T01:05:26.654+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1281",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1239@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:26.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:26.667+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
},
"company": {
"data": {
"type": "companies",
"id": "1722"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2825",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
}
}
},
{
"id": "1720",
"type": "companies",
"attributes": {
"name": "Organization550",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:26.633+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1722",
"type": "companies",
"attributes": {
"name": "Client1173",
"default_currency": null,
"created_at": "2020-08-11T01:05:26.662+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 550
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/service_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/service_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get service reportsGET/api/v2/reports/service_reports
Task Reports ¶
Supported group params
-
task
-
project
-
task_list
-
board
-
assignee
-
creator
-
last_actor
-
company
-
status
-
organization
-
custom_fields
Supported date period dates
-
created_at
-
closed_at
-
last_activity_at
-
due_date
-
start_date
GET /api/v2/reports/task_reports
Requests
GET /api/v2/reports/task_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "task-report-task-58-d41d8cd98f00b204e9800998ecf8427e",
"type": "task_reports",
"attributes": {
"group": "task",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"status": null,
"total_worked_time": null,
"total_initial_estimate": null,
"total_remaining_time": null,
"total_estimation_offset_time": null,
"custom_fields": {},
"formula_fields": {},
"created_at_period": null,
"closed_at_period": null,
"last_activity_at_period": null,
"due_date_period": null,
"start_date_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"task": {
"data": {
"type": "tasks",
"id": "58"
}
},
"project": {
"data": null
},
"task_list": {
"data": null
},
"board": {
"data": null
},
"assignee": {
"data": null
},
"creator": {
"data": null
},
"last_actor": {
"data": null
},
"company": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "58",
"type": "tasks",
"attributes": {
"title": "Ticket title",
"description": null,
"number": 1,
"private": false,
"due_date": null,
"start_date": null,
"closed_at": null,
"created_at": "2020-08-11T01:05:27.137+02:00",
"repeat_schedule_id": null,
"repeat_on_interval": null,
"repeat_on_monthday": null,
"repeat_on_weekday": [],
"repeat_on_date": null,
"repeat_origin_id": null,
"email_key": "6016adc0d64772b0194ffc3bc8fafe77",
"custom_fields": null,
"todo_count": null,
"open_todo_count": null,
"todo_assignee_count": null,
"creation_method_id": 1,
"closed": false,
"due_time": null,
"tag_list": [],
"position": 1,
"last_activity_at": null,
"initial_estimate": null,
"remaining_time": null,
"worked_time": null,
"deleted_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"project": {
"data": {
"type": "projects",
"id": "268"
}
},
"creator": {
"data": {
"type": "people",
"id": "1284"
}
},
"assignee": {
"data": null
},
"last_actor": {
"data": null
},
"task_list": {
"data": {
"type": "task_lists",
"id": "53"
}
},
"attachments": {
"data": []
}
}
},
{
"id": "268",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"company": {
"data": {
"type": "companies",
"id": "1725"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1283"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1284",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1242@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:26.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:26.988+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"company": {
"data": {
"type": "companies",
"id": "1726"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "53",
"type": "task_lists",
"attributes": {
"name": "Milestone51",
"position": 1,
"archived_at": null,
"email_key": "805c107aab70086a31c550bcae74ff32"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"project": {
"data": {
"type": "projects",
"id": "269"
}
},
"board": {
"data": {
"type": "boards",
"id": "66"
}
}
}
},
{
"id": "1725",
"type": "companies",
"attributes": {
"name": "Client1175",
"default_currency": null,
"created_at": "2020-08-11T01:05:26.960+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1283",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1241@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:26.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:26.940+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"company": {
"data": {
"type": "companies",
"id": "1724"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1726",
"type": "companies",
"attributes": {
"name": "Client1176",
"default_currency": null,
"created_at": "2020-08-11T01:05:26.984+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "269",
"type": "projects",
"attributes": {
"name": "test project",
"number": 2,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"company": {
"data": {
"type": "companies",
"id": "1728"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1285"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "66",
"type": "boards",
"attributes": {
"name": "Board52",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"project": {
"data": {
"type": "projects",
"id": "270"
}
}
}
},
{
"id": "1724",
"type": "companies",
"attributes": {
"name": "Client1174",
"default_currency": null,
"created_at": "2020-08-11T01:05:26.935+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1728",
"type": "companies",
"attributes": {
"name": "Client1178",
"default_currency": null,
"created_at": "2020-08-11T01:05:27.034+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1285",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1243@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:27.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:27.016+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"company": {
"data": {
"type": "companies",
"id": "1727"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "270",
"type": "projects",
"attributes": {
"name": "test project",
"number": 3,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"board_count": 1,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"company": {
"data": {
"type": "companies",
"id": "1730"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1286"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1727",
"type": "companies",
"attributes": {
"name": "Client1177",
"default_currency": null,
"created_at": "2020-08-11T01:05:27.011+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1730",
"type": "companies",
"attributes": {
"name": "Client1180",
"default_currency": null,
"created_at": "2020-08-11T01:05:27.081+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1286",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1244@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:27.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:27.062+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"company": {
"data": {
"type": "companies",
"id": "1729"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1729",
"type": "companies",
"attributes": {
"name": "Client1179",
"default_currency": null,
"created_at": "2020-08-11T01:05:27.058+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 551
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/task_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/task_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get task reportsGET/api/v2/reports/task_reports
Time Entry Reports ¶
Supported group params
-
time_entry
-
person
-
task
-
service
-
service_type
-
pricing_type_id
-
budget
-
project
-
responsible
-
company
-
status
-
invoiced
-
organization
-
people_custom_fields
-
project_type_id
Supported date period dates
-
date
-
created_at
GET /api/v2/reports/time_entry_reports
Requests
GET /api/v2/reports/time_entry_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "time-entry-report-time_entry-4-d41d8cd98f00b204e9800998ecf8427e",
"type": "time_entry_reports",
"attributes": {
"group": "time_entry",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"day": null,
"status": null,
"jira_issue_id": null,
"invoiced": false,
"total_time": 480,
"total_billable_time": 480,
"total_recognized_time": null,
"pricing_type_id": null,
"unit_id": null,
"project_type_id": null,
"average_recognized_margin": null,
"people_custom_fields": {},
"formula_fields": {},
"date_period": null,
"created_at_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_work_cost": 0,
"total_work_cost_default": 0,
"total_work_cost_normalized": 0,
"total_overhead_cost": 0,
"total_overhead_cost_default": 0,
"total_overhead_cost_normalized": 0,
"total_internal_overhead_cost": 0,
"total_internal_overhead_cost_default": 0,
"total_internal_overhead_cost_normalized": 0,
"total_facility_overhead_cost": 0,
"total_facility_overhead_cost_default": 0,
"total_facility_overhead_cost_normalized": 0,
"total_revenue": 0,
"total_revenue_default": 0,
"total_revenue_normalized": 0,
"total_profit": 0,
"total_profit_default": 0,
"total_profit_normalized": 0,
"average_blended_rate": null,
"average_blended_rate_default": null,
"average_blended_rate_normalized": null,
"total_recognized_revenue": null,
"total_recognized_revenue_default": null,
"total_recognized_revenue_normalized": null,
"total_recognized_profit": null,
"total_recognized_profit_default": null,
"total_recognized_profit_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"time_entry": {
"data": {
"type": "time_entries",
"id": "4"
}
},
"person": {
"data": null
},
"task": {
"data": null
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"project": {
"data": null
},
"responsible": {
"data": null
},
"company": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "4",
"type": "time_entries",
"attributes": {
"date": "2020-08-11",
"created_at": "2020-08-11T01:05:27.477+02:00",
"time": 480,
"billable_time": 480,
"note": "test note",
"track_method_id": 1,
"tracking_type_id": null,
"started_at": null,
"timer_started_at": null,
"approved": false,
"approved_at": null,
"updated_at": "2020-08-11T01:05:27.477+02:00",
"invoiced": false,
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"overhead_cost": 0,
"overhead_cost_default": 0,
"overhead_cost_normalized": 0,
"internal_overhead_cost": 0,
"internal_overhead_cost_default": 0,
"internal_overhead_cost_normalized": 0,
"facility_overhead_cost": 0,
"facility_overhead_cost_default": 0,
"facility_overhead_cost_normalized": 0,
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"person": {
"data": {
"type": "people",
"id": "1289"
}
},
"service": {
"data": {
"type": "services",
"id": "23"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "1288"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "1289",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1247@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:27.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:27.383+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"company": {
"data": {
"type": "companies",
"id": "1733"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "23",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"pricing_type_id": 1,
"worked_time": 480,
"unapproved_time": 480,
"billable_time": 0,
"estimated_time": null,
"booked_time": 0,
"budgeted_time": 0,
"profit_margin": 100,
"unit_id": 2,
"quantity": "1.0",
"discount": null,
"future_booked_time": 0,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null,
"price": 100000,
"price_default": 125000,
"price_normalized": 100000,
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"discount_amount": 0,
"discount_amount_default": 0,
"discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "80"
}
},
"deal": {
"data": {
"type": "deals",
"id": "133"
}
}
}
},
{
"id": "1288",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1246@email.com",
"title": null,
"joined_at": "2020-08-11T01:05:27.000+02:00",
"last_seen_at": "2020-08-11T01:05:27.517+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:27.358+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"company": {
"data": {
"type": "companies",
"id": "1732"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1733",
"type": "companies",
"attributes": {
"name": "Client1182",
"default_currency": null,
"created_at": "2020-08-11T01:05:27.378+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "80",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
}
}
},
{
"id": "133",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-08-11",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 100,
"discount": null,
"email_key": "1cd065b5fcaa8ece3043c7a193c14e72",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 200,
"forecasted_time_usage": 0,
"budget_usage": 100,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 480,
"time_to_close": null,
"unapproved_entries_count": 1,
"rejected_entries_count": 0,
"estimated_remaining_time": -480,
"unapproved_time": 480,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-08-11T01:05:27.438+02:00",
"note": null,
"sales_closed_at": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"services_revenue": 100000,
"services_revenue_default": 125000,
"services_revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 100000,
"pending_invoicing_default": 125000,
"pending_invoicing_normalized": 100000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"actual_rate": 12500,
"actual_rate_default": 15625,
"actual_rate_normalized": 12500,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 100000,
"forecasted_revenue_default": 125000,
"forecasted_revenue_normalized": 100000,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 100000,
"forecasted_profit_default": 125000,
"forecasted_profit_normalized": 100000,
"forecasted_budget_used": 200000,
"forecasted_budget_used_default": 250000,
"forecasted_budget_used_normalized": 200000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"creator": {
"data": {
"type": "people",
"id": "1288"
}
},
"company": {
"data": {
"type": "companies",
"id": "1734"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1290"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "2836"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1732",
"type": "companies",
"attributes": {
"name": "Organization552",
"default_currency": "USD",
"created_at": "2020-08-11T01:05:27.356+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1734",
"type": "companies",
"attributes": {
"name": "Client1183",
"default_currency": null,
"created_at": "2020-08-11T01:05:27.402+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1290",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1248@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:27.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:27.412+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"company": {
"data": {
"type": "companies",
"id": "1735"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2836",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"deleted_at": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
}
}
},
{
"id": "1735",
"type": "companies",
"attributes": {
"name": "Client1184",
"default_currency": null,
"created_at": "2020-08-11T01:05:27.409+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 552
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/time_entry_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/time_entry_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get time entry reportsGET/api/v2/reports/time_entry_reports
Time Reports ¶
Supported group params
-
person
-
service
-
service_type
-
budget
-
project
-
company
-
event
-
future
-
organization
-
people_custom_fields
Supported date period dates
- date
GET /api/v2/reports/time_reports
Requests
GET /api/v2/reports/time_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "time-report-person-1292-d41d8cd98f00b204e9800998ecf8427e",
"type": "new_time_reports",
"attributes": {
"group": "person",
"year": null,
"quarter": null,
"month": null,
"week": null,
"day": null,
"count": 1,
"future": null,
"people_custom_fields": {},
"formula_fields": {},
"date_period": null,
"capacity": null,
"available_time": null,
"scheduled_time": 0,
"scheduled_internal_time": 0,
"scheduled_client_time": 0,
"scheduled_event_time": "0.0",
"internal_time": 0,
"client_time": 480,
"billable_time": 0,
"unapproved_time": 480,
"worked_time": 480,
"paid_event_time": 0,
"unpaid_event_time": 0,
"event_time": 0,
"worked_available_diff": null,
"client_worked_ratio": "1.0",
"worked_available_ratio": null,
"worked_scheduled_ratio": null,
"available_capacity_ratio": null,
"billable_available_ratio": null,
"billable_client_ratio": "0.0",
"billable_worked_ratio": "0.0",
"client_available_ratio": null,
"scheduled_available_ratio": null,
"client_scheduled_available_ratio": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 553
}
},
"person": {
"data": {
"type": "people",
"id": "1292"
}
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"company": {
"data": null
},
"project": {
"data": null
},
"event": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "1292",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1250@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-08-11T01:05:27.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-08-11T01:05:27.701+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 553
}
},
"company": {
"data": {
"type": "companies",
"id": "1737"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1737",
"type": "companies",
"attributes": {
"name": "Client1185",
"default_currency": null,
"created_at": "2020-08-11T01:05:27.698+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": []
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 553
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/time_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/time_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
}
}
}
}Get time reportsGET/api/v2/reports/time_reports
Generated by aglio on 10 Aug 2020