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-09-21",
"end_date": "2021-09-21",
"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": 879
}
},
"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-09-21",
"ended_on": "2021-09-21",
"note": null,
"total_time": 0,
"total_working_days": 0,
"percentage": null,
"created_at": "2021-09-21T01:07:37.389+02:00",
"updated_at": "2021-09-21T01:07:37.389+02:00",
"people_custom_fields": null,
"approved": true,
"approved_at": "2021-09-21T01:07:37.389+02: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": 879
}
},
"service": {
"data": {
"type": "services",
"id": "185"
}
},
"event": {
"data": null
},
"person": {
"data": {
"type": "people",
"id": "2520"
}
},
"creator": {
"data": {
"type": "people",
"id": "2517"
}
},
"updater": {
"data": {
"type": "people",
"id": "2517"
}
},
"approver": {
"data": {
"type": "people",
"id": "2517"
}
},
"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": 879
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "266"
}
},
"deal": {
"data": {
"type": "deals",
"id": "342"
}
},
"section": {
"data": null
}
}
},
{
"id": "2520",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2463@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-09-21T01:07:37.000+02:00",
"is_user": true,
"user_id": 2503,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:37.338+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 879
}
},
"company": {
"data": {
"type": "companies",
"id": "3551"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2517",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2460@email.com",
"title": null,
"joined_at": "2021-09-21T01:07:37.000+02:00",
"last_seen_at": "2021-09-21T01:07:37.668+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2500,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:37.213+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 879
}
},
"company": {
"data": {
"type": "companies",
"id": "3547"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "266",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 879
}
}
}
},
{
"id": "342",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-09-21",
"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": "7a7b04fc0ef3734f1ab98eb4f7bb3986",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"global_position": 0,
"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-09-21T01:07:37.308+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-09-21",
"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": 879
}
},
"creator": {
"data": {
"type": "people",
"id": "2517"
}
},
"company": {
"data": {
"type": "companies",
"id": "3549"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2519"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "4573"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3551",
"type": "companies",
"attributes": {
"name": "Client2673",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:37.334+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 879
}
}
}
},
{
"id": "3547",
"type": "companies",
"attributes": {
"name": "Organization879",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:07:37.212+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 879
}
}
}
},
{
"id": "3549",
"type": "companies",
"attributes": {
"name": "Client2671",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:37.267+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 879
}
}
}
},
{
"id": "2519",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2462@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-09-21T01:07:37.000+02:00",
"is_user": true,
"user_id": 2502,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:37.276+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 879
}
},
"company": {
"data": {
"type": "companies",
"id": "3550"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "4573",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 879
}
}
}
},
{
"id": "3550",
"type": "companies",
"attributes": {
"name": "Client2672",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:37.272+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 879
}
}
}
}
],
"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
},
"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
}
},
"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-478-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": 915
}
},
"budget": {
"data": {
"type": "deals",
"id": "478"
}
},
"contract": {
"data": null
},
"project": {
"data": null
},
"company": {
"data": null
},
"responsible": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "478",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-09-21",
"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": "147636b54ba40964c3f905a5fddc64d9",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"global_position": 0,
"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-09-21T01:08:21.527+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-09-21",
"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": 915
}
},
"creator": {
"data": {
"type": "people",
"id": "2943"
}
},
"company": {
"data": {
"type": "companies",
"id": "4122"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2944"
}
},
"deal_status": {
"meta": {
"included": false
}
},
"project": {
"data": {
"type": "projects",
"id": "670"
}
},
"lost_reason": {
"meta": {
"included": false
}
},
"contract": {
"data": null
},
"contact": {
"meta": {
"included": false
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2943",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2886@email.com",
"title": null,
"joined_at": "2021-09-21T01:08:21.000+02:00",
"last_seen_at": "2021-09-21T01:08:21.546+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2926,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:08:21.364+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 915
}
},
"company": {
"data": {
"type": "companies",
"id": "4121"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "4122",
"type": "companies",
"attributes": {
"name": "Client3208",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:21.434+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 915
}
}
}
},
{
"id": "2944",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2887@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-09-21T01:08:21.000+02:00",
"is_user": true,
"user_id": 2927,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:08:21.443+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 915
}
},
"company": {
"data": {
"type": "companies",
"id": "4123"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "670",
"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-09-21T01:08:21.504+02: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": 915
}
},
"company": {
"data": {
"type": "companies",
"id": "4125"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2945"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "4121",
"type": "companies",
"attributes": {
"name": "Organization915",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:08:21.362+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 915
}
}
}
},
{
"id": "4123",
"type": "companies",
"attributes": {
"name": "Client3209",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:21.440+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 915
}
}
}
},
{
"id": "4125",
"type": "companies",
"attributes": {
"name": "Client3211",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:21.502+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 915
}
}
}
},
{
"id": "2945",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2888@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-09-21T01:08:21.000+02:00",
"is_user": true,
"user_id": 2928,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:08:21.475+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 915
}
},
"company": {
"data": {
"type": "companies",
"id": "4124"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "4124",
"type": "companies",
"attributes": {
"name": "Client3210",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:21.471+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 915
}
}
}
}
],
"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
},
"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
}
},
"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": 942
}
},
"company": {
"data": {
"type": "companies",
"id": "123"
}
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "123",
"type": "companies",
"attributes": {
"name": "Client3436",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:31.940+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 942
}
}
}
}
],
"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
},
"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
}
},
"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-537-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": 961
}
},
"deal": {
"data": {
"type": "deals",
"id": "537"
}
},
"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": "537",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-09-21",
"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": "9a9f9de14f8bb7b283046dfec71ed34c",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"global_position": 0,
"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-09-21T01:08:33.634+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-09-21",
"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": 961
}
},
"creator": {
"data": {
"type": "people",
"id": "3101"
}
},
"company": {
"data": {
"type": "companies",
"id": "4424"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "3102"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "5113"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3101",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3044@email.com",
"title": null,
"joined_at": "2021-09-21T01:08:33.000+02:00",
"last_seen_at": "2021-09-21T01:08:33.649+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3084,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:08:33.572+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 961
}
},
"company": {
"data": {
"type": "companies",
"id": "4423"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "4424",
"type": "companies",
"attributes": {
"name": "Client3473",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:33.593+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 961
}
}
}
},
{
"id": "3102",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3045@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-09-21T01:08:33.000+02:00",
"is_user": true,
"user_id": 3085,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:08:33.602+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 961
}
},
"company": {
"data": {
"type": "companies",
"id": "4425"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5113",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 961
}
}
}
},
{
"id": "4423",
"type": "companies",
"attributes": {
"name": "Organization961",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:08:33.571+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 961
}
}
}
},
{
"id": "4425",
"type": "companies",
"attributes": {
"name": "Client3474",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:33.599+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 961
}
}
}
}
],
"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
},
"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
}
},
"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,
"people_custom_fields": {},
"formula_fields": {},
"start_date_period": null,
"end_date_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "992"
}
},
"entitlement": {
"data": {
"type": "entitlements",
"id": "36"
}
},
"person": {
"data": null
},
"event": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "36",
"type": "entitlements",
"attributes": {
"start_date": "2021-09-20",
"end_date": "2021-10-01",
"allocated": 22,
"used": 0,
"pending": 0,
"note": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 992
}
},
"event": {
"data": {
"type": "events",
"id": "117"
}
},
"person": {
"data": {
"type": "people",
"id": "3208"
}
},
"approval_workflow": {
"data": null
}
}
},
{
"id": "117",
"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
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 992
}
}
}
},
{
"id": "3208",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3151@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-09-21T01:08:41.000+02:00",
"is_user": true,
"user_id": 3191,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:08:41.240+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 992
}
},
"company": {
"data": {
"type": "companies",
"id": "4609"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "4609",
"type": "companies",
"attributes": {
"name": "Client3627",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:41.236+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 992
}
}
}
}
],
"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
},
"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
}
},
"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": 1003
}
},
"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-09-21",
"pay_on": null,
"paid_on": null,
"position": 1,
"invoiced": false,
"approved": true,
"approved_at": "2021-09-21T01:08:43.243+02:00",
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"deleted_at": null,
"reimbursable": null,
"reimbursed_on": null,
"exchange_rate": "1.25",
"exchange_date": "2021-09-21",
"created_at": "2021-09-21T01:08:43.244+02:00",
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000,
"billable_amount": 0,
"billable_amount_default": 0,
"billable_amount_normalized": 0,
"profit": -10000,
"profit_default": -12500,
"profit_normalized": -10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1003
}
},
"deal": {
"data": {
"type": "deals",
"id": "604"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "405"
}
},
"person": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "3241"
}
},
"approver": {
"data": {
"type": "people",
"id": "3242"
}
},
"rejecter": {
"data": null
},
"vendor": {
"data": null
},
"service": {
"data": null
},
"attachment": {
"data": null
}
}
},
{
"id": "604",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-09-21",
"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": "862b74f54d6e8515d6387bedb2a7ba86",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"global_position": 0,
"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-09-21T01:08:43.159+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-09-21",
"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": 1003
}
},
"creator": {
"data": {
"type": "people",
"id": "3241"
}
},
"company": {
"data": {
"type": "companies",
"id": "4643"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "3242"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "5386"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "405",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1003
}
}
}
},
{
"id": "3241",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3184@email.com",
"title": null,
"joined_at": "2021-09-21T01:08:43.000+02:00",
"last_seen_at": "2021-09-21T01:08:43.276+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3224,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:08:43.082+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1003
}
},
"company": {
"data": {
"type": "companies",
"id": "4642"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "3242",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3185@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-09-21T01:08:43.000+02:00",
"is_user": true,
"user_id": 3225,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:08:43.123+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1003
}
},
"company": {
"data": {
"type": "companies",
"id": "4644"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "4643",
"type": "companies",
"attributes": {
"name": "Client3650",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:43.112+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1003
}
}
}
},
{
"id": "5386",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1003
}
}
}
},
{
"id": "4642",
"type": "companies",
"attributes": {
"name": "Organization1003",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:08:43.080+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1003
}
}
}
},
{
"id": "4644",
"type": "companies",
"attributes": {
"name": "Client3651",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:08:43.118+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1003
}
}
}
}
],
"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
},
"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
}
},
"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-09-21",
"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_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": 1048
}
},
"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-09-21",
"created_at": "2021-09-21T01:09:06.942+02: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-09-21T01:09:06.942+02:00",
"calendar_event_id": null,
"invoiced": false,
"overhead": false,
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"overhead_cost": 0,
"overhead_cost_default": 0,
"overhead_cost_normalized": 0,
"internal_overhead_cost": 0,
"internal_overhead_cost_default": 0,
"internal_overhead_cost_normalized": 0,
"facility_overhead_cost": 0,
"facility_overhead_cost_default": 0,
"facility_overhead_cost_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
},
"person": {
"data": {
"type": "people",
"id": "3499"
}
},
"service": {
"data": {
"type": "services",
"id": "418"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "3498"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "3499",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3442@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-09-21T01:09:06.000+02:00",
"is_user": true,
"user_id": 3482,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:09:06.839+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
},
"company": {
"data": {
"type": "companies",
"id": "5114"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "418",
"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": 1048
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "594"
}
},
"deal": {
"data": {
"type": "deals",
"id": "792"
}
},
"section": {
"data": null
}
}
},
{
"id": "3498",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3441@email.com",
"title": null,
"joined_at": "2021-09-21T01:09:06.000+02:00",
"last_seen_at": "2021-09-21T01:09:06.971+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3481,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:09:06.810+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
},
"company": {
"data": {
"type": "companies",
"id": "5113"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5114",
"type": "companies",
"attributes": {
"name": "Client4076",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:09:06.836+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
}
}
},
{
"id": "594",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
}
}
},
{
"id": "792",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-09-21",
"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": "e83413f69f16ddb779e5358343757606",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"global_position": 0,
"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-09-21T01:09:06.912+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-09-21",
"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": 1048
}
},
"creator": {
"data": {
"type": "people",
"id": "3498"
}
},
"company": {
"data": {
"type": "companies",
"id": "5115"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "3500"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "5783"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "5113",
"type": "companies",
"attributes": {
"name": "Organization1048",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:09:06.809+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
}
}
},
{
"id": "5115",
"type": "companies",
"attributes": {
"name": "Client4077",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:09:06.867+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
}
}
},
{
"id": "3500",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3443@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-09-21T01:09:06.000+02:00",
"is_user": true,
"user_id": 3483,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:09:06.877+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
},
"company": {
"data": {
"type": "companies",
"id": "5116"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5783",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
}
}
},
{
"id": "5116",
"type": "companies",
"attributes": {
"name": "Client4078",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:09:06.873+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1048
}
}
}
}
],
"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
},
"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
}
},
"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-67-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": 1049
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "67"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "67",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-09-21",
"sent_on": null,
"pay_on": "2021-10-01",
"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": "952f84d14715d7ac0067e95a2bc86ea7",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-09-21T01:09:07.383+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-09-21",
"custom_fields": null,
"updated_at": "2021-09-21T01:09:07.383+02: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": 1049
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "5118"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "25"
}
},
"creator": {
"data": {
"type": "people",
"id": "3501"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "5118",
"type": "companies",
"attributes": {
"name": "Client4079",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:09:07.373+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1049
}
}
}
},
{
"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": 1049
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "136"
}
},
"document_style": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "3501",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3444@email.com",
"title": null,
"joined_at": "2021-09-21T01:09:07.000+02:00",
"last_seen_at": "2021-09-21T01:09:07.413+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3484,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:09:07.322+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1049
}
},
"company": {
"data": {
"type": "companies",
"id": "5117"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "136",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary136",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1049
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "5117",
"type": "companies",
"attributes": {
"name": "Organization1049",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:09:07.320+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1049
}
}
}
}
],
"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
},
"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
}
},
"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": 1096
}
},
"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-09-21",
"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": 1096
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "878"
}
}
}
},
{
"id": "878",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-09-21",
"sent_on": null,
"pay_on": "2021-10-01",
"delivery_on": null,
"paid_on": "2021-09-21",
"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": "368d089360c0db19644b04f847af9417",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-09-21T01:09:17.521+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-09-21",
"custom_fields": null,
"updated_at": "2021-09-21T01:09:17.534+02: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": 1096
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "5308"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "74"
}
},
"creator": {
"data": {
"type": "people",
"id": "3572"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "5308",
"type": "companies",
"attributes": {
"name": "Client4222",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:09:17.516+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1096
}
}
}
},
{
"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": 1096
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "185"
}
},
"document_style": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "3572",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3515@email.com",
"title": null,
"joined_at": "2021-09-21T01:09:17.000+02:00",
"last_seen_at": "2021-09-21T01:09:17.549+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3555,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:09:17.485+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1096
}
},
"company": {
"data": {
"type": "companies",
"id": "5307"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "185",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary185",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1096
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "5307",
"type": "companies",
"attributes": {
"name": "Organization1096",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:09:17.483+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1096
}
}
}
}
],
"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
},
"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
}
},
"settings": {}
}
}Get payment reportsGET/api/v2/reports/payment_reports
Person Reports ¶
Supported filter params
Supported filter params can be found on people endpoint
Supported group params
-
person
-
company
-
subsidiary
-
role_id
-
type
-
status
-
organization
-
custom_fields
Supported date period dates
-
created_at
-
joined_at
GET /api/v2/reports/person_reports
Requests
GET /api/v2/reports/person_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "person-report-person-3614-d41d8cd98f00b204e9800998ecf8427e",
"type": "person_reports",
"attributes": {
"group": "person",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"role_id": null,
"status": null,
"type": null,
"custom_fields": {},
"contact_phone": null,
"contact_email": null,
"contact_website": null,
"contact_city": null,
"contact_state": null,
"contact_country": null,
"contact_zipcode": null,
"contact_address": null,
"created_at_period": null,
"joined_at_period": null,
"deactivated_at_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1118
}
},
"person": {
"data": {
"type": "people",
"id": "3614"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "3614",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3557@email.com",
"title": null,
"joined_at": "2021-09-21T01:09:22.000+02:00",
"last_seen_at": "2021-09-21T01:09:22.335+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 3597,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:09:22.308+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1118
}
},
"company": {
"data": {
"type": "companies",
"id": "5402"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5402",
"type": "companies",
"attributes": {
"name": "Organization1118",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:09:22.307+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1118
}
}
}
}
],
"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
},
"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
}
},
"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-771-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": 1175
}
},
"project": {
"data": {
"type": "projects",
"id": "771"
}
},
"company": {
"data": null
},
"project_manager": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "771",
"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-09-21T01:09:29.896+02: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": 1175
}
},
"company": {
"data": {
"type": "companies",
"id": "5517"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3730"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "5517",
"type": "companies",
"attributes": {
"name": "Client4352",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:09:29.893+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1175
}
}
}
},
{
"id": "3730",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3671@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-09-21T01:09:29.000+02:00",
"is_user": true,
"user_id": 3711,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:09:29.857+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1175
}
},
"company": {
"data": {
"type": "companies",
"id": "5516"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5516",
"type": "companies",
"attributes": {
"name": "Client4351",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:09:29.852+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1175
}
}
}
}
],
"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
},
"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
}
},
"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": 478,
"time": 163840,
"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": 1212
}
},
"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-09-11",
"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": 1212
}
},
"person": {
"data": {
"type": "people",
"id": "3923"
}
}
}
},
{
"id": "3923",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3864@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-09-21T01:09:43.000+02:00",
"is_user": true,
"user_id": 3904,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:09:43.363+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1212
}
},
"company": {
"data": {
"type": "companies",
"id": "5852"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5852",
"type": "companies",
"attributes": {
"name": "Client4650",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:09:43.359+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1212
}
}
}
}
],
"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
},
"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
}
},
"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-453-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,
"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": 1229
}
},
"service": {
"data": {
"type": "services",
"id": "453"
}
},
"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": "453",
"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": 1229
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "669"
}
},
"deal": {
"data": {
"type": "deals",
"id": "845"
}
},
"section": {
"data": null
}
}
},
{
"id": "669",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1229
}
}
}
},
{
"id": "845",
"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": "d5505ece2af03ad1d77effc244df7ca1",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"global_position": 0,
"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": 1229
}
},
"creator": {
"data": {
"type": "people",
"id": "4012"
}
},
"company": {
"data": {
"type": "companies",
"id": "5942"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "4013"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "6689"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4012",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3953@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": 3993,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:09:52.135+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1229
}
},
"company": {
"data": {
"type": "companies",
"id": "5941"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "5942",
"type": "companies",
"attributes": {
"name": "Client4723",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-01T00:00:00.000+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1229
}
}
}
},
{
"id": "4013",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3954@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": 3994,
"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
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1229
}
},
"company": {
"data": {
"type": "companies",
"id": "5943"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "6689",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1229
}
}
}
},
{
"id": "5941",
"type": "companies",
"attributes": {
"name": "Organization1229",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:09:52.134+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1229
}
}
}
},
{
"id": "5943",
"type": "companies",
"attributes": {
"name": "Client4724",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-01T00:00:00.000+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1229
}
}
}
}
],
"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
},
"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
}
},
"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-195-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,
"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": 1314
}
},
"task": {
"data": {
"type": "tasks",
"id": "195"
}
},
"project": {
"data": null
},
"task_list": {
"data": null
},
"board": {
"data": null
},
"assignee": {
"data": null
},
"creator": {
"data": null
},
"last_actor": {
"data": null
},
"company": {
"data": null
},
"parent_task": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "195",
"type": "tasks",
"attributes": {
"title": "Ticket title",
"description": null,
"number": 1,
"private": false,
"due_date": null,
"start_date": null,
"closed_at": null,
"created_at": "2021-09-21T01:10:19.236+02:00",
"updated_at": "2021-09-21T01:10:19.236+02:00",
"repeat_schedule_id": null,
"repeat_on_interval": null,
"repeat_on_monthday": null,
"repeat_on_weekday": [],
"repeat_on_date": null,
"repeat_origin_id": null,
"email_key": "d31a59d47eb7dd3ca4f63d54579ee859",
"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,
"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": 1314
}
},
"project": {
"data": {
"type": "projects",
"id": "934"
}
},
"creator": {
"data": {
"type": "people",
"id": "4300"
}
},
"assignee": {
"data": null
},
"last_actor": {
"data": null
},
"task_list": {
"data": {
"type": "task_lists",
"id": "195"
}
},
"parent_task": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "934",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-09-21T01:10:19.042+02: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": 1314
}
},
"company": {
"data": {
"type": "companies",
"id": "6422"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4299"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "4300",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4241@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-09-21T01:10:19.000+02:00",
"is_user": true,
"user_id": 4281,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:10:19.067+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
},
"company": {
"data": {
"type": "companies",
"id": "6423"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "195",
"type": "task_lists",
"attributes": {
"name": "Milestone170",
"position": 1,
"archived_at": null,
"email_key": "63fbbe4cc8258ae8bbe65b0b9dc1a398"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
},
"project": {
"data": {
"type": "projects",
"id": "935"
}
},
"board": {
"data": {
"type": "boards",
"id": "223"
}
}
}
},
{
"id": "6422",
"type": "companies",
"attributes": {
"name": "Client5118",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:10:19.039+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
}
}
},
{
"id": "4299",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4240@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-09-21T01:10:19.000+02:00",
"is_user": true,
"user_id": 4280,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:10:19.009+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
},
"company": {
"data": {
"type": "companies",
"id": "6421"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "6423",
"type": "companies",
"attributes": {
"name": "Client5119",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:10:19.063+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
}
}
},
{
"id": "935",
"type": "projects",
"attributes": {
"name": "test project",
"number": 2,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-09-21T01:10:19.130+02: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": 1314
}
},
"company": {
"data": {
"type": "companies",
"id": "6425"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4301"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "223",
"type": "boards",
"attributes": {
"name": "Board183",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
},
"project": {
"data": {
"type": "projects",
"id": "936"
}
}
}
},
{
"id": "6421",
"type": "companies",
"attributes": {
"name": "Client5117",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:10:19.005+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
}
}
},
{
"id": "6425",
"type": "companies",
"attributes": {
"name": "Client5121",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:10:19.127+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
}
}
},
{
"id": "4301",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4242@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-09-21T01:10:19.000+02:00",
"is_user": true,
"user_id": 4282,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:10:19.101+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
},
"company": {
"data": {
"type": "companies",
"id": "6424"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "936",
"type": "projects",
"attributes": {
"name": "test project",
"number": 3,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-09-21T01:10:19.182+02: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": 1314
}
},
"company": {
"data": {
"type": "companies",
"id": "6427"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4302"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "6424",
"type": "companies",
"attributes": {
"name": "Client5120",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:10:19.097+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
}
}
},
{
"id": "6427",
"type": "companies",
"attributes": {
"name": "Client5123",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:10:19.180+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
}
}
},
{
"id": "4302",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4243@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-09-21T01:10:19.000+02:00",
"is_user": true,
"user_id": 4283,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:10:19.154+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1314
}
},
"company": {
"data": {
"type": "companies",
"id": "6426"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "6426",
"type": "companies",
"attributes": {
"name": "Client5122",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:10:19.150+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": 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/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
},
"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
}
},
"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": 1368
}
},
"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-09-21",
"created_at": "2021-09-21T01:11:01.748+02: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-09-21T01:11:01.748+02:00",
"calendar_event_id": null,
"invoiced": false,
"overhead": false,
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"overhead_cost": 0,
"overhead_cost_default": 0,
"overhead_cost_normalized": 0,
"internal_overhead_cost": 0,
"internal_overhead_cost_default": 0,
"internal_overhead_cost_normalized": 0,
"facility_overhead_cost": 0,
"facility_overhead_cost_default": 0,
"facility_overhead_cost_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
},
"person": {
"data": {
"type": "people",
"id": "4994"
}
},
"service": {
"data": {
"type": "services",
"id": "622"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "4993"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "4994",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4935@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-09-21T01:11:01.000+02:00",
"is_user": true,
"user_id": 4975,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:11:01.619+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
},
"company": {
"data": {
"type": "companies",
"id": "7507"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "622",
"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": 1368
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "838"
}
},
"deal": {
"data": {
"type": "deals",
"id": "994"
}
},
"section": {
"data": null
}
}
},
{
"id": "4993",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4934@email.com",
"title": null,
"joined_at": "2021-09-21T01:11:01.000+02:00",
"last_seen_at": "2021-09-21T01:11:01.779+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 4974,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:11:01.585+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
},
"company": {
"data": {
"type": "companies",
"id": "7506"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "7507",
"type": "companies",
"attributes": {
"name": "Client6149",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:11:01.615+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
}
}
},
{
"id": "838",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null,
"description": "test description"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
}
}
},
{
"id": "994",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-09-21",
"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": "54d0f69012fc4c8505e9cca62d9bded0",
"purchase_order_number": null,
"custom_fields": null,
"position": null,
"global_position": 0,
"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-09-21T01:11:01.718+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-09-21",
"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": 1368
}
},
"creator": {
"data": {
"type": "people",
"id": "4993"
}
},
"company": {
"data": {
"type": "companies",
"id": "7508"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "4995"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "7511"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "7506",
"type": "companies",
"attributes": {
"name": "Organization1368",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:11:01.583+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
}
}
},
{
"id": "7508",
"type": "companies",
"attributes": {
"name": "Client6150",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:11:01.663+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
}
}
},
{
"id": "4995",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4936@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-09-21T01:11:01.000+02:00",
"is_user": true,
"user_id": 4976,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:11:01.676+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
},
"company": {
"data": {
"type": "companies",
"id": "7509"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "7511",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
}
}
},
{
"id": "7509",
"type": "companies",
"attributes": {
"name": "Client6151",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:11:01.672+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1368
}
}
}
}
],
"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
},
"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
}
},
"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-5337-d41d8cd98f00b204e9800998ecf8427e",
"type": "new_time_reports",
"attributes": {
"group": "person",
"year": null,
"quarter": null,
"month": null,
"week": null,
"day": null,
"count": 1,
"future": null,
"people_custom_fields": {},
"formula_fields": {},
"date_period": null,
"capacity": 0,
"available_time": 0,
"scheduled_time": 0,
"scheduled_internal_time": 0,
"scheduled_client_time": 0,
"scheduled_event_time": "0.0",
"internal_time": 0,
"client_time": 480,
"billable_time": 0,
"unapproved_time": 480,
"worked_time": 480,
"paid_event_time": 0,
"unpaid_event_time": 0,
"event_time": 0,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1431
}
},
"person": {
"data": {
"type": "people",
"id": "5337"
}
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"company": {
"data": null
},
"project": {
"data": null
},
"event": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "5337",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user5278@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-09-21T01:11:31.000+02:00",
"is_user": true,
"user_id": 5318,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:11:31.284+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1431
}
},
"company": {
"data": {
"type": "companies",
"id": "7993"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "7993",
"type": "companies",
"attributes": {
"name": "Client6572",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:11:31.280+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1431
}
}
}
}
],
"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",
"limit": 10
},
"scheduling_placeholders": {
"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
}
},
"settings": {}
}
}Get time reportsGET/api/v2/reports/time_reports
Generated by aglio on 20 Sep 2021