API Documentation
Reports ¶
/reports endpoints are routes that support multigrouping.
For each report, there are listed supported group parameters. Available filters are the same as for the source object (task report has all the filters available for tasks). All reports endpoints support filter operations.
Example for passing a group param: /reports/task_reports?group=organization,task.
All /reports endpoints support grouping by date period. Available date periods for grouping are: year, quarter, month, week and day. Grouping by date period can be done like this: reports/task_reports?group=organization,created_at:month,task. For each report endpoint, there is a list of supported dates which can be used for grouping by date period.
Booking Reports ¶
Supported group params
-
booking
-
person
-
service
-
event
-
service_type
-
pricing_type_id
-
budget
-
project
-
responsible
-
company
-
project_type
-
organization
-
people_custom_fields
Supported date period dates
- date
GET /api/v2/reports/booking_reports
Requests
GET /api/v2/reports/booking_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "booking-report-booking-73-d41d8cd98f00b204e9800998ecf8427e",
"type": "booking_reports",
"attributes": {
"group": "booking",
"count": 1,
"time": 640,
"start_date": "2020-12-02",
"end_date": "2020-12-02",
"pricing_type_id": null,
"project_type": null,
"total_recognized_time": null,
"average_recognized_margin": null,
"people_custom_fields": {},
"formula_fields": {},
"date_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"average_blended_rate": null,
"average_blended_rate_default": null,
"average_blended_rate_normalized": null,
"total_recognized_revenue": null,
"total_recognized_revenue_default": null,
"total_recognized_revenue_normalized": null,
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_recognized_profit": null,
"total_recognized_profit_default": null,
"total_recognized_profit_normalized": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"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": "2020-12-02",
"ended_on": "2020-12-02",
"note": null,
"total_time": 0,
"total_working_days": 0,
"percentage": null,
"created_at": "2020-12-02T09:47:48.597+01:00",
"updated_at": "2020-12-02T09:47:48.597+01:00",
"people_custom_fields": null,
"approved": true,
"approved_at": "2020-12-02T09:47:48.597+01:00",
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"canceled": false,
"canceled_at": null,
"booking_method_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"service": {
"data": {
"type": "services",
"id": "25"
}
},
"event": {
"data": null
},
"person": {
"data": {
"type": "people",
"id": "1473"
}
},
"creator": {
"data": {
"type": "people",
"id": "1470"
}
},
"updater": {
"data": {
"type": "people",
"id": "1470"
}
},
"approver": {
"data": {
"type": "people",
"id": "1470"
}
},
"rejecter": {
"data": null
},
"canceler": {
"data": null
},
"origin": {
"data": null
}
}
},
{
"id": "25",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"pricing_type_id": 1,
"worked_time": 0,
"unapproved_time": 0,
"billable_time": 0,
"estimated_time": null,
"booked_time": 0,
"budgeted_time": 0,
"profit_margin": 100,
"unit_id": 2,
"quantity": "1.0",
"discount": null,
"future_booked_time": 0,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null,
"price": 100000,
"price_default": 125000,
"price_normalized": 100000,
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"discount_amount": 0,
"discount_amount_default": 0,
"discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "84"
}
},
"deal": {
"data": {
"type": "deals",
"id": "134"
}
},
"section": {
"data": null
}
}
},
{
"id": "1473",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1422@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:47:48.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:47:48.568+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"company": {
"data": {
"type": "companies",
"id": "1941"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1470",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1419@email.com",
"title": null,
"joined_at": "2020-12-02T09:47:48.000+01:00",
"last_seen_at": "2020-12-02T09:47:48.849+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:47:48.435+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"company": {
"data": {
"type": "companies",
"id": "1937"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "84",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
}
}
},
{
"id": "134",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-12-02",
"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": "9ae922dcc99eb6cd07fa5d172c17ae13",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 200,
"forecasted_time_usage": 0,
"budget_usage": 100,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-12-02T09:47:48.529+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"services_revenue": 100000,
"services_revenue_default": 125000,
"services_revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 100000,
"pending_invoicing_default": 125000,
"pending_invoicing_normalized": 100000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 100000,
"forecasted_revenue_default": 125000,
"forecasted_revenue_normalized": 100000,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 100000,
"forecasted_profit_default": 125000,
"forecasted_profit_normalized": 100000,
"forecasted_budget_used": 200000,
"forecasted_budget_used_default": 250000,
"forecasted_budget_used_normalized": 200000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"creator": {
"data": {
"type": "people",
"id": "1470"
}
},
"company": {
"data": {
"type": "companies",
"id": "1939"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1472"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "3069"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1941",
"type": "companies",
"attributes": {
"name": "Client1343",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:47:48.564+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1937",
"type": "companies",
"attributes": {
"name": "Organization599",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:47:48.434+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1939",
"type": "companies",
"attributes": {
"name": "Client1341",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:47:48.490+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1472",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1421@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:47:48.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:47:48.499+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"company": {
"data": {
"type": "companies",
"id": "1940"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3069",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
}
}
},
{
"id": "1940",
"type": "companies",
"attributes": {
"name": "Client1342",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:47:48.496+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 599
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/booking_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/booking_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get booking reportsGET/api/v2/reports/booking_reports
Budget Reports ¶
Supported group params
-
budget
-
company
-
responsible
-
subsidiary
-
contract
-
project
-
status
-
project_type
-
organization
-
recurring
-
custom_fields
Supported date period dates
-
date
-
created_at
-
closed_at
-
end_date
-
last_activity_at
-
delivered_on
GET /api/v2/reports/budget_reports
Requests
GET /api/v2/reports/budget_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "budget-report-budget-270-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": 635
}
},
"budget": {
"data": {
"type": "deals",
"id": "270"
}
},
"contract": {
"data": null
},
"project": {
"data": null
},
"company": {
"data": null
},
"responsible": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "270",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-12-02",
"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": "2718fb6d0790041faeb7139581ebcb85",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"future_booked_time": 0,
"probability": 100,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-12-02T09:48:40.530+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"creator": {
"data": {
"type": "people",
"id": "1896"
}
},
"company": {
"data": {
"type": "companies",
"id": "2512"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "1897"
}
},
"deal_status": {
"meta": {
"included": false
}
},
"project": {
"data": {
"type": "projects",
"id": "310"
}
},
"lost_reason": {
"meta": {
"included": false
}
},
"contract": {
"data": null
},
"contact": {
"meta": {
"included": false
}
}
}
},
{
"id": "1896",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1845@email.com",
"title": null,
"joined_at": "2020-12-02T09:48:40.000+01:00",
"last_seen_at": "2020-12-02T09:48:40.551+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:48:40.372+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"company": {
"data": {
"type": "companies",
"id": "2511"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2512",
"type": "companies",
"attributes": {
"name": "Client1878",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:48:40.441+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1897",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1846@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:48:40.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:48:40.452+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"company": {
"data": {
"type": "companies",
"id": "2513"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "310",
"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": "2020-12-02T09:48:40.509+01:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"company": {
"data": {
"type": "companies",
"id": "2515"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1898"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "2511",
"type": "companies",
"attributes": {
"name": "Organization635",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:48:40.370+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2513",
"type": "companies",
"attributes": {
"name": "Client1879",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:48:40.448+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2515",
"type": "companies",
"attributes": {
"name": "Client1881",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:48:40.507+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1898",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1847@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:48:40.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:48:40.483+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"company": {
"data": {
"type": "companies",
"id": "2514"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2514",
"type": "companies",
"attributes": {
"name": "Client1880",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:48:40.479+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 635
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/budget_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/budget_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get budget reportsGET/api/v2/reports/budget_reports
Company Reports ¶
Supported group params
-
company, key: :company_id
-
status
-
organization
-
custom_fields
Supported date period dates
- created_at
GET /api/v2/reports/company_reports
Requests
GET /api/v2/reports/company_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "company-report-company-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": 662
}
},
"company": {
"data": {
"type": "companies",
"id": "123"
}
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "123",
"type": "companies",
"attributes": {
"name": "Client2106",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:48:52.053+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 662
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/company_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/company_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get company reportsGET/api/v2/reports/company_reports
Deal Reports ¶
Supported group params
-
deal
-
company
-
responsible
-
subsidiary
-
sales_status_id
-
deal_status
-
lost_reason
-
organization
-
custom_fields
-
contact
Supported date period dates
-
date
-
created_at
-
last_activity_at
-
sales_status_updated_at
-
sales_closed_at
GET /api/v2/reports/deal_reports
Requests
GET /api/v2/reports/deal_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "deal-report-deal-329-d41d8cd98f00b204e9800998ecf8427e",
"type": "deal_reports",
"attributes": {
"group": "deal",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"sales_status_id": null,
"total_worked_time": 0,
"total_billable_time": 0,
"total_estimated_time": 0,
"total_budgeted_time": 0,
"total_estimated_remaining_time": 0,
"custom_fields": {},
"formula_fields": {},
"date_period": null,
"created_at_period": null,
"last_activity_at_period": null,
"sales_closed_at_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_revenue": 0,
"total_revenue_default": 0,
"total_revenue_normalized": 0,
"total_services_revenue": 0,
"total_services_revenue_default": 0,
"total_services_revenue_normalized": 0,
"total_projected_revenue": 0,
"total_projected_revenue_default": 0,
"total_projected_revenue_normalized": 0,
"total_work_cost": 0,
"total_work_cost_default": 0,
"total_work_cost_normalized": 0,
"total_expense": 0,
"total_expense_default": 0,
"total_expense_normalized": 0,
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_profit": 0,
"total_profit_default": 0,
"total_profit_normalized": 0,
"total_budget_total": 0,
"total_budget_total_default": 0,
"total_budget_total_normalized": 0,
"total_budget_used": 0,
"total_budget_used_default": 0,
"total_budget_used_normalized": 0,
"total_invoiced": 0,
"total_invoiced_default": 0,
"total_invoiced_normalized": 0,
"total_pending_invoicing": 0,
"total_pending_invoicing_default": 0,
"total_pending_invoicing_normalized": 0,
"average_actual_rate": 0,
"average_actual_rate_default": 0,
"average_actual_rate_normalized": 0,
"average_rate": 0,
"average_rate_default": 0,
"average_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
},
"deal": {
"data": {
"type": "deals",
"id": "329"
}
},
"company": {
"data": null
},
"responsible": {
"data": null
},
"subsidiary": {
"data": null
},
"deal_status": {
"data": null
},
"lost_reason": {
"data": null
},
"contact": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "329",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-12-02",
"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": "8e6c1eaf76ea1474cae87706cb29b4cb",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-12-02T09:48:54.343+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
},
"creator": {
"data": {
"type": "people",
"id": "2054"
}
},
"company": {
"data": {
"type": "companies",
"id": "2814"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2055"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "3609"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "2054",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2003@email.com",
"title": null,
"joined_at": "2020-12-02T09:48:54.000+01:00",
"last_seen_at": "2020-12-02T09:48:54.368+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:48:54.226+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
},
"company": {
"data": {
"type": "companies",
"id": "2813"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2814",
"type": "companies",
"attributes": {
"name": "Client2143",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:48:54.260+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2055",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2004@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:48:54.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:48:54.300+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
},
"company": {
"data": {
"type": "companies",
"id": "2815"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3609",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
}
}
},
{
"id": "2813",
"type": "companies",
"attributes": {
"name": "Organization681",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:48:54.224+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2815",
"type": "companies",
"attributes": {
"name": "Client2144",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:48:54.294+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/deal_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/deal_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get deal reportsGET/api/v2/reports/deal_reports
Expense Reports ¶
Supported group params
-
expense
-
deal
-
service_type
-
project
-
company
-
person
-
responsible
-
status
-
invoiced
-
approval_status
-
reimbursement
-
organization
-
vendor
Supported date period dates
-
date
-
pay_on
-
paid_on
GET /api/v2/reports/expense_reports
Requests
GET /api/v2/reports/expense_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "expense-report-expense-42-d41d8cd98f00b204e9800998ecf8427e",
"type": "expense_reports",
"attributes": {
"group": "expense",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"status": null,
"quote_type": null,
"invoiced": false,
"approval_status": null,
"average_profit_margin": null,
"reimbursement": null,
"date_period": null,
"pay_on_period": null,
"paid_on_period": null,
"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": 712
}
},
"expense": {
"data": {
"type": "expenses",
"id": "42"
}
},
"deal": {
"data": null
},
"project": {
"data": null
},
"company": {
"data": null
},
"service_type": {
"data": null
},
"vendor": {
"data": null
},
"person": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "42",
"type": "expenses",
"attributes": {
"name": "Višak",
"date": "2020-12-02",
"pay_on": null,
"paid_on": null,
"position": 1,
"invoiced": false,
"approved": true,
"approved_at": "2020-12-02T09:49:05.352+01:00",
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"deleted_at": null,
"reimbursable": null,
"reimbursed_on": null,
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"created_at": "2020-12-02T09:49:05.353+01:00",
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000,
"billable_amount": 0,
"billable_amount_default": 0,
"billable_amount_normalized": 0,
"profit": -10000,
"profit_default": -12500,
"profit_normalized": -10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 712
}
},
"deal": {
"data": {
"type": "deals",
"id": "396"
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "222"
}
},
"person": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "2160"
}
},
"approver": {
"data": {
"type": "people",
"id": "2161"
}
},
"rejecter": {
"data": null
},
"vendor": {
"data": null
},
"attachment": {
"data": null
}
}
},
{
"id": "396",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-12-02",
"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": "9c17994a8e4f9dd135cfe27a2ac78451",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-12-02T09:49:05.338+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 10000,
"cost_default": 12500,
"cost_normalized": 10000,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": -10000,
"profit_default": -12500,
"profit_normalized": -10000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"expense": 10000,
"expense_default": 12500,
"expense_normalized": 10000,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 10000,
"forecasted_cost_default": 12500,
"forecasted_cost_normalized": 10000,
"forecasted_profit": -10000,
"forecasted_profit_default": -12500,
"forecasted_profit_normalized": -10000,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 712
}
},
"creator": {
"data": {
"type": "people",
"id": "2160"
}
},
"company": {
"data": {
"type": "companies",
"id": "2999"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2161"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "3827"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "222",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 712
}
}
}
},
{
"id": "2160",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2109@email.com",
"title": null,
"joined_at": "2020-12-02T09:49:05.000+01:00",
"last_seen_at": "2020-12-02T09:49:05.387+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:49:05.259+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 712
}
},
"company": {
"data": {
"type": "companies",
"id": "2998"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2161",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2110@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:49:05.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:49:05.299+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 712
}
},
"company": {
"data": {
"type": "companies",
"id": "3000"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "2999",
"type": "companies",
"attributes": {
"name": "Client2297",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:49:05.287+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 712
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3827",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 712
}
}
}
},
{
"id": "2998",
"type": "companies",
"attributes": {
"name": "Organization712",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:49:05.258+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 712
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3000",
"type": "companies",
"attributes": {
"name": "Client2298",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:49:05.294+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 712
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/expense_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/expense_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get expense reportsGET/api/v2/reports/expense_reports
Finanacial Item Reports ¶
Supported group params
-
financial_item
-
person
-
service
-
service_type
-
budget
-
project
-
company
-
pricing_type
-
project_type
-
future
-
organization
Supported date period dates
- date
GET /api/v2/reports/financial_item_reports
Requests
GET /api/v2/reports/financial_item_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "financial-item-report-financial_item-time_entry-9-d41d8cd98f00b204e9800998ecf8427e",
"type": "financial_item_reports",
"attributes": {
"group": "financial_item",
"financial_item_id": 9,
"financial_item_type": "time_entry",
"financial_item_date": "2020-12-02",
"total_time": 480,
"total_billable_time": 480,
"total_recognized_time": null,
"pricing_type_id": null,
"project_type_id": null,
"average_profit_margin": null,
"average_recognized_margin": null,
"future": null,
"approval_status": null,
"date_period": null,
"formula_fields": {},
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_revenue": null,
"total_revenue_default": null,
"total_revenue_normalized": null,
"total_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_profit": null,
"total_profit_default": null,
"total_profit_normalized": null,
"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": 759
}
},
"person": {
"data": null
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"company": {
"data": null
},
"project": {
"data": null
},
"time_entry": {
"data": {
"type": "time_entries",
"id": "9"
}
},
"booking_item": {
"data": null
},
"expense": {
"data": null
},
"invoice_attribution": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "9",
"type": "time_entries",
"attributes": {
"date": "2020-12-02",
"created_at": "2020-12-02T09:49:27.835+01:00",
"time": 480,
"billable_time": 480,
"note": "test note",
"track_method_id": 1,
"tracking_type_id": null,
"started_at": null,
"timer_started_at": null,
"timer_stopped_at": null,
"approved": false,
"approved_at": null,
"updated_at": "2020-12-02T09:49:27.835+01:00",
"invoiced": false,
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"overhead_cost": 0,
"overhead_cost_default": 0,
"overhead_cost_normalized": 0,
"internal_overhead_cost": 0,
"internal_overhead_cost_default": 0,
"internal_overhead_cost_normalized": 0,
"facility_overhead_cost": 0,
"facility_overhead_cost_default": 0,
"facility_overhead_cost_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"person": {
"data": {
"type": "people",
"id": "2329"
}
},
"service": {
"data": {
"type": "services",
"id": "163"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "2328"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "2329",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2278@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:49:27.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:49:27.654+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"company": {
"data": {
"type": "companies",
"id": "3290"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "163",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"pricing_type_id": 1,
"worked_time": 480,
"unapproved_time": 480,
"billable_time": 0,
"estimated_time": null,
"booked_time": 0,
"budgeted_time": 0,
"profit_margin": 100,
"unit_id": 2,
"quantity": "1.0",
"discount": null,
"future_booked_time": 0,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null,
"price": 100000,
"price_default": 125000,
"price_normalized": 100000,
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"discount_amount": 0,
"discount_amount_default": 0,
"discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "321"
}
},
"deal": {
"data": {
"type": "deals",
"id": "493"
}
},
"section": {
"data": null
}
}
},
{
"id": "2328",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2277@email.com",
"title": null,
"joined_at": "2020-12-02T09:49:27.000+01:00",
"last_seen_at": "2020-12-02T09:49:27.902+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:49:27.610+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"company": {
"data": {
"type": "companies",
"id": "3289"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3290",
"type": "companies",
"attributes": {
"name": "Client2541",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:49:27.647+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "321",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
}
}
},
{
"id": "493",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-12-02",
"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": "878bc708e16ab51f50fef0b4ba4c9569",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 200,
"forecasted_time_usage": 0,
"budget_usage": 100,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 480,
"time_to_close": null,
"unapproved_entries_count": 1,
"rejected_entries_count": 0,
"estimated_remaining_time": -480,
"unapproved_time": 480,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-12-02T09:49:27.777+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"services_revenue": 100000,
"services_revenue_default": 125000,
"services_revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 100000,
"pending_invoicing_default": 125000,
"pending_invoicing_normalized": 100000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"actual_rate": 12500,
"actual_rate_default": 15625,
"actual_rate_normalized": 12500,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 100000,
"forecasted_revenue_default": 125000,
"forecasted_revenue_normalized": 100000,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 100000,
"forecasted_profit_default": 125000,
"forecasted_profit_normalized": 100000,
"forecasted_budget_used": 200000,
"forecasted_budget_used_default": 250000,
"forecasted_budget_used_normalized": 200000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"creator": {
"data": {
"type": "people",
"id": "2328"
}
},
"company": {
"data": {
"type": "companies",
"id": "3291"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2330"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "4143"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "3289",
"type": "companies",
"attributes": {
"name": "Organization759",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:49:27.608+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3291",
"type": "companies",
"attributes": {
"name": "Client2542",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:49:27.712+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2330",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2279@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:49:27.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:49:27.726+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"company": {
"data": {
"type": "companies",
"id": "3292"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4143",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
}
}
},
{
"id": "3292",
"type": "companies",
"attributes": {
"name": "Client2543",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:49:27.721+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 759
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/financial_item_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/financial_item_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get financial item reportsGET/api/v2/reports/financial_item_reports
Invoice Reports ¶
Supported group params
-
invoice
-
company
-
subsidiary
-
sent_status
-
payment_status
-
overdue_status
-
invoice_aging
-
invoice_status
-
organization
-
custom_fields
Supported date period dates
-
invoiced_on
-
pay_on
-
sent_on
-
delivery_on
-
paid_on
GET /api/v2/reports/invoice_reports
Requests
GET /api/v2/reports/invoice_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "invoice-report-invoice-63-d41d8cd98f00b204e9800998ecf8427e",
"type": "invoice_reports",
"attributes": {
"group": "invoice",
"count": 1,
"sent_status": null,
"payment_status": null,
"overdue_status": null,
"invoice_status": null,
"invoice_aging": null,
"average_due_in": "10.0",
"average_paid_in": null,
"currency_id": null,
"year": null,
"quarter": null,
"month": null,
"week": null,
"custom_fields": {},
"formula_fields": {},
"invoiced_on_period": null,
"pay_on_period": null,
"sent_on_period": null,
"delivery_on_period": null,
"paid_on_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_amount": 0,
"total_amount_default": 0,
"total_amount_normalized": 0,
"total_amount_tax": 0,
"total_amount_tax_default": 0,
"total_amount_tax_normalized": 0,
"total_amount_with_tax": 0,
"total_amount_with_tax_default": 0,
"total_amount_with_tax_normalized": 0,
"total_amount_paid": 0,
"total_amount_paid_default": 0,
"total_amount_paid_normalized": 0,
"total_amount_written_off": 0,
"total_amount_written_off_default": 0,
"total_amount_written_off_normalized": 0,
"total_amount_unpaid": 0,
"total_amount_unpaid_default": 0,
"total_amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 760
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "63"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "63",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2020-12-02",
"sent_on": null,
"pay_on": "2020-12-12",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "b00a8fb770abc22a9c9f94948bbebbca",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-12-02T09:49:28.286+01:00",
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"custom_fields": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 760
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "3294"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "23"
}
},
"creator": {
"data": {
"type": "people",
"id": "2331"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "3294",
"type": "companies",
"attributes": {
"name": "Client2544",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:49:28.280+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 760
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "23",
"type": "document_types",
"attributes": {
"name": "Standard Document Type",
"tax1_name": "VAT",
"tax1_value": "25.0",
"tax2_name": null,
"tax2_value": null,
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 760
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "131"
}
}
}
},
{
"id": "2331",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2280@email.com",
"title": null,
"joined_at": "2020-12-02T09:49:28.000+01:00",
"last_seen_at": "2020-12-02T09:49:28.308+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:49:28.241+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 760
}
},
"company": {
"data": {
"type": "companies",
"id": "3293"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "131",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary131",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 760
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "3293",
"type": "companies",
"attributes": {
"name": "Organization760",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:49:28.239+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 760
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/invoice_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/invoice_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get invoice reportsGET/api/v2/reports/invoice_reports
Payment Reports ¶
Supported group params
-
payment
-
invoice
-
company
-
subsidiary
-
organization
Supported date period dates
- paid_on
GET /api/v2/reports/payment_reports
Requests
GET /api/v2/reports/payment_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "payment-report-payment-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": 807
}
},
"payment": {
"data": {
"type": "payments",
"id": "28"
}
},
"invoice": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"deal": {
"meta": {
"included": false
}
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "28",
"type": "payments",
"attributes": {
"paid_on": "2020-12-02",
"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": 807
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "878"
}
}
}
},
{
"id": "878",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2020-12-02",
"sent_on": null,
"pay_on": "2020-12-12",
"delivery_on": null,
"paid_on": "2020-12-02",
"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": "54c6a5ac649491b361a4d54ed63d354f",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-12-02T09:49:40.099+01:00",
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"custom_fields": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 10000,
"amount_paid_default": 12500,
"amount_paid_normalized": 10000,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": -10000,
"amount_unpaid_default": -12500,
"amount_unpaid_normalized": -10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 807
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "3484"
}
},
"document_type": {
"data": {
"type": "document_types",
"id": "72"
}
},
"creator": {
"data": {
"type": "people",
"id": "2402"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "3484",
"type": "companies",
"attributes": {
"name": "Client2687",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:49:40.093+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 807
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "72",
"type": "document_types",
"attributes": {
"name": "Standard Document Type",
"tax1_name": "VAT",
"tax1_value": "25.0",
"tax2_name": null,
"tax2_value": null,
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 807
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "180"
}
}
}
},
{
"id": "2402",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2351@email.com",
"title": null,
"joined_at": "2020-12-02T09:49:40.000+01:00",
"last_seen_at": "2020-12-02T09:49:40.135+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:49:40.059+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 807
}
},
"company": {
"data": {
"type": "companies",
"id": "3483"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "180",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary180",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 807
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "3483",
"type": "companies",
"attributes": {
"name": "Organization807",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:49:40.057+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 807
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/payment_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/payment_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get payment reportsGET/api/v2/reports/payment_reports
Person Reports ¶
Supported group params
-
person
-
company
-
subsidiary
-
role_id
-
type
-
status
-
organization
-
custom_fields
Supported date period dates
-
created_at
-
joined_at
GET /api/v2/reports/person_reports
Requests
GET /api/v2/reports/person_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "person-report-person-2444-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
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 829
}
},
"person": {
"data": {
"type": "people",
"id": "2444"
}
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "2444",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2393@email.com",
"title": null,
"joined_at": "2020-12-02T09:49:47.000+01:00",
"last_seen_at": "2020-12-02T09:49:47.533+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:49:47.490+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 829
}
},
"company": {
"data": {
"type": "companies",
"id": "3578"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3578",
"type": "companies",
"attributes": {
"name": "Organization829",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:49:47.488+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 829
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/person_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/person_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get person reportsGET/api/v2/reports/person_reports
Project Reports ¶
Supported group params
-
project
-
company
-
project_manager
-
project_status
-
project_type
-
public_access
-
organization
-
custom_fields
Supported date period dates
-
created_at
-
last_activity_at
GET /api/v2/reports/project_reports
Requests
GET /api/v2/reports/project_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "project-report-project-411-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": 886
}
},
"project": {
"data": {
"type": "projects",
"id": "411"
}
},
"company": {
"data": null
},
"project_manager": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "411",
"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": "2020-12-02T09:49:56.246+01:00",
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 886
}
},
"company": {
"data": {
"type": "companies",
"id": "3693"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2560"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "3693",
"type": "companies",
"attributes": {
"name": "Client2817",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:49:56.242+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 886
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2560",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2507@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:49:56.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:49:56.201+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 886
}
},
"company": {
"data": {
"type": "companies",
"id": "3692"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "3692",
"type": "companies",
"attributes": {
"name": "Client2816",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:49:56.195+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 886
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/project_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/project_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get project reportsGET/api/v2/reports/project_reports
Service Reports ¶
Supported group params
-
service
-
budget
-
service_type
-
company
-
responsible
-
subsidiary
-
project
-
budget_status
-
project_type
-
organization
-
recurring
-
budget_custom_fields
-
pricing_type
-
billable
Supported date period dates
- date
GET /api/v2/reports/service_reports
Requests
GET /api/v2/reports/service_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "service-report-service-192-d41d8cd98f00b204e9800998ecf8427e",
"type": "service_reports",
"attributes": {
"group": "service",
"count": 1,
"budget_status": null,
"project_type": null,
"pricing_type": null,
"billable": null,
"total_booked_time": 0,
"total_worked_time": 0,
"total_billable_time": 0,
"total_estimated_time": null,
"total_budgeted_time": 0,
"total_estimated_remaining_time": null,
"total_unapproved_time": 0,
"total_future_booked_time": 0,
"total_forecasted_billable_time": 0,
"average_forecasted_margin": "100.0",
"average_forecasted_budget_usage": "200.0",
"average_forecasted_time_usage": null,
"average_profit_margin": "100.0",
"average_budget_usage": "100.0",
"average_discount": null,
"recurring": false,
"budget_custom_fields": {},
"formula_fields": {},
"date_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_revenue": 125000,
"total_revenue_default": 125000,
"total_revenue_normalized": 125000,
"total_price": 100000,
"total_price_default": 100000,
"total_price_normalized": 100000,
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_profit": 125000,
"total_profit_default": 125000,
"total_profit_normalized": 125000,
"total_budget_total": 125000,
"total_budget_total_default": 125000,
"total_budget_total_normalized": 125000,
"total_budget_used": 125000,
"total_budget_used_default": 125000,
"total_budget_used_normalized": 125000,
"total_budget_remaining": 0,
"total_budget_remaining_default": 0,
"total_budget_remaining_normalized": 0,
"average_actual_rate": null,
"average_actual_rate_default": null,
"average_actual_rate_normalized": null,
"average_hourly_rate": null,
"average_hourly_rate_default": null,
"average_hourly_rate_normalized": null,
"total_future_revenue": 0,
"total_future_revenue_default": 0,
"total_future_revenue_normalized": 0,
"total_future_budget_used": 125000,
"total_future_budget_used_default": 125000,
"total_future_budget_used_normalized": 125000,
"total_future_cost": 0,
"total_future_cost_default": 0,
"total_future_cost_normalized": 0,
"total_forecasted_revenue": 125000,
"total_forecasted_revenue_default": 125000,
"total_forecasted_revenue_normalized": 125000,
"total_forecasted_cost": 0,
"total_forecasted_cost_default": 0,
"total_forecasted_cost_normalized": 0,
"total_forecasted_profit": 125000,
"total_forecasted_profit_default": 125000,
"total_forecasted_profit_normalized": 125000,
"total_forecasted_budget_used": 250000,
"total_forecasted_budget_used_default": 250000,
"total_forecasted_budget_used_normalized": 250000,
"total_discount_amount": 0,
"total_discount_amount_default": 0,
"total_discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
},
"service": {
"data": {
"type": "services",
"id": "192"
}
},
"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": "192",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"pricing_type_id": 1,
"worked_time": 0,
"unapproved_time": 0,
"billable_time": 0,
"estimated_time": null,
"booked_time": 0,
"budgeted_time": 0,
"profit_margin": 100,
"unit_id": 2,
"quantity": "1.0",
"discount": null,
"future_booked_time": 0,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null,
"price": 100000,
"price_default": 125000,
"price_normalized": 100000,
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"discount_amount": 0,
"discount_amount_default": 0,
"discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "382"
}
},
"deal": {
"data": {
"type": "deals",
"id": "546"
}
},
"section": {
"data": null
}
}
},
{
"id": "382",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
}
}
},
{
"id": "546",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-12-02",
"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": "5ea0e478b0c4093b4d7a5689338c320d",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 200,
"forecasted_time_usage": 0,
"budget_usage": 100,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-12-02T09:50:13.111+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"services_revenue": 100000,
"services_revenue_default": 125000,
"services_revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 100000,
"pending_invoicing_default": 125000,
"pending_invoicing_normalized": 100000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 100000,
"forecasted_revenue_default": 125000,
"forecasted_revenue_normalized": 100000,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 100000,
"forecasted_profit_default": 125000,
"forecasted_profit_normalized": 100000,
"forecasted_budget_used": 200000,
"forecasted_budget_used_default": 250000,
"forecasted_budget_used_normalized": 200000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
},
"creator": {
"data": {
"type": "people",
"id": "2741"
}
},
"company": {
"data": {
"type": "companies",
"id": "4017"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "2742"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "4964"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "2741",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2688@email.com",
"title": null,
"joined_at": "2020-12-02T09:50:13.000+01:00",
"last_seen_at": "2020-12-02T09:50:13.173+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:50:13.013+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
},
"company": {
"data": {
"type": "companies",
"id": "4016"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4017",
"type": "companies",
"attributes": {
"name": "Client3104",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:50:13.047+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "2742",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2689@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:50:13.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:50:13.063+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
},
"company": {
"data": {
"type": "companies",
"id": "4018"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4964",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
}
}
},
{
"id": "4016",
"type": "companies",
"attributes": {
"name": "Organization923",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:50:13.011+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4018",
"type": "companies",
"attributes": {
"name": "Client3105",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:50:13.056+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 923
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/service_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/service_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get service reportsGET/api/v2/reports/service_reports
Task Reports ¶
Supported group params
-
task
-
project
-
task_list
-
board
-
assignee
-
creator
-
last_actor
-
company
-
status
-
organization
-
custom_fields
Supported date period dates
-
created_at
-
closed_at
-
last_activity_at
-
due_date
-
start_date
GET /api/v2/reports/task_reports
Requests
GET /api/v2/reports/task_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "task-report-task-67-d41d8cd98f00b204e9800998ecf8427e",
"type": "task_reports",
"attributes": {
"group": "task",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"status": null,
"total_worked_time": null,
"total_initial_estimate": null,
"total_remaining_time": null,
"total_estimation_offset_time": null,
"custom_fields": {},
"formula_fields": {},
"created_at_period": null,
"closed_at_period": null,
"last_activity_at_period": null,
"due_date_period": null,
"start_date_period": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"task": {
"data": {
"type": "tasks",
"id": "67"
}
},
"project": {
"data": null
},
"task_list": {
"data": null
},
"board": {
"data": null
},
"assignee": {
"data": null
},
"creator": {
"data": null
},
"last_actor": {
"data": null
},
"company": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "67",
"type": "tasks",
"attributes": {
"title": "Ticket title",
"description": null,
"number": 1,
"private": false,
"due_date": null,
"start_date": null,
"closed_at": null,
"created_at": "2020-12-02T09:50:51.259+01:00",
"updated_at": "2020-12-02T09:50:51.259+01:00",
"repeat_schedule_id": null,
"repeat_on_interval": null,
"repeat_on_monthday": null,
"repeat_on_weekday": [],
"repeat_on_date": null,
"repeat_origin_id": null,
"email_key": "fbff36bfb4909a83e373fb9b52903671",
"custom_fields": null,
"todo_count": null,
"open_todo_count": null,
"todo_assignee_count": null,
"subtask_count": null,
"open_subtask_count": null,
"creation_method_id": 1,
"subtask_position": null,
"closed": false,
"due_time": null,
"tag_list": [],
"position": 1,
"last_activity_at": null,
"initial_estimate": null,
"remaining_time": null,
"worked_time": null,
"deleted_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"project": {
"data": {
"type": "projects",
"id": "934"
}
},
"creator": {
"data": {
"type": "people",
"id": "3029"
}
},
"assignee": {
"data": null
},
"last_actor": {
"data": null
},
"task_list": {
"data": {
"type": "task_lists",
"id": "66"
}
},
"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": "2020-12-02T09:50:50.980+01:00",
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"company": {
"data": {
"type": "companies",
"id": "4497"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3028"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "3029",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2976@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:50:51.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:50:51.009+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"company": {
"data": {
"type": "companies",
"id": "4498"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "66",
"type": "task_lists",
"attributes": {
"name": "Milestone62",
"position": 1,
"archived_at": null,
"email_key": "c9dc6e4335a90311ddc30c06d0414244"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"project": {
"data": {
"type": "projects",
"id": "935"
}
},
"board": {
"data": {
"type": "boards",
"id": "81"
}
}
}
},
{
"id": "4497",
"type": "companies",
"attributes": {
"name": "Client3499",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:50:50.976+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3028",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2975@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:50:50.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:50:50.948+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"company": {
"data": {
"type": "companies",
"id": "4496"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4498",
"type": "companies",
"attributes": {
"name": "Client3500",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:50:51.004+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "935",
"type": "projects",
"attributes": {
"name": "test project",
"number": 2,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2020-12-02T09:50:51.100+01:00",
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"company": {
"data": {
"type": "companies",
"id": "4500"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3030"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "81",
"type": "boards",
"attributes": {
"name": "Board61",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"project": {
"data": {
"type": "projects",
"id": "936"
}
}
}
},
{
"id": "4496",
"type": "companies",
"attributes": {
"name": "Client3498",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:50:50.943+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4500",
"type": "companies",
"attributes": {
"name": "Client3502",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:50:51.097+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3030",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2977@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:50:51.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:50:51.054+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"company": {
"data": {
"type": "companies",
"id": "4499"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "936",
"type": "projects",
"attributes": {
"name": "test project",
"number": 3,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2020-12-02T09:50:51.169+01:00",
"board_count": 1,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"company": {
"data": {
"type": "companies",
"id": "4502"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3031"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "4499",
"type": "companies",
"attributes": {
"name": "Client3501",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:50:51.047+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4502",
"type": "companies",
"attributes": {
"name": "Client3504",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:50:51.166+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3031",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2978@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:50:51.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:50:51.131+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"company": {
"data": {
"type": "companies",
"id": "4501"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4501",
"type": "companies",
"attributes": {
"name": "Client3503",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:50:51.126+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1008
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/task_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/task_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get task reportsGET/api/v2/reports/task_reports
Time Entry Reports ¶
Supported group params
-
time_entry
-
person
-
task
-
service
-
service_type
-
pricing_type_id
-
budget
-
project
-
responsible
-
company
-
status
-
invoiced
-
organization
-
people_custom_fields
-
project_type_id
Supported date period dates
-
date
-
created_at
GET /api/v2/reports/time_entry_reports
Requests
GET /api/v2/reports/time_entry_reports
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "time-entry-report-time_entry-12-d41d8cd98f00b204e9800998ecf8427e",
"type": "time_entry_reports",
"attributes": {
"group": "time_entry",
"count": 1,
"year": null,
"quarter": null,
"month": null,
"week": null,
"day": null,
"status": null,
"jira_issue_id": null,
"invoiced": false,
"total_time": 480,
"total_billable_time": 480,
"total_recognized_time": null,
"pricing_type_id": null,
"unit_id": null,
"project_type_id": null,
"average_recognized_margin": null,
"people_custom_fields": {},
"formula_fields": {},
"date_period": null,
"created_at_period": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0,
"total_work_cost": 0,
"total_work_cost_default": 0,
"total_work_cost_normalized": 0,
"total_overhead_cost": 0,
"total_overhead_cost_default": 0,
"total_overhead_cost_normalized": 0,
"total_internal_overhead_cost": 0,
"total_internal_overhead_cost_default": 0,
"total_internal_overhead_cost_normalized": 0,
"total_facility_overhead_cost": 0,
"total_facility_overhead_cost_default": 0,
"total_facility_overhead_cost_normalized": 0,
"total_revenue": null,
"total_revenue_default": null,
"total_revenue_normalized": null,
"total_profit": null,
"total_profit_default": null,
"total_profit_normalized": null,
"average_blended_rate": null,
"average_blended_rate_default": null,
"average_blended_rate_normalized": null,
"total_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": 1065
}
},
"time_entry": {
"data": {
"type": "time_entries",
"id": "12"
}
},
"person": {
"data": null
},
"task": {
"data": null
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"project": {
"data": null
},
"responsible": {
"data": null
},
"company": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "12",
"type": "time_entries",
"attributes": {
"date": "2020-12-02",
"created_at": "2020-12-02T09:51:42.297+01:00",
"time": 480,
"billable_time": 480,
"note": "test note",
"track_method_id": 1,
"tracking_type_id": null,
"started_at": null,
"timer_started_at": null,
"timer_stopped_at": null,
"approved": false,
"approved_at": null,
"updated_at": "2020-12-02T09:51:42.297+01:00",
"invoiced": false,
"rejected": false,
"rejected_reason": null,
"rejected_at": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"overhead_cost": 0,
"overhead_cost_default": 0,
"overhead_cost_normalized": 0,
"internal_overhead_cost": 0,
"internal_overhead_cost_default": 0,
"internal_overhead_cost_normalized": 0,
"facility_overhead_cost": 0,
"facility_overhead_cost_default": 0,
"facility_overhead_cost_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"person": {
"data": {
"type": "people",
"id": "3756"
}
},
"service": {
"data": {
"type": "services",
"id": "361"
}
},
"task": {
"data": null
},
"approver": {
"data": null
},
"updater": {
"data": {
"type": "people",
"id": "3755"
}
},
"rejecter": {
"data": null
}
}
},
{
"id": "3756",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3703@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:51:42.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:51:42.147+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"company": {
"data": {
"type": "companies",
"id": "5633"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "361",
"type": "services",
"attributes": {
"name": "test name",
"position": 1,
"deleted_at": null,
"billable": true,
"description": null,
"pricing_type_id": 1,
"worked_time": 480,
"unapproved_time": 480,
"billable_time": 0,
"estimated_time": null,
"booked_time": 0,
"budgeted_time": 0,
"profit_margin": 100,
"unit_id": 2,
"quantity": "1.0",
"discount": null,
"future_booked_time": 0,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"hourly_rate": null,
"hourly_rate_default": null,
"hourly_rate_normalized": null,
"price": 100000,
"price_default": 125000,
"price_normalized": 100000,
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"discount_amount": 0,
"discount_amount_default": 0,
"discount_amount_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"service_type": {
"data": {
"type": "service_types",
"id": "551"
}
},
"deal": {
"data": {
"type": "deals",
"id": "695"
}
},
"section": {
"data": null
}
}
},
{
"id": "3755",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3702@email.com",
"title": null,
"joined_at": "2020-12-02T09:51:42.000+01:00",
"last_seen_at": "2020-12-02T09:51:42.334+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:51:42.100+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"company": {
"data": {
"type": "companies",
"id": "5632"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "5633",
"type": "companies",
"attributes": {
"name": "Client4578",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:51:42.141+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "551",
"type": "service_types",
"attributes": {
"name": "test name",
"category_id": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
}
}
},
{
"id": "695",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-12-02",
"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": "2a97429e9d0e03de8408cedd4f44a62d",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 100,
"forecasted_budget_usage": 200,
"forecasted_time_usage": 0,
"budget_usage": 100,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 480,
"time_to_close": null,
"unapproved_entries_count": 1,
"rejected_entries_count": 0,
"estimated_remaining_time": -480,
"unapproved_time": 480,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2020-12-02T09:51:42.237+01:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-12-02",
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 100000,
"revenue_default": 125000,
"revenue_normalized": 100000,
"services_revenue": 100000,
"services_revenue_default": 125000,
"services_revenue_normalized": 100000,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 100000,
"profit_default": 125000,
"profit_normalized": 100000,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 100000,
"pending_invoicing_default": 125000,
"pending_invoicing_normalized": 100000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 100000,
"budget_total_default": 125000,
"budget_total_normalized": 100000,
"budget_used": 100000,
"budget_used_default": 125000,
"budget_used_normalized": 100000,
"actual_rate": 12500,
"actual_rate_default": 15625,
"actual_rate_normalized": 12500,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 50000,
"projected_revenue_default": 62500,
"projected_revenue_normalized": 50000,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 100000,
"future_budget_used_default": 125000,
"future_budget_used_normalized": 100000,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 100000,
"forecasted_revenue_default": 125000,
"forecasted_revenue_normalized": 100000,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 100000,
"forecasted_profit_default": 125000,
"forecasted_profit_normalized": 100000,
"forecasted_budget_used": 200000,
"forecasted_budget_used_default": 250000,
"forecasted_budget_used_normalized": 200000,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"creator": {
"data": {
"type": "people",
"id": "3755"
}
},
"company": {
"data": {
"type": "companies",
"id": "5634"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "3757"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "5801"
}
},
"project": {
"data": null
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "5632",
"type": "companies",
"attributes": {
"name": "Organization1065",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-12-02T09:51:42.098+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "5634",
"type": "companies",
"attributes": {
"name": "Client4579",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:51:42.181+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "3757",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user3704@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:51:42.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:51:42.194+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"company": {
"data": {
"type": "companies",
"id": "5635"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "5801",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
}
}
},
{
"id": "5635",
"type": "companies",
"attributes": {
"name": "Client4580",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:51:42.189+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1065
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/time_entry_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/time_entry_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}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-4114-d41d8cd98f00b204e9800998ecf8427e",
"type": "new_time_reports",
"attributes": {
"group": "person",
"year": null,
"quarter": null,
"month": null,
"week": null,
"day": null,
"count": 1,
"future": null,
"people_custom_fields": {},
"formula_fields": {},
"date_period": null,
"capacity": null,
"available_time": 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,
"worked_available_diff": null,
"client_worked_ratio": "1.0",
"worked_available_ratio": null,
"worked_scheduled_ratio": null,
"available_capacity_ratio": null,
"billable_available_ratio": null,
"billable_client_ratio": "0.0",
"billable_worked_ratio": "0.0",
"client_available_ratio": null,
"scheduled_available_ratio": null,
"client_scheduled_available_ratio": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"total_cost": 0,
"total_cost_default": 0,
"total_cost_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1131
}
},
"person": {
"data": {
"type": "people",
"id": "4114"
}
},
"service": {
"data": null
},
"service_type": {
"data": null
},
"budget": {
"data": null
},
"company": {
"data": null
},
"project": {
"data": null
},
"event": {
"data": null
},
"report": {
"data": null
}
}
}
],
"included": [
{
"id": "4114",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4061@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-12-02T09:52:27.000+01:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-12-02T09:52:27.562+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1131
}
},
"company": {
"data": {
"type": "companies",
"id": "6140"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6140",
"type": "companies",
"attributes": {
"name": "Client5019",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-12-02T09:52:27.557+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1131
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/reports/time_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/reports/time_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
}
}
}
}Get time reportsGET/api/v2/reports/time_reports
Generated by aglio on 02 Dec 2020