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-12-06",
"end_date": "2021-12-06",
"pricing_type_id": null,
"project_type": null,
"approval_status": null,
"total_recognized_time": 0,
"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": "946"
}
},
"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-12-06",
"ended_on": "2021-12-06",
"note": null,
"total_time": 0,
"total_working_days": 0,
"percentage": null,
"created_at": "2021-12-06T00:08:34.215+01:00",
"updated_at": "2021-12-06T00:08:34.215+01:00",
"people_custom_fields": null,
"approved": true,
"approved_at": "2021-12-06T00:08:34.215+01:00",
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"canceled": false,
"canceled_at": null,
"booking_method_id": 1,
"autotracking": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
},
"service": {
"data": {
"type": "services",
"id": "185"
}
},
"event": {
"data": null
},
"person": {
"data": {
"type": "people",
"id": "2965"
}
},
"creator": {
"data": {
"type": "people",
"id": "2962"
}
},
"updater": {
"data": {
"type": "people",
"id": "2962"
}
},
"approver": {
"data": {
"type": "people",
"id": "2962"
}
},
"rejecter": {
"data": null
},
"canceler": {
"data": null
},
"origin": {
"data": null
},
"approval_statuses": {
"data": []
}
}
},
{
"id": "185",
"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": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"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": "946"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "268"
}
},
"deal": {
"data": {
"type": "deals",
"id": "352"
}
},
"section": {
"data": null
}
}
},
{
"id": "2965",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2907@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:08:34.000+01:00",
"is_user": true,
"user_id": 2948,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:08:34.186+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
},
"company": {
"data": {
"type": "companies",
"id": "4187"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2962",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2904@email.com",
"title": null,
"joined_at": "2021-12-06T00:08:34.000+01:00",
"last_seen_at": "2021-12-06T00:08:34.454+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2945,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:08:34.061+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
},
"company": {
"data": {
"type": "companies",
"id": "4183"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "268",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
}
}
},
{
"id": "352",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-12-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": "aa4266fc37cb8d1ec1b576d9cb26035d",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"budget_revamp": false,
"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,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-12-06T00:08:34.156+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-12-06",
"sales_closed_on": null,
"sample_data": false,
"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,
"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,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
},
"creator": {
"data": {
"type": "people",
"id": "2962"
}
},
"company": {
"data": {
"type": "companies",
"id": "4185"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2964"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "4913"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4187",
"type": "companies",
"attributes": {
"name": "Client3242",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:08:34.183+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
}
}
},
{
"id": "4183",
"type": "companies",
"attributes": {
"name": "Organization946",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:08:34.060+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
}
}
},
{
"id": "4185",
"type": "companies",
"attributes": {
"name": "Client3240",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:08:34.116+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
}
}
},
{
"id": "2964",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2906@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:08:34.000+01:00",
"is_user": true,
"user_id": 2947,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:08:34.125+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
},
"company": {
"data": {
"type": "companies",
"id": "4186"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "4913",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
}
}
},
{
"id": "4186",
"type": "companies",
"attributes": {
"name": "Client3241",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:08:34.121+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "946"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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-488-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": "982"
}
},
"budget": {
"data": {
"type": "deals",
"id": "488"
}
},
"contract": {
"data": null
},
"project": {
"data": null
},
"company": {
"data": null
},
"responsible": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "488",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-12-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": "758a53fbb01c8c7d2a88d8c3a8c7bb6d",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"budget_revamp": false,
"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,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-12-06T00:09:14.805+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-12-06",
"sales_closed_on": null,
"sample_data": false,
"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,
"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,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
},
"creator": {
"data": {
"type": "people",
"id": "3388"
}
},
"company": {
"data": {
"type": "companies",
"id": "4758"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "3389"
}
},
"deal_status": {
"meta": {
"included": false
}
},
"project": {
"data": {
"type": "projects",
"id": "836"
}
},
"lost_reason": {
"meta": {
"included": false
}
},
"contract": {
"data": null
},
"contact": {
"meta": {
"included": false
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3388",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3330@email.com",
"title": null,
"joined_at": "2021-12-06T00:09:14.000+01:00",
"last_seen_at": "2021-12-06T00:09:14.824+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3371,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:09:14.629+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
},
"company": {
"data": {
"type": "companies",
"id": "4757"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "4758",
"type": "companies",
"attributes": {
"name": "Client3777",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:14.712+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
}
}
},
{
"id": "3389",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3331@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:09:14.000+01:00",
"is_user": true,
"user_id": 3372,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:09:14.721+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
},
"company": {
"data": {
"type": "companies",
"id": "4759"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "836",
"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-12-06T00:09:14.785+01:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
},
"company": {
"data": {
"type": "companies",
"id": "4761"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3390"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "4757",
"type": "companies",
"attributes": {
"name": "Organization982",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:09:14.628+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
}
}
},
{
"id": "4759",
"type": "companies",
"attributes": {
"name": "Client3778",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:14.718+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
}
}
},
{
"id": "4761",
"type": "companies",
"attributes": {
"name": "Client3780",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:14.782+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
}
}
},
{
"id": "3390",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3332@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:09:14.000+01:00",
"is_user": true,
"user_id": 3373,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:09:14.756+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
},
"company": {
"data": {
"type": "companies",
"id": "4760"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "4760",
"type": "companies",
"attributes": {
"name": "Client3779",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:14.752+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "982"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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": "1009"
}
},
"company": {
"data": {
"type": "companies",
"id": "123"
}
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "123",
"type": "companies",
"attributes": {
"name": "Client4005",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:24.921+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1009"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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-547-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": "1028"
}
},
"deal": {
"data": {
"type": "deals",
"id": "547"
}
},
"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": "547",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-12-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": "bafa466d90a228095dfa4571e2e7fbed",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"budget_revamp": false,
"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,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-12-06T00:09:26.586+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-12-06",
"sales_closed_on": null,
"sample_data": false,
"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,
"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,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1028"
}
},
"creator": {
"data": {
"type": "people",
"id": "3546"
}
},
"company": {
"data": {
"type": "companies",
"id": "5060"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "3547"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "5453"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3546",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3488@email.com",
"title": null,
"joined_at": "2021-12-06T00:09:26.000+01:00",
"last_seen_at": "2021-12-06T00:09:26.602+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3529,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:09:26.524+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1028"
}
},
"company": {
"data": {
"type": "companies",
"id": "5059"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5060",
"type": "companies",
"attributes": {
"name": "Client4042",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:26.545+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1028"
}
}
}
},
{
"id": "3547",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3489@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:09:26.000+01:00",
"is_user": true,
"user_id": 3530,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:09:26.555+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1028"
}
},
"company": {
"data": {
"type": "companies",
"id": "5061"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5453",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1028"
}
}
}
},
{
"id": "5059",
"type": "companies",
"attributes": {
"name": "Organization1028",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:09:26.523+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1028"
}
}
}
},
{
"id": "5061",
"type": "companies",
"attributes": {
"name": "Client4043",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:26.551+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1028"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get deal reportsGET/api/v2/reports/deal_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-36-d41d8cd98f00b204e9800998ecf8427e",
"type": "entitlement_reports",
"attributes": {
"group": "entitlement",
"count": 1,
"total_allocated": 22,
"total_used": 0,
"total_available": 22,
"total_allocated_minutes": 0,
"total_used_minutes": 0,
"total_available_minutes": 0,
"people_custom_fields": {},
"formula_fields": {},
"start_date_period": null,
"end_date_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1059"
}
},
"entitlement": {
"data": {
"type": "entitlements",
"id": "36"
}
},
"person": {
"data": null
},
"event": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "36",
"type": "entitlements",
"attributes": {
"start_date": "2021-12-05",
"end_date": "2021-12-16",
"allocated": 22,
"used": 0,
"pending": 0,
"note": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1059"
}
},
"event": {
"data": {
"type": "events",
"id": "119"
}
},
"person": {
"data": {
"type": "people",
"id": "3653"
}
},
"approval_workflow": {
"data": null
}
}
},
{
"id": "119",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2,
"sync_slack": true,
"sync_calendar": true,
"sync_personal_integrations": true
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1059"
}
}
}
},
{
"id": "3653",
"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,
"setting_role_id": null,
"invited_at": "2021-12-06T00:09:34.000+01:00",
"is_user": true,
"user_id": 3636,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:09:34.419+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1059"
}
},
"company": {
"data": {
"type": "companies",
"id": "5245"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5245",
"type": "companies",
"attributes": {
"name": "Client4196",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:34.415+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1059"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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-83-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": "1070"
}
},
"expense": {
"data": {
"type": "expenses",
"id": "83"
}
},
"deal": {
"data": null
},
"project": {
"data": null
},
"company": {
"data": null
},
"service_type": {
"data": null
},
"service": {
"data": null
},
"vendor": {
"data": null
},
"person": {
"data": null
},
"approver": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "83",
"type": "expenses",
"attributes": {
"name": "Višak",
"date": "2021-12-06",
"pay_on": null,
"paid_on": null,
"position": 1,
"invoiced": false,
"approved": true,
"approved_at": "2021-12-06T00:09:36.342+01:00",
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"deleted_at": null,
"reimbursable": null,
"reimbursed_on": null,
"exchange_rate": "1.25",
"exchange_date": "2021-12-06",
"created_at": "2021-12-06T00:09:36.343+01: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": "1070"
}
},
"deal": {
"data": {
"type": "deals",
"id": "614"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "407"
}
},
"person": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "3686"
}
},
"approver": {
"data": {
"type": "people",
"id": "3687"
}
},
"rejecter": {
"data": null
},
"vendor": {
"data": null
},
"service": {
"data": null
},
"attachment": {
"data": null
}
}
},
{
"id": "614",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-12-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": "c7ae0e4690441dc9f6d5a70470dc4d3d",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"budget_revamp": false,
"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,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-12-06T00:09:36.260+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-12-06",
"sales_closed_on": null,
"sample_data": false,
"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,
"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,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1070"
}
},
"creator": {
"data": {
"type": "people",
"id": "3686"
}
},
"company": {
"data": {
"type": "companies",
"id": "5279"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "3687"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "5726"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "407",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1070"
}
}
}
},
{
"id": "3686",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3628@email.com",
"title": null,
"joined_at": "2021-12-06T00:09:36.000+01:00",
"last_seen_at": "2021-12-06T00:09:36.373+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3669,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:09:36.191+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1070"
}
},
"company": {
"data": {
"type": "companies",
"id": "5278"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "3687",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3629@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:09:36.000+01:00",
"is_user": true,
"user_id": 3670,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:09:36.228+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1070"
}
},
"company": {
"data": {
"type": "companies",
"id": "5280"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5279",
"type": "companies",
"attributes": {
"name": "Client4219",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:36.218+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1070"
}
}
}
},
{
"id": "5726",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1070"
}
}
}
},
{
"id": "5278",
"type": "companies",
"attributes": {
"name": "Organization1070",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:09:36.190+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1070"
}
}
}
},
{
"id": "5280",
"type": "companies",
"attributes": {
"name": "Client4220",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:09:36.224+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1070"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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-64-d41d8cd98f00b204e9800998ecf8427e",
"type": "financial_item_reports",
"attributes": {
"group": "financial_item",
"count": 1,
"financial_item_id": 64,
"financial_item_type": "time_entry",
"financial_item_date": "2021-12-06",
"total_time": 480,
"total_billable_time": 0,
"total_scheduled_time": 0,
"total_recognized_time": 0,
"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_scheduled_revenue": 0,
"total_scheduled_revenue_default": 0,
"total_scheduled_revenue_normalized": 0,
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_scheduled_cost": 0,
"total_scheduled_cost_default": 0,
"total_scheduled_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": "1124"
}
},
"person": {
"data": null
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"company": {
"data": null
},
"project": {
"data": null
},
"responsible": {
"data": null
},
"time_entry": {
"data": {
"type": "time_entries",
"id": "64"
}
},
"booking_item": {
"data": null
},
"expense": {
"data": null
},
"invoice_attribution": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "64",
"type": "time_entries",
"attributes": {
"date": "2021-12-06",
"created_at": "2021-12-06T00:10:02.519+01:00",
"time": 480,
"billable_time": 480,
"note": "test note",
"track_method_id": null,
"started_at": null,
"timer_started_at": null,
"timer_stopped_at": null,
"approved": false,
"approved_at": null,
"updated_at": "2021-12-06T00:10:02.519+01: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": "1124"
}
},
"person": {
"data": {
"type": "people",
"id": "3989"
}
},
"service": {
"data": {
"type": "services",
"id": "436"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "3988"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "3989",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3931@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:10:02.000+01:00",
"is_user": true,
"user_id": 3972,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:10:02.428+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
},
"company": {
"data": {
"type": "companies",
"id": "5831"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "436",
"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": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"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": "1124"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "632"
}
},
"deal": {
"data": {
"type": "deals",
"id": "838"
}
},
"section": {
"data": null
}
}
},
{
"id": "3988",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3930@email.com",
"title": null,
"joined_at": "2021-12-06T00:10:02.000+01:00",
"last_seen_at": "2021-12-06T00:10:02.546+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3971,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:10:02.400+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
},
"company": {
"data": {
"type": "companies",
"id": "5830"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5831",
"type": "companies",
"attributes": {
"name": "Client4717",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:10:02.425+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
}
}
},
{
"id": "632",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
}
}
},
{
"id": "838",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-12-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": "edb9545a585149b824063e6ac36c900a",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"budget_revamp": false,
"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,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-12-06T00:10:02.493+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-12-06",
"sales_closed_on": null,
"sample_data": false,
"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,
"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,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
},
"creator": {
"data": {
"type": "people",
"id": "3988"
}
},
"company": {
"data": {
"type": "companies",
"id": "5832"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "3990"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "6204"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "5830",
"type": "companies",
"attributes": {
"name": "Organization1124",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:10:02.399+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
}
}
},
{
"id": "5832",
"type": "companies",
"attributes": {
"name": "Client4718",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:10:02.454+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
}
}
},
{
"id": "3990",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3932@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:10:02.000+01:00",
"is_user": true,
"user_id": 3973,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:10:02.463+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
},
"company": {
"data": {
"type": "companies",
"id": "5833"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "6204",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
}
}
},
{
"id": "5833",
"type": "companies",
"attributes": {
"name": "Client4719",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:10:02.460+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1124"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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-72-d41d8cd98f00b204e9800998ecf8427e",
"type": "invoice_reports",
"attributes": {
"group": "invoice",
"count": 1,
"sent_status": null,
"payment_status": null,
"overdue_status": null,
"invoice_status": null,
"invoice_aging": null,
"invoice_state": 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": "1125"
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "72"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "72",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-12-06",
"sent_on": null,
"pay_on": "2021-12-16",
"delivery_on": null,
"paid_on": null,
"finalized_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": "4573378d1947e390a595619b9af56956",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-12-06T00:10:02.792+01:00",
"exchange_rate": "1.25",
"exchange_date": "2021-12-06",
"custom_fields": null,
"updated_at": "2021-12-06T00:10:02.792+01:00",
"sample_data": false,
"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": "1125"
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "5835"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "25"
}
},
"creator": {
"data": {
"type": "people",
"id": "3991"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "5835",
"type": "companies",
"attributes": {
"name": "Client4720",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:10:02.787+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1125"
}
}
}
},
{
"id": "25",
"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,
"email_data": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1125"
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "143"
}
},
"document_style": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "3991",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3933@email.com",
"title": null,
"joined_at": "2021-12-06T00:10:02.000+01:00",
"last_seen_at": "2021-12-06T00:10:02.808+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3974,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:10:02.760+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1125"
}
},
"company": {
"data": {
"type": "companies",
"id": "5834"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "143",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary143",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1125"
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "5834",
"type": "companies",
"attributes": {
"name": "Organization1125",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:10:02.759+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1125"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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": "1172"
}
},
"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-12-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": "1172"
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "878"
}
}
}
},
{
"id": "878",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-12-06",
"sent_on": null,
"pay_on": "2021-12-16",
"delivery_on": null,
"paid_on": "2021-12-06",
"finalized_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": "7272244c29005c97568537e3f5cd6d29",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-12-06T00:10:11.359+01:00",
"exchange_rate": "1.25",
"exchange_date": "2021-12-06",
"custom_fields": null,
"updated_at": "2021-12-06T00:10:11.371+01:00",
"sample_data": false,
"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": "1172"
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "6025"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "74"
}
},
"creator": {
"data": {
"type": "people",
"id": "4062"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "6025",
"type": "companies",
"attributes": {
"name": "Client4863",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:10:11.354+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1172"
}
}
}
},
{
"id": "74",
"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,
"email_data": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1172"
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "192"
}
},
"document_style": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "4062",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4004@email.com",
"title": null,
"joined_at": "2021-12-06T00:10:11.000+01:00",
"last_seen_at": "2021-12-06T00:10:11.385+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 4045,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:10:11.328+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1172"
}
},
"company": {
"data": {
"type": "companies",
"id": "6024"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "192",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary192",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1172"
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "6024",
"type": "companies",
"attributes": {
"name": "Organization1172",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:10:11.327+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1172"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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
-
last_activity_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-4104-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,
"last_activity_at_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1194"
}
},
"person": {
"data": {
"type": "people",
"id": "4104"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "4104",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4046@email.com",
"title": null,
"joined_at": "2021-12-06T00:10:15.000+01:00",
"last_seen_at": "2021-12-06T00:10:15.905+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 4087,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:10:15.879+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1194"
}
},
"company": {
"data": {
"type": "companies",
"id": "6119"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "6119",
"type": "companies",
"attributes": {
"name": "Organization1194",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:10:15.878+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1194"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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-937-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": "1251"
}
},
"project": {
"data": {
"type": "projects",
"id": "937"
}
},
"company": {
"data": null
},
"project_manager": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "937",
"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-12-06T00:10:21.375+01:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1251"
}
},
"company": {
"data": {
"type": "companies",
"id": "6234"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4220"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "6234",
"type": "companies",
"attributes": {
"name": "Client4993",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:10:21.373+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1251"
}
}
}
},
{
"id": "4220",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4160@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:10:21.000+01:00",
"is_user": true,
"user_id": 4201,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:10:21.348+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1251"
}
},
"company": {
"data": {
"type": "companies",
"id": "6233"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "6233",
"type": "companies",
"attributes": {
"name": "Client4992",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:10:21.345+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1251"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get project reportsGET/api/v2/reports/project_reports
Salary Reports ¶
Supported filter params
-
ended_on
-
salary_id
-
salary_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
-
salary
-
organization
-
people_custom_fields
-
person
Supported date period dates
-
start_date
-
end_date
GET /api/v2/reports/salary_reports
Requests
GET /api/v2/reports/salary_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": "salary-report-salary-227-d41d8cd98f00b204e9800998ecf8427e",
"type": "new_salary_reports",
"attributes": {
"group": "salary",
"count": 402,
"time": 137920,
"salary_type_id": null,
"total_estimated_weekly_hours": 2400,
"overhead": 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_hourly_cost": 2500,
"total_hourly_cost_default": 2500,
"total_hourly_cost_normalized": 2500,
"total_weekly_cost": 100000,
"total_weekly_cost_default": 100000,
"total_weekly_cost_normalized": 100000,
"total_bi_weekly_cost": 200000,
"total_bi_weekly_cost_default": 200000,
"total_bi_weekly_cost_normalized": 200000,
"total_monthly_cost": 400000,
"total_monthly_cost_default": 400000,
"total_monthly_cost_normalized": 400000,
"total_annually_cost": 5200000,
"total_annually_cost_default": 5200000,
"total_annually_cost_normalized": 5200000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1297"
}
},
"person": {
"data": null
},
"salary": {
"data": {
"type": "salaries",
"id": "227"
}
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "227",
"type": "salaries",
"attributes": {
"working_days": [],
"working_hours": [
8,
8,
8,
8,
8,
0,
0
],
"salary_type_id": 2,
"started_on": "2021-11-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": "1297"
}
},
"person": {
"data": {
"type": "people",
"id": "4440"
}
}
}
},
{
"id": "4440",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4380@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:10:34.000+01:00",
"is_user": true,
"user_id": 4421,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:10:34.443+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1297"
}
},
"company": {
"data": {
"type": "companies",
"id": "6614"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "6614",
"type": "companies",
"attributes": {
"name": "Client5327",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:10:34.440+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1297"
}
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/salary_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/salary_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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get salary reportsGET/api/v2/reports/salary_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-471-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": "0.0",
"average_forecasted_time_usage": null,
"average_profit_margin": "100.0",
"average_budget_usage": "0.0",
"average_discount": null,
"section_name": 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": 125000,
"total_price_default": 125000,
"total_price_normalized": 125000,
"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": 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": 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": 0,
"total_forecasted_budget_used_default": 0,
"total_forecasted_budget_used_normalized": 0,
"total_discount_amount": 0,
"total_discount_amount_default": 0,
"total_discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1314"
}
},
"service": {
"data": {
"type": "services",
"id": "471"
}
},
"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": "471",
"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": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"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": "1314"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "707"
}
},
"deal": {
"data": {
"type": "deals",
"id": "891"
}
},
"section": {
"data": null
}
}
},
{
"id": "707",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1314"
}
}
}
},
{
"id": "891",
"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": "7ced0ee5e35561ce69856d691ba9edb3",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"budget_revamp": false,
"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,
"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": false,
"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,
"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,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1314"
}
},
"creator": {
"data": {
"type": "people",
"id": "4529"
}
},
"company": {
"data": {
"type": "companies",
"id": "6704"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "4530"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "7155"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4529",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4469@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,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 4510,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:10:41.922+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1314"
}
},
"company": {
"data": {
"type": "companies",
"id": "6703"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "6704",
"type": "companies",
"attributes": {
"name": "Client5400",
"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,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1314"
}
}
}
},
{
"id": "4530",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4470@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2020-12-01T00:00:00.000+01:00",
"is_user": true,
"user_id": 4511,
"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,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1314"
}
},
"company": {
"data": {
"type": "companies",
"id": "6705"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "7155",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1314"
}
}
}
},
{
"id": "6703",
"type": "companies",
"attributes": {
"name": "Organization1314",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:10:41.921+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1314"
}
}
}
},
{
"id": "6705",
"type": "companies",
"attributes": {
"name": "Client5401",
"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,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1314"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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-258-d41d8cd98f00b204e9800998ecf8427e",
"type": "task_reports",
"attributes": {
"group": "task",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"status": null,
"total_worked_time": 0,
"total_initial_estimate": 0,
"total_remaining_time": 0,
"total_estimation_offset_time": null,
"total_estimate_at_completion": null,
"workflow_status_category_id": 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": "1414"
}
},
"task": {
"data": {
"type": "tasks",
"id": "258"
}
},
"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
},
"workflow": {
"data": null
},
"workflow_status": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "258",
"type": "tasks",
"attributes": {
"title": "Ticket title",
"description": null,
"number": 1,
"private": false,
"due_date": null,
"start_date": null,
"closed_at": null,
"created_at": "2021-12-06T00:11:10.054+01:00",
"updated_at": "2021-12-06T00:11:10.054+01: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": "a476c0edace5e6f2c134f1fbe8a691bd",
"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,
"todo_assignee_ids": [],
"global_position": 0,
"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": "1414"
}
},
"project": {
"data": {
"type": "projects",
"id": "1100"
}
},
"creator": {
"data": {
"type": "people",
"id": "4870"
}
},
"assignee": {
"data": null
},
"last_actor": {
"data": null
},
"task_list": {
"data": {
"type": "task_lists",
"id": "246"
}
},
"parent_task": {
"data": null
},
"workflow_status": {
"data": {
"type": "workflow_statuses",
"id": "256"
}
},
"attachments": {
"data": []
}
}
},
{
"id": "1100",
"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-12-06T00:11:09.864+01:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"company": {
"data": {
"type": "companies",
"id": "7275"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4869"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "4870",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4810@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:11:09.000+01:00",
"is_user": true,
"user_id": 4851,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:11:09.885+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"company": {
"data": {
"type": "companies",
"id": "7276"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "246",
"type": "task_lists",
"attributes": {
"name": "Milestone221",
"position": 1,
"archived_at": null,
"email_key": "02fcb98629e4224424ffb7caaa4524a4"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"project": {
"data": {
"type": "projects",
"id": "1101"
}
},
"board": {
"data": {
"type": "boards",
"id": "274"
}
}
}
},
{
"id": "256",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "200"
}
}
}
},
{
"id": "7275",
"type": "companies",
"attributes": {
"name": "Client5871",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:09.862+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
}
}
},
{
"id": "4869",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4809@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:11:09.000+01:00",
"is_user": true,
"user_id": 4850,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:11:09.838+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"company": {
"data": {
"type": "companies",
"id": "7274"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "7276",
"type": "companies",
"attributes": {
"name": "Client5872",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:09.882+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
}
}
},
{
"id": "1101",
"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-12-06T00:11:09.944+01:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"company": {
"data": {
"type": "companies",
"id": "7278"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4871"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "274",
"type": "boards",
"attributes": {
"name": "Board234",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"project": {
"data": {
"type": "projects",
"id": "1102"
}
}
}
},
{
"id": "200",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "256"
}
]
}
}
},
{
"id": "7274",
"type": "companies",
"attributes": {
"name": "Client5870",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:09.834+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
}
}
},
{
"id": "7278",
"type": "companies",
"attributes": {
"name": "Client5874",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:09.942+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
}
}
},
{
"id": "4871",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4811@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:11:09.000+01:00",
"is_user": true,
"user_id": 4852,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:11:09.917+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"company": {
"data": {
"type": "companies",
"id": "7277"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "1102",
"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-12-06T00:11:09.994+01:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"company": {
"data": {
"type": "companies",
"id": "7280"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4872"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "7277",
"type": "companies",
"attributes": {
"name": "Client5873",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:09.913+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
}
}
},
{
"id": "7280",
"type": "companies",
"attributes": {
"name": "Client5876",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:09.991+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
}
}
},
{
"id": "4872",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4812@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:11:09.000+01:00",
"is_user": true,
"user_id": 4853,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:11:09.967+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
},
"company": {
"data": {
"type": "companies",
"id": "7279"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "7279",
"type": "companies",
"attributes": {
"name": "Client5875",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:09.963+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1414"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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-67-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": 0,
"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": "1468"
}
},
"time_entry": {
"data": {
"type": "time_entries",
"id": "67"
}
},
"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
},
"approver": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "67",
"type": "time_entries",
"attributes": {
"date": "2021-12-06",
"created_at": "2021-12-06T00:11:47.972+01:00",
"time": 480,
"billable_time": 480,
"note": "test note",
"track_method_id": null,
"started_at": null,
"timer_started_at": null,
"timer_stopped_at": null,
"approved": false,
"approved_at": null,
"updated_at": "2021-12-06T00:11:47.972+01: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": "1468"
}
},
"person": {
"data": {
"type": "people",
"id": "5564"
}
},
"service": {
"data": {
"type": "services",
"id": "670"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "5563"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "5564",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user5504@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:11:47.000+01:00",
"is_user": true,
"user_id": 5545,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:11:47.873+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
},
"company": {
"data": {
"type": "companies",
"id": "8360"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "670",
"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": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"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": "1468"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "906"
}
},
"deal": {
"data": {
"type": "deals",
"id": "1078"
}
},
"section": {
"data": null
}
}
},
{
"id": "5563",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user5503@email.com",
"title": null,
"joined_at": "2021-12-06T00:11:48.000+01:00",
"last_seen_at": "2021-12-06T00:11:48.001+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 5544,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:11:47.836+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
},
"company": {
"data": {
"type": "companies",
"id": "8359"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "8360",
"type": "companies",
"attributes": {
"name": "Client6902",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:47.868+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
}
}
},
{
"id": "906",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
}
}
},
{
"id": "1078",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-12-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": "82bb6a1cf39d5997739ac13a9a5b50e6",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"budget_revamp": false,
"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,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-12-06T00:11:47.943+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-12-06",
"sales_closed_on": null,
"sample_data": false,
"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,
"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,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
},
"creator": {
"data": {
"type": "people",
"id": "5563"
}
},
"company": {
"data": {
"type": "companies",
"id": "8361"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "5565"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "8090"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "8359",
"type": "companies",
"attributes": {
"name": "Organization1468",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-12-06T00:11:47.835+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
}
}
},
{
"id": "8361",
"type": "companies",
"attributes": {
"name": "Client6903",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:47.900+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
}
}
},
{
"id": "5565",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user5505@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:11:47.000+01:00",
"is_user": true,
"user_id": 5546,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:11:47.910+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
},
"company": {
"data": {
"type": "companies",
"id": "8362"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "8090",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
}
}
},
{
"id": "8362",
"type": "companies",
"attributes": {
"name": "Client6904",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:11:47.906+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1468"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"workflows": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"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-5907-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,
"total_work_cost": 0,
"total_work_cost_default": 0,
"total_work_cost_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1531"
}
},
"person": {
"data": {
"type": "people",
"id": "5907"
}
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"company": {
"data": null
},
"project": {
"data": null
},
"event": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "5907",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user5847@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:12:16.000+01:00",
"is_user": true,
"user_id": 5888,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:12:16.064+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1531"
}
},
"company": {
"data": {
"type": "companies",
"id": "8846"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "8846",
"type": "companies",
"attributes": {
"name": "Client7325",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:12:16.060+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1531"
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered"