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 filter params
Supported filter params can be found on bookings endpoint
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-73-d41d8cd98f00b204e9800998ecf8427e",
"type": "booking_reports",
"attributes": {
"group": "booking",
"count": 2,
"time": 640,
"mandays": "1.0",
"start_date": "2021-05-06",
"end_date": "2021-05-06",
"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": 721
}
},
"booking": {
"data": {
"type": "bookings",
"id": "73"
}
},
"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": "73",
"type": "bookings",
"attributes": {
"hours": 6,
"time": 360,
"started_on": "2021-05-06",
"ended_on": "2021-05-06",
"note": null,
"total_time": 0,
"total_working_days": 0,
"percentage": null,
"created_at": "2021-05-06T01:09:31.268+02:00",
"updated_at": "2021-05-06T01:09:31.268+02:00",
"people_custom_fields": null,
"approved": true,
"approved_at": "2021-05-06T01:09:31.268+02:00",
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"canceled": false,
"canceled_at": null,
"booking_method_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
},
"service": {
"data": {
"type": "services",
"id": "66"
}
},
"event": {
"data": null
},
"person": {
"data": {
"type": "people",
"id": "1858"
}
},
"creator": {
"data": {
"type": "people",
"id": "1855"
}
},
"updater": {
"data": {
"type": "people",
"id": "1855"
}
},
"approver": {
"data": {
"type": "people",
"id": "1855"
}
},
"rejecter": {
"data": null
},
"canceler": {
"data": null
},
"origin": {
"data": null
}
}
},
{
"id": "66",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"tracking_enabled": true,
"pricing_type_id": 1,
"billing_type_id": null,
"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,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"expense_amount": 0,
"expense_amount_default": 0,
"expense_amount_normalized": 0,
"expense_billable_amount": 0,
"expense_billable_amount_default": 0,
"expense_billable_amount_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"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": 721
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "121"
}
},
"deal": {
"data": {
"type": "deals",
"id": "172"
}
},
"section": {
"data": null
}
}
},
{
"id": "1858",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1806@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:09:31.000+02:00",
"is_user": true,
"user_id": 1846,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:09:31.222+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
},
"company": {
"data": {
"type": "companies",
"id": "2524"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1855",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1803@email.com",
"title": null,
"joined_at": "2021-05-06T01:09:31.000+02:00",
"last_seen_at": "2021-05-06T01:09:31.649+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1843,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:09:31.004+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
},
"company": {
"data": {
"type": "companies",
"id": "2520"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "121",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
}
}
},
{
"id": "172",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-05-06",
"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": "dfadf1e519ce0079093f99b0760e455f",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 100,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"budget_revamp": false,
"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": "2021-05-06T01:09:31.144+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-05-06",
"sales_closed_on": null,
"sample_data": 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": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 100000,
"budget_remaining_default": 125000,
"budget_remaining_normalized": 100000,
"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": 100000,
"forecasted_budget_used_default": 125000,
"forecasted_budget_used_normalized": 100000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
},
"creator": {
"data": {
"type": "people",
"id": "1855"
}
},
"company": {
"data": {
"type": "companies",
"id": "2522"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1857"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "3716"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2524",
"type": "companies",
"attributes": {
"name": "Client1804",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:09:31.215+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2520",
"type": "companies",
"attributes": {
"name": "Organization721",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:09:31.002+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2522",
"type": "companies",
"attributes": {
"name": "Client1802",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:09:31.084+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1857",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1805@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:09:31.000+02:00",
"is_user": true,
"user_id": 1845,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:09:31.100+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
},
"company": {
"data": {
"type": "companies",
"id": "2523"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3716",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
}
}
},
{
"id": "2523",
"type": "companies",
"attributes": {
"name": "Client1803",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:09:31.094+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 721
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get booking reportsGET/api/v2/reports/booking_reports
Budget Reports ¶
Supported filter params
Supported filter params can be found on deals endpoint
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-308-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": 757
}
},
"budget": {
"data": {
"type": "deals",
"id": "308"
}
},
"contract": {
"data": null
},
"project": {
"data": null
},
"company": {
"data": null
},
"responsible": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "308",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-05-06",
"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": "07e1b28035e7c1e43f564348b6c3ee6b",
"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,
"position": 1,
"budget_revamp": false,
"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": "2021-05-06T01:10:22.600+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-05-06",
"sales_closed_on": null,
"sample_data": 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": 757
}
},
"creator": {
"data": {
"type": "people",
"id": "2281"
}
},
"company": {
"data": {
"type": "companies",
"id": "3095"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2282"
}
},
"deal_status": {
"meta": {
"included": false
}
},
"project": {
"data": {
"type": "projects",
"id": "471"
}
},
"lost_reason": {
"meta": {
"included": false
}
},
"contract": {
"data": null
},
"contact": {
"meta": {
"included": false
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2281",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2229@email.com",
"title": null,
"joined_at": "2021-05-06T01:10:22.000+02:00",
"last_seen_at": "2021-05-06T01:10:22.622+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 2269,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:10:22.422+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 757
}
},
"company": {
"data": {
"type": "companies",
"id": "3094"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3095",
"type": "companies",
"attributes": {
"name": "Client2339",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:22.497+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 757
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2282",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2230@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:10:22.000+02:00",
"is_user": true,
"user_id": 2270,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:10:22.509+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 757
}
},
"company": {
"data": {
"type": "companies",
"id": "3096"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "471",
"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,
"created_at": "2021-05-06T01:10:22.577+02:00",
"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,
"task_custom_fields_ids": null,
"sample_data": 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": 757
}
},
"company": {
"data": {
"type": "companies",
"id": "3098"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2283"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "3094",
"type": "companies",
"attributes": {
"name": "Organization757",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:10:22.421+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 757
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3096",
"type": "companies",
"attributes": {
"name": "Client2340",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:22.505+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 757
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3098",
"type": "companies",
"attributes": {
"name": "Client2342",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:22.574+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 757
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2283",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2231@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:10:22.000+02:00",
"is_user": true,
"user_id": 2271,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:10:22.546+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 757
}
},
"company": {
"data": {
"type": "companies",
"id": "3097"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3097",
"type": "companies",
"attributes": {
"name": "Client2341",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:22.541+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 757
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get budget reportsGET/api/v2/reports/budget_reports
Company Reports ¶
Supported filter params
Supported filter params can be found on companies endpoint
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-123-d41d8cd98f00b204e9800998ecf8427e",
"type": "company_reports",
"attributes": {
"group": "company",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"status": null,
"custom_fields": {},
"contact_phone": null,
"contact_email": null,
"contact_website": null,
"contact_city": null,
"contact_state": null,
"contact_country": null,
"contact_zipcode": null,
"contact_address": null,
"created_at_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 784
}
},
"company": {
"data": {
"type": "companies",
"id": "123"
}
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "123",
"type": "companies",
"attributes": {
"name": "Client2567",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:34.443+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 784
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get company reportsGET/api/v2/reports/company_reports
Deal Reports ¶
Supported filter params
Supported filter params can be found on deals endpoint
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-367-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,
"sales_closed_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_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": 803
}
},
"deal": {
"data": {
"type": "deals",
"id": "367"
}
},
"company": {
"data": null
},
"responsible": {
"data": null
},
"deal_status": {
"data": null
},
"lost_reason": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "367",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-05-06",
"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": "3b63c6fdd3f3b3879a3aa2b47d8c6e07",
"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,
"position": 1,
"budget_revamp": false,
"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": "2021-05-06T01:10:36.601+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-05-06",
"sales_closed_on": null,
"sample_data": 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": 803
}
},
"creator": {
"data": {
"type": "people",
"id": "2439"
}
},
"company": {
"data": {
"type": "companies",
"id": "3397"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2440"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "4256"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2439",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2387@email.com",
"title": null,
"joined_at": "2021-05-06T01:10:36.000+02:00",
"last_seen_at": "2021-05-06T01:10:36.622+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 2427,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:10:36.527+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 803
}
},
"company": {
"data": {
"type": "companies",
"id": "3396"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3397",
"type": "companies",
"attributes": {
"name": "Client2604",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:36.553+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 803
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2440",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2388@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:10:36.000+02:00",
"is_user": true,
"user_id": 2428,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:10:36.564+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 803
}
},
"company": {
"data": {
"type": "companies",
"id": "3398"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4256",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 803
}
}
}
},
{
"id": "3396",
"type": "companies",
"attributes": {
"name": "Organization803",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:10:36.525+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 803
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3398",
"type": "companies",
"attributes": {
"name": "Client2605",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:36.560+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 803
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get deal reportsGET/api/v2/reports/deal_reports
Engagement Reports ¶
Supported filter params
-
ended_on
-
engagement_id
-
engagement_type_id (1: monthly, 2: hourly, 3: weekly, 4: bi-weekly, 5: annually)
-
person_id
-
started_on
-
time
Supported relationship filter params
- person
Supported group params
-
engagement
-
organization
-
people_custom_fields
-
person
Supported date period dates
-
start_date
-
end_date
GET /api/v2/reports/engagement_reports
Requests
GET /api/v2/reports/engagement_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": "engagement-report-engagement-164-d41d8cd98f00b204e9800998ecf8427e",
"type": "engagement_reports",
"attributes": {
"group": "engagement",
"count": 616,
"time": 211840,
"engagement_type_id": null,
"people_custom_fields": {},
"formula_fields": {},
"start_date_period": null,
"end_date_period": null,
"date_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_rate": 8826666,
"total_rate_default": 8826666,
"total_rate_normalized": 8826666
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 834
}
},
"person": {
"data": null
},
"engagement": {
"data": {
"type": "salaries",
"id": "164"
}
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "164",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2021-04-26",
"ended_on": null,
"hours": "8.0",
"overhead": true,
"note": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 2000,
"cost_default": 2500,
"cost_normalized": 2000,
"hourly_rate": 2000,
"hourly_rate_default": 2500,
"hourly_rate_normalized": 2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 834
}
},
"person": {
"data": {
"type": "people",
"id": "2547"
}
}
}
},
{
"id": "2547",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2495@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:10:45.000+02:00",
"is_user": true,
"user_id": 2535,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:10:45.789+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 834
}
},
"company": {
"data": {
"type": "companies",
"id": "3583"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3583",
"type": "companies",
"attributes": {
"name": "Client2759",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:45.784+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 834
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/engagement_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/engagement_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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get booking reportsGET/api/v2/reports/engagement_reports
Entitlement Reports ¶
Supported filter params
Supported filter params can be found on entitlements endpoint
Supported group params
-
entitlement
-
event
-
person
-
organization
-
people_custom_fields
Supported date period dates
-
start_date
-
end_date
GET /api/v2/reports/entitlement_reports
Requests
GET /api/v2/reports/entitlement_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": "entitlement-report-entitlement-26-d41d8cd98f00b204e9800998ecf8427e",
"type": "entitlement_reports",
"attributes": {
"group": "entitlement",
"count": 1,
"total_allocated": 22,
"total_used": 0,
"total_available": 22,
"people_custom_fields": {},
"formula_fields": {},
"start_date_period": null,
"end_date_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "851"
}
},
"entitlement": {
"data": {
"type": "entitlements",
"id": "26"
}
},
"person": {
"data": null
},
"event": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "26",
"type": "entitlements",
"attributes": {
"start_date": "2021-05-05",
"end_date": "2021-05-16",
"allocated": 22,
"used": 0,
"note": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 851
}
},
"event": {
"data": {
"type": "events",
"id": "93"
}
},
"person": {
"data": {
"type": "people",
"id": "2637"
}
}
}
},
{
"id": "93",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 851
}
}
}
},
{
"id": "2637",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2585@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:10:55.000+02:00",
"is_user": true,
"user_id": 2625,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:10:55.371+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 851
}
},
"company": {
"data": {
"type": "companies",
"id": "3673"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3673",
"type": "companies",
"attributes": {
"name": "Client2832",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:55.367+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 851
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/entitlement_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/entitlement_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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get entitlement reportsGET/api/v2/reports/entitlement_reports
Expense Reports ¶
Supported filter params
Supported filter params can be found on expenses endpoint
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,
"created_at_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": 862
}
},
"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": "Višak",
"date": "2021-05-06",
"pay_on": null,
"paid_on": null,
"position": 1,
"invoiced": false,
"approved": true,
"approved_at": "2021-05-06T01:10:57.617+02:00",
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"deleted_at": null,
"reimbursable": null,
"reimbursed_on": null,
"exchange_rate": "1.25",
"exchange_date": "2021-05-06",
"created_at": "2021-05-06T01:10:57.618+02:00",
"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": 862
}
},
"deal": {
"data": {
"type": "deals",
"id": "434"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "260"
}
},
"person": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "2670"
}
},
"approver": {
"data": {
"type": "people",
"id": "2671"
}
},
"rejecter": {
"data": null
},
"vendor": {
"data": null
},
"service": {
"data": null
},
"attachment": {
"data": null
}
}
},
{
"id": "434",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-05-06",
"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": "74894b6f267a9820aa48c9ef3832a75e",
"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,
"position": 1,
"budget_revamp": false,
"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": "2021-05-06T01:10:57.505+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-05-06",
"sales_closed_on": null,
"sample_data": 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": 862
}
},
"creator": {
"data": {
"type": "people",
"id": "2670"
}
},
"company": {
"data": {
"type": "companies",
"id": "3707"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2671"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "4614"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "260",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 862
}
}
}
},
{
"id": "2670",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2618@email.com",
"title": null,
"joined_at": "2021-05-06T01:10:57.000+02:00",
"last_seen_at": "2021-05-06T01:10:57.665+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 2658,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:10:57.429+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 862
}
},
"company": {
"data": {
"type": "companies",
"id": "3706"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2671",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2619@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:10:57.000+02:00",
"is_user": true,
"user_id": 2659,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:10:57.464+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 862
}
},
"company": {
"data": {
"type": "companies",
"id": "3708"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3707",
"type": "companies",
"attributes": {
"name": "Client2855",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:57.453+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 862
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4614",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 862
}
}
}
},
{
"id": "3706",
"type": "companies",
"attributes": {
"name": "Organization862",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:10:57.427+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 862
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3708",
"type": "companies",
"attributes": {
"name": "Client2856",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:10:57.460+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 862
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}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-9-d41d8cd98f00b204e9800998ecf8427e",
"type": "financial_item_reports",
"attributes": {
"group": "financial_item",
"count": 1,
"financial_item_id": 9,
"financial_item_type": "time_entry",
"financial_item_date": "2021-05-06",
"total_time": 480,
"total_billable_time": 0,
"total_scheduled_time": 0,
"total_recognized_time": null,
"pricing_type_id": null,
"project_type_id": null,
"average_recognized_margin": null,
"future": null,
"approval_status": null,
"date_period": null,
"formula_fields": {},
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"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,
"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,
"total_invoiced": 0,
"total_invoiced_default": 0,
"total_invoiced_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"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": "9"
}
},
"booking_item": {
"data": null
},
"expense": {
"data": null
},
"invoice_attribution": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "9",
"type": "time_entries",
"attributes": {
"date": "2021-05-06",
"created_at": "2021-05-06T01:11:26.417+02:00",
"time": 480,
"billable_time": 480,
"note": "test note",
"track_method_id": null,
"tracking_type_id": null,
"started_at": null,
"timer_started_at": null,
"timer_stopped_at": null,
"approved": false,
"approved_at": null,
"updated_at": "2021-05-06T01:11:26.417+02:00",
"calendar_event_id": null,
"invoiced": false,
"overhead": 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
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"person": {
"data": {
"type": "people",
"id": "2938"
}
},
"service": {
"data": {
"type": "services",
"id": "303"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "2937"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "2938",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2886@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:11:26.000+02:00",
"is_user": true,
"user_id": 2926,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:11:26.282+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"company": {
"data": {
"type": "companies",
"id": "4196"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "303",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"tracking_enabled": true,
"pricing_type_id": 1,
"billing_type_id": null,
"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,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"expense_amount": 0,
"expense_amount_default": 0,
"expense_amount_normalized": 0,
"expense_billable_amount": 0,
"expense_billable_amount_default": 0,
"expense_billable_amount_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"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": 909
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "457"
}
},
"deal": {
"data": {
"type": "deals",
"id": "630"
}
},
"section": {
"data": null
}
}
},
{
"id": "2937",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2885@email.com",
"title": null,
"joined_at": "2021-05-06T01:11:26.000+02:00",
"last_seen_at": "2021-05-06T01:11:26.465+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 2925,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:11:26.217+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"company": {
"data": {
"type": "companies",
"id": "4195"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4196",
"type": "companies",
"attributes": {
"name": "Client3297",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:11:26.276+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "457",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
}
}
},
{
"id": "630",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-05-06",
"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": "a09eb2de5899b3e3828f468200591553",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 100,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"budget_revamp": false,
"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": "2021-05-06T01:11:26.366+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-05-06",
"sales_closed_on": null,
"sample_data": 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": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 12500,
"actual_rate_default": 15625,
"actual_rate_normalized": 12500,
"budget_remaining": 100000,
"budget_remaining_default": 125000,
"budget_remaining_normalized": 100000,
"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": 100000,
"forecasted_budget_used_default": 125000,
"forecasted_budget_used_normalized": 100000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"creator": {
"data": {
"type": "people",
"id": "2937"
}
},
"company": {
"data": {
"type": "companies",
"id": "4197"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2939"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "5029"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4195",
"type": "companies",
"attributes": {
"name": "Organization909",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:11:26.216+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4197",
"type": "companies",
"attributes": {
"name": "Client3298",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:11:26.315+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2939",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2887@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:11:26.000+02:00",
"is_user": true,
"user_id": 2927,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:11:26.328+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"company": {
"data": {
"type": "companies",
"id": "4198"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "5029",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
}
}
},
{
"id": "4198",
"type": "companies",
"attributes": {
"name": "Client3299",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:11:26.323+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 909
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get financial item reportsGET/api/v2/reports/financial_item_reports
Invoice Reports ¶
Supported filter params
Supported filter params can be found on invoices endpoint
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-64-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": 910
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "64"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "64",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-05-06",
"sent_on": null,
"pay_on": "2021-05-16",
"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": "8662113c3eddc624bd795b721ba779ef",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-05-06T01:11:26.745+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-05-06",
"custom_fields": null,
"updated_at": "2021-05-06T01:11:26.745+02:00",
"sample_data": 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": 910
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "4200"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "24"
}
},
"creator": {
"data": {
"type": "people",
"id": "2940"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "4200",
"type": "companies",
"attributes": {
"name": "Client3300",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:11:26.738+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 910
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "24",
"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": {},
"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": 910
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "132"
}
},
"document_style": {
"data": null
}
}
},
{
"id": "2940",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2888@email.com",
"title": null,
"joined_at": "2021-05-06T01:11:26.000+02:00",
"last_seen_at": "2021-05-06T01:11:26.764+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 2928,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:11:26.703+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 910
}
},
"company": {
"data": {
"type": "companies",
"id": "4199"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "132",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary132",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 910
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "4199",
"type": "companies",
"attributes": {
"name": "Organization910",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:11:26.702+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 910
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get invoice reportsGET/api/v2/reports/invoice_reports
Payment Reports ¶
Supported filter params
Supported filter params can be found on payments endpoint
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-28-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": 957
}
},
"payment": {
"data": {
"type": "payments",
"id": "28"
}
},
"invoice": {
"data": null
},
"company": {
"data": null
},
"deal": {
"meta": {
"included": false
}
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "28",
"type": "payments",
"attributes": {
"paid_on": "2021-05-06",
"written_off_on": null,
"note": null,
"external_id": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 957
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "878"
}
}
}
},
{
"id": "878",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-05-06",
"sent_on": null,
"pay_on": "2021-05-16",
"delivery_on": null,
"paid_on": "2021-05-06",
"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": "bdcb3e53c393dbabec7dd46b516ceb39",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-05-06T01:11:37.249+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-05-06",
"custom_fields": null,
"updated_at": "2021-05-06T01:11:37.265+02:00",
"sample_data": 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": 957
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "4390"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "73"
}
},
"creator": {
"data": {
"type": "people",
"id": "3011"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "4390",
"type": "companies",
"attributes": {
"name": "Client3443",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:11:37.244+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 957
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "73",
"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": {},
"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": 957
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "181"
}
},
"document_style": {
"data": null
}
}
},
{
"id": "3011",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2959@email.com",
"title": null,
"joined_at": "2021-05-06T01:11:37.000+02:00",
"last_seen_at": "2021-05-06T01:11:37.280+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 2999,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:11:37.214+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 957
}
},
"company": {
"data": {
"type": "companies",
"id": "4389"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "181",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary181",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 957
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "4389",
"type": "companies",
"attributes": {
"name": "Organization957",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:11:37.213+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 957
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get payment reportsGET/api/v2/reports/payment_reports
Person Reports ¶
Supported filter params
Supported filter params can be found on people endpoint
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-3053-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": {},
"contact_phone": null,
"contact_email": null,
"contact_website": null,
"contact_city": null,
"contact_state": null,
"contact_country": null,
"contact_zipcode": null,
"contact_address": null,
"created_at_period": null,
"joined_at_period": null,
"deactivated_at_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 979
}
},
"person": {
"data": {
"type": "people",
"id": "3053"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "3053",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3001@email.com",
"title": null,
"joined_at": "2021-05-06T01:11:42.000+02:00",
"last_seen_at": "2021-05-06T01:11:42.716+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 3041,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:11:42.690+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 979
}
},
"company": {
"data": {
"type": "companies",
"id": "4484"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4484",
"type": "companies",
"attributes": {
"name": "Organization979",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:11:42.688+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 979
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get person reportsGET/api/v2/reports/person_reports
Project Reports ¶
Supported filter params
Supported filter params can be found on projects endpoint
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-572-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": 1036
}
},
"project": {
"data": {
"type": "projects",
"id": "572"
}
},
"company": {
"data": null
},
"project_manager": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "572",
"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,
"created_at": "2021-05-06T01:11:49.277+02:00",
"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,
"task_custom_fields_ids": null,
"sample_data": 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": 1036
}
},
"company": {
"data": {
"type": "companies",
"id": "4599"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3169"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "4599",
"type": "companies",
"attributes": {
"name": "Client3573",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:11:49.274+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1036
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3169",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3115@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:11:49.000+02:00",
"is_user": true,
"user_id": 3155,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:11:49.245+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1036
}
},
"company": {
"data": {
"type": "companies",
"id": "4598"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4598",
"type": "companies",
"attributes": {
"name": "Client3572",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:11:49.241+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1036
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get project reportsGET/api/v2/reports/project_reports
Service Reports ¶
Supported filter params
Supported filter params can be found on services endpoint
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-338-d41d8cd98f00b204e9800998ecf8427e",
"type": "service_reports",
"attributes": {
"group": "service",
"count": 1,
"budget_status": null,
"project_type": null,
"billing_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": "100.0",
"average_forecasted_time_usage": null,
"average_profit_margin": "100.0",
"average_budget_usage": "0.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": 0,
"total_budget_used_default": 0,
"total_budget_used_normalized": 0,
"total_budget_remaining": 125000,
"total_budget_remaining_default": 125000,
"total_budget_remaining_normalized": 125000,
"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": 125000,
"total_forecasted_budget_used_default": 125000,
"total_forecasted_budget_used_normalized": 125000,
"total_discount_amount": 0,
"total_discount_amount_default": 0,
"total_discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1073
}
},
"service": {
"data": {
"type": "services",
"id": "338"
}
},
"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": "338",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"tracking_enabled": true,
"pricing_type_id": 1,
"billing_type_id": null,
"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,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"expense_amount": 0,
"expense_amount_default": 0,
"expense_amount_normalized": 0,
"expense_billable_amount": 0,
"expense_billable_amount_default": 0,
"expense_billable_amount_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"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": 1073
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "532"
}
},
"deal": {
"data": {
"type": "deals",
"id": "683"
}
},
"section": {
"data": null
}
}
},
{
"id": "532",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1073
}
}
}
},
{
"id": "683",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-12-01",
"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": "09881f8295b8a5b5e37c759f20166b35",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 100,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"budget_revamp": false,
"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-12-01T00:00:00.000+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-12-01",
"sales_closed_on": null,
"sample_data": 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": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 100000,
"budget_remaining_default": 125000,
"budget_remaining_normalized": 100000,
"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": 100000,
"forecasted_budget_used_default": 125000,
"forecasted_budget_used_normalized": 100000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1073
}
},
"creator": {
"data": {
"type": "people",
"id": "3360"
}
},
"company": {
"data": {
"type": "companies",
"id": "4933"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "3361"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "5850"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3360",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3306@email.com",
"title": null,
"joined_at": "2020-12-01T00:00:00.000+01:00",
"last_seen_at": "2020-12-01T00:00:00.000+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 3346,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:12:04.432+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1073
}
},
"company": {
"data": {
"type": "companies",
"id": "4932"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4933",
"type": "companies",
"attributes": {
"name": "Client3870",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-01T00:00:00.000+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1073
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3361",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3307@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-01T00:00:00.000+01:00",
"is_user": true,
"user_id": 3347,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-01T00:00:00.000+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1073
}
},
"company": {
"data": {
"type": "companies",
"id": "4934"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "5850",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1073
}
}
}
},
{
"id": "4932",
"type": "companies",
"attributes": {
"name": "Organization1073",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:12:04.430+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1073
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4934",
"type": "companies",
"attributes": {
"name": "Client3871",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-01T00:00:00.000+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1073
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get service reportsGET/api/v2/reports/service_reports
Task Reports ¶
Supported filter params
Supported filter params can be found on tasks endpoint
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-145-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": 1158
}
},
"task": {
"data": {
"type": "tasks",
"id": "145"
}
},
"project": {
"data": null
},
"task_list": {
"data": null
},
"board": {
"data": null
},
"assignee": {
"data": null
},
"creator": {
"data": null
},
"last_actor": {
"data": null
},
"company": {
"data": null
},
"parent_task": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "145",
"type": "tasks",
"attributes": {
"title": "Ticket title",
"description": null,
"number": 1,
"private": false,
"due_date": null,
"start_date": null,
"closed_at": null,
"created_at": "2021-05-06T01:12:36.781+02:00",
"updated_at": "2021-05-06T01:12:36.781+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": "57adbcda5b63c3e2814471e8adca9662",
"custom_fields": null,
"todo_count": null,
"open_todo_count": null,
"todo_assignee_count": null,
"subtask_count": null,
"open_subtask_count": null,
"creation_method_id": 1,
"subtask_position": null,
"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": 1158
}
},
"project": {
"data": {
"type": "projects",
"id": "934"
}
},
"creator": {
"data": {
"type": "people",
"id": "3648"
}
},
"assignee": {
"data": null
},
"last_actor": {
"data": null
},
"task_list": {
"data": {
"type": "task_lists",
"id": "145"
}
},
"parent_task": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "934",
"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,
"created_at": "2021-05-06T01:12:36.532+02:00",
"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,
"task_custom_fields_ids": null,
"sample_data": 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": 1158
}
},
"company": {
"data": {
"type": "companies",
"id": "5413"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3647"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "3648",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3594@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:12:36.000+02:00",
"is_user": true,
"user_id": 3634,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:12:36.576+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"company": {
"data": {
"type": "companies",
"id": "5414"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "145",
"type": "task_lists",
"attributes": {
"name": "Milestone120",
"position": 1,
"archived_at": null,
"email_key": "388a73e8c94757b6878bd1f25431472e"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"project": {
"data": {
"type": "projects",
"id": "935"
}
},
"board": {
"data": {
"type": "boards",
"id": "173"
}
}
}
},
{
"id": "5413",
"type": "companies",
"attributes": {
"name": "Client4265",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:12:36.529+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3647",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3593@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:12:36.000+02:00",
"is_user": true,
"user_id": 3633,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:12:36.503+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"company": {
"data": {
"type": "companies",
"id": "5412"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "5414",
"type": "companies",
"attributes": {
"name": "Client4266",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:12:36.571+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "935",
"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,
"created_at": "2021-05-06T01:12:36.650+02:00",
"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,
"task_custom_fields_ids": null,
"sample_data": 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": 1158
}
},
"company": {
"data": {
"type": "companies",
"id": "5416"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3649"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "173",
"type": "boards",
"attributes": {
"name": "Board133",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"project": {
"data": {
"type": "projects",
"id": "936"
}
}
}
},
{
"id": "5412",
"type": "companies",
"attributes": {
"name": "Client4264",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:12:36.499+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "5416",
"type": "companies",
"attributes": {
"name": "Client4268",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:12:36.647+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3649",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3595@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:12:36.000+02:00",
"is_user": true,
"user_id": 3635,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:12:36.615+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"company": {
"data": {
"type": "companies",
"id": "5415"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "936",
"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,
"created_at": "2021-05-06T01:12:36.716+02:00",
"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,
"task_custom_fields_ids": null,
"sample_data": 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": 1158
}
},
"company": {
"data": {
"type": "companies",
"id": "5418"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3650"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "5415",
"type": "companies",
"attributes": {
"name": "Client4267",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:12:36.611+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "5418",
"type": "companies",
"attributes": {
"name": "Client4270",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:12:36.713+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3650",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3596@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:12:36.000+02:00",
"is_user": true,
"user_id": 3636,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:12:36.680+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"company": {
"data": {
"type": "companies",
"id": "5417"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "5417",
"type": "companies",
"attributes": {
"name": "Client4269",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:12:36.675+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1158
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get task reportsGET/api/v2/reports/task_reports
Time Entry Reports ¶
Supported filter params
Supported filter params can be found on time entries endpoint
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-12-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,
"overhead": false,
"total_time": 480,
"total_billable_time": 480,
"total_recognized_time": null,
"pricing_type_id": null,
"unit_id": null,
"project_type_id": null,
"track_method_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,
"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,
"total_billable_revenue": null,
"total_billable_revenue_default": null,
"total_billable_revenue_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"time_entry": {
"data": {
"type": "time_entries",
"id": "12"
}
},
"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": "12",
"type": "time_entries",
"attributes": {
"date": "2021-05-06",
"created_at": "2021-05-06T01:13:26.199+02:00",
"time": 480,
"billable_time": 480,
"note": "test note",
"track_method_id": null,
"tracking_type_id": null,
"started_at": null,
"timer_started_at": null,
"timer_stopped_at": null,
"approved": false,
"approved_at": null,
"updated_at": "2021-05-06T01:13:26.199+02:00",
"calendar_event_id": null,
"invoiced": false,
"overhead": 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
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"person": {
"data": {
"type": "people",
"id": "4375"
}
},
"service": {
"data": {
"type": "services",
"id": "507"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "4374"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "4375",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4321@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:13:26.000+02:00",
"is_user": true,
"user_id": 4361,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:13:26.076+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"company": {
"data": {
"type": "companies",
"id": "6549"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "507",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"tracking_enabled": true,
"pricing_type_id": 1,
"billing_type_id": null,
"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,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"expense_amount": 0,
"expense_amount_default": 0,
"expense_amount_normalized": 0,
"expense_billable_amount": 0,
"expense_billable_amount_default": 0,
"expense_billable_amount_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"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": 1215
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "701"
}
},
"deal": {
"data": {
"type": "deals",
"id": "832"
}
},
"section": {
"data": null
}
}
},
{
"id": "4374",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4320@email.com",
"title": null,
"joined_at": "2021-05-06T01:13:26.000+02:00",
"last_seen_at": "2021-05-06T01:13:26.244+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 4360,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:13:26.043+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"company": {
"data": {
"type": "companies",
"id": "6548"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6549",
"type": "companies",
"attributes": {
"name": "Client5344",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:13:26.071+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "701",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
}
}
},
{
"id": "832",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-05-06",
"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": "39951db0135f73c790eeae61be709d2b",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 100,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"budget_revamp": false,
"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": "2021-05-06T01:13:26.153+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-05-06",
"sales_closed_on": null,
"sample_data": 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": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 12500,
"actual_rate_default": 15625,
"actual_rate_normalized": 12500,
"budget_remaining": 100000,
"budget_remaining_default": 125000,
"budget_remaining_normalized": 100000,
"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": 100000,
"forecasted_budget_used_default": 125000,
"forecasted_budget_used_normalized": 100000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"creator": {
"data": {
"type": "people",
"id": "4374"
}
},
"company": {
"data": {
"type": "companies",
"id": "6550"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "4376"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "6687"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6548",
"type": "companies",
"attributes": {
"name": "Organization1215",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-05-06T01:13:26.042+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "6550",
"type": "companies",
"attributes": {
"name": "Client5345",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:13:26.105+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4376",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4322@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:13:26.000+02:00",
"is_user": true,
"user_id": 4362,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:13:26.116+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"company": {
"data": {
"type": "companies",
"id": "6551"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6687",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
}
}
},
{
"id": "6551",
"type": "companies",
"attributes": {
"name": "Client5346",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:13:26.112+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1215
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}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-4733-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": 0,
"available_time": 0,
"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,
"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": 1281
}
},
"person": {
"data": {
"type": "people",
"id": "4733"
}
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"company": {
"data": null
},
"project": {
"data": null
},
"event": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "4733",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4679@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-05-06T01:14:05.000+02:00",
"is_user": true,
"user_id": 4719,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-05-06T01:14:05.328+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1281
}
},
"company": {
"data": {
"type": "companies",
"id": "7056"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "7056",
"type": "companies",
"attributes": {
"name": "Client5785",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-05-06T01:14:05.323+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1281
}
},
"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": 100,
"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
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"