API Documentation

API Endpoint

Reports

/reports endpoints are routes that support multigrouping.

For each report, there are listed supported group parameters. Available filters are the same as for the source object (task report has all the filters available for tasks). All reports endpoints support filter operations.

Example for passing a group param: /reports/task_reports?group=organization,task.

All /reports endpoints support grouping by date period. Available date periods for grouping are: year, quarter, month, week and day. Grouping by date period can be done like this: reports/task_reports?group=organization,created_at:month,task. For each report endpoint, there is a list of supported dates which can be used for grouping by date period.

Booking Reports

Supported filter params

Supported filter params can be found on bookings endpoint

Supported group params

  • booking

  • person

  • service

  • event

  • service_type

  • pricing_type_id

  • budget

  • project

  • responsible

  • company

  • project_type

  • organization

  • people_custom_fields

Supported date period dates

  • date
GET /api/v2/reports/booking_reports
Requestsreturns booking reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "booking-report-booking-73-d41d8cd98f00b204e9800998ecf8427e",
      "type": "booking_reports",
      "attributes": {
        "group": "booking",
        "count": 2,
        "time": 640,
        "mandays": "1.0",
        "start_date": "2021-07-24",
        "end_date": "2021-07-24",
        "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": 753
          }
        },
        "booking": {
          "data": {
            "type": "bookings",
            "id": "73"
          }
        },
        "person": {
          "data": null
        },
        "service": {
          "data": null
        },
        "service_type": {
          "data": null
        },
        "event": {
          "data": null
        },
        "budget": {
          "data": null
        },
        "project": {
          "data": null
        },
        "company": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "73",
      "type": "bookings",
      "attributes": {
        "hours": 6,
        "time": 360,
        "started_on": "2021-07-24",
        "ended_on": "2021-07-24",
        "note": null,
        "total_time": 0,
        "total_working_days": 0,
        "percentage": null,
        "created_at": "2021-07-24T01:06:40.820+02:00",
        "updated_at": "2021-07-24T01:06:40.820+02:00",
        "people_custom_fields": null,
        "approved": true,
        "approved_at": "2021-07-24T01:06:40.819+02:00",
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "canceled": false,
        "canceled_at": null,
        "booking_method_id": 1,
        "autotracking": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "68"
          }
        },
        "event": {
          "data": null
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1934"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1931"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "1931"
          }
        },
        "approver": {
          "data": {
            "type": "people",
            "id": "1931"
          }
        },
        "rejecter": {
          "data": null
        },
        "canceler": {
          "data": null
        },
        "origin": {
          "data": null
        },
        "approval_statuses": {
          "data": []
        }
      }
    },
    {
      "id": "68",
      "type": "services",
      "attributes": {
        "name": "test name",
        "position": 1,
        "deleted_at": null,
        "billable": true,
        "description": null,
        "tracking_enabled": true,
        "pricing_type_id": 1,
        "billing_type_id": null,
        "worked_time": 0,
        "unapproved_time": 0,
        "billable_time": 0,
        "estimated_time": null,
        "booked_time": 0,
        "budgeted_time": 0,
        "profit_margin": 100,
        "unit_id": 2,
        "quantity": "1.0",
        "discount": null,
        "future_booked_time": 0,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "hourly_rate": null,
        "hourly_rate_default": null,
        "hourly_rate_normalized": null,
        "price": 100000,
        "price_default": 125000,
        "price_normalized": 100000,
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "expense_amount": 0,
        "expense_amount_default": 0,
        "expense_amount_normalized": 0,
        "expense_billable_amount": 0,
        "expense_billable_amount_default": 0,
        "expense_billable_amount_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "122"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "175"
          }
        },
        "section": {
          "data": null
        }
      }
    },
    {
      "id": "1934",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1877@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:06:40.000+02:00",
        "is_user": true,
        "user_id": 1917,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:06:40.784+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2609"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1931",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1874@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:06:41.000+02:00",
        "last_seen_at": "2021-07-24T01:06:41.142+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1914,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:06:40.633+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2605"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "122",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null,
        "description": "test description"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        }
      }
    },
    {
      "id": "175",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-07-24",
        "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": "84872e275ce6828713671ae7a4408bcd",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 100,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-07-24T01:06:40.748+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-07-24",
        "sales_closed_on": null,
        "sample_data": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "services_revenue": 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": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 100000,
        "pending_invoicing_default": 125000,
        "pending_invoicing_normalized": 100000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 100000,
        "budget_remaining_default": 125000,
        "budget_remaining_normalized": 100000,
        "projected_revenue": 50000,
        "projected_revenue_default": 62500,
        "projected_revenue_normalized": 50000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 100000,
        "forecasted_revenue_default": 125000,
        "forecasted_revenue_normalized": 100000,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 100000,
        "forecasted_profit_default": 125000,
        "forecasted_profit_normalized": 100000,
        "forecasted_budget_used": 100000,
        "forecasted_budget_used_default": 125000,
        "forecasted_budget_used_normalized": 100000,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1931"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2607"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1933"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "3876"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2609",
      "type": "companies",
      "attributes": {
        "name": "Client1857",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:06:40.779+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2605",
      "type": "companies",
      "attributes": {
        "name": "Organization753",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:06:40.631+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2607",
      "type": "companies",
      "attributes": {
        "name": "Client1855",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:06:40.698+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1933",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1876@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:06:40.000+02:00",
        "is_user": true,
        "user_id": 1916,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:06:40.709+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2608"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3876",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        }
      }
    },
    {
      "id": "2608",
      "type": "companies",
      "attributes": {
        "name": "Client1856",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:06:40.705+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 753
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get booking reports
GET/api/v2/reports/booking_reports


Budget Reports

Supported filter params

Supported filter params can be found on deals endpoint

Supported group params

  • budget

  • company

  • responsible

  • subsidiary

  • contract

  • project

  • status

  • project_type

  • organization

  • recurring

  • custom_fields

Supported date period dates

  • date

  • created_at

  • closed_at

  • end_date

  • last_activity_at

  • delivered_on

GET /api/v2/reports/budget_reports
Requestsreturns budget reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "budget-report-budget-311-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": 789
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "311"
          }
        },
        "contract": {
          "data": null
        },
        "project": {
          "data": null
        },
        "company": {
          "data": null
        },
        "responsible": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "311",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-07-24",
        "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": "b76b31b9d926fd49c0714640093a033e",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 100,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-07-24T01:07:27.744+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-07-24",
        "sales_closed_on": null,
        "sample_data": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2357"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3180"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2358"
          }
        },
        "deal_status": {
          "meta": {
            "included": false
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "474"
          }
        },
        "lost_reason": {
          "meta": {
            "included": false
          }
        },
        "contract": {
          "data": null
        },
        "contact": {
          "meta": {
            "included": false
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2357",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2300@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:07:27.000+02:00",
        "last_seen_at": "2021-07-24T01:07:27.763+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 2340,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:07:27.576+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3179"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3180",
      "type": "companies",
      "attributes": {
        "name": "Client2392",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:27.644+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2358",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2301@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:07:27.000+02:00",
        "is_user": true,
        "user_id": 2341,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:07:27.654+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3181"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "474",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-07-24T01:07:27.723+02:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3183"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "2359"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "3179",
      "type": "companies",
      "attributes": {
        "name": "Organization789",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:07:27.575+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3181",
      "type": "companies",
      "attributes": {
        "name": "Client2393",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:27.650+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3183",
      "type": "companies",
      "attributes": {
        "name": "Client2395",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:27.720+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2359",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2302@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:07:27.000+02:00",
        "is_user": true,
        "user_id": 2342,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:07:27.694+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3182"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3182",
      "type": "companies",
      "attributes": {
        "name": "Client2394",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:27.690+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 789
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get budget reports
GET/api/v2/reports/budget_reports


Company Reports

Supported filter params

Supported filter params can be found on companies endpoint

Supported group params

  • company, key: :company_id

  • status

  • organization

  • custom_fields

Supported date period dates

  • created_at
GET /api/v2/reports/company_reports
Requestsreturns company reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "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": 816
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "123"
          }
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "123",
      "type": "companies",
      "attributes": {
        "name": "Client2620",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:39.437+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 816
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get company reports
GET/api/v2/reports/company_reports


Deal Reports

Supported filter params

Supported filter params can be found on deals endpoint

Supported group params

  • deal

  • company

  • responsible

  • subsidiary

  • sales_status_id

  • deal_status

  • lost_reason

  • organization

  • custom_fields

  • contact

Supported date period dates

  • date

  • created_at

  • last_activity_at

  • sales_status_updated_at

  • sales_closed_at

GET /api/v2/reports/deal_reports
Requestsreturns deal reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "deal-report-deal-370-d41d8cd98f00b204e9800998ecf8427e",
      "type": "deal_reports",
      "attributes": {
        "group": "deal",
        "count": 1,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "sales_status_id": null,
        "total_worked_time": 0,
        "total_billable_time": 0,
        "total_estimated_time": 0,
        "total_budgeted_time": 0,
        "total_estimated_remaining_time": 0,
        "custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "created_at_period": null,
        "last_activity_at_period": null,
        "sales_closed_at_period": null,
        "sales_closed_on_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_revenue": 0,
        "total_revenue_default": 0,
        "total_revenue_normalized": 0,
        "total_services_revenue": 0,
        "total_services_revenue_default": 0,
        "total_services_revenue_normalized": 0,
        "total_projected_revenue": 0,
        "total_projected_revenue_default": 0,
        "total_projected_revenue_normalized": 0,
        "total_work_cost": 0,
        "total_work_cost_default": 0,
        "total_work_cost_normalized": 0,
        "total_expense": 0,
        "total_expense_default": 0,
        "total_expense_normalized": 0,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_profit": 0,
        "total_profit_default": 0,
        "total_profit_normalized": 0,
        "total_budget_total": 0,
        "total_budget_total_default": 0,
        "total_budget_total_normalized": 0,
        "total_budget_used": 0,
        "total_budget_used_default": 0,
        "total_budget_used_normalized": 0,
        "total_invoiced": 0,
        "total_invoiced_default": 0,
        "total_invoiced_normalized": 0,
        "total_pending_invoicing": 0,
        "total_pending_invoicing_default": 0,
        "total_pending_invoicing_normalized": 0,
        "average_actual_rate": 0,
        "average_actual_rate_default": 0,
        "average_actual_rate_normalized": 0,
        "average_rate": 0,
        "average_rate_default": 0,
        "average_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 835
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "370"
          }
        },
        "company": {
          "data": null
        },
        "responsible": {
          "data": null
        },
        "deal_status": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "370",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-07-24",
        "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": "7991bde7060494a7d3d19dc92263c05d",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-07-24T01:07:41.613+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-07-24",
        "sales_closed_on": null,
        "sample_data": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 835
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2515"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3482"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2516"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "4416"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2515",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2458@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:07:41.000+02:00",
        "last_seen_at": "2021-07-24T01:07:41.641+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 2498,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:07:41.513+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 835
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3481"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3482",
      "type": "companies",
      "attributes": {
        "name": "Client2657",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:41.548+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 835
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2516",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2459@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:07:41.000+02:00",
        "is_user": true,
        "user_id": 2499,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:07:41.562+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 835
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3483"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4416",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 835
          }
        }
      }
    },
    {
      "id": "3481",
      "type": "companies",
      "attributes": {
        "name": "Organization835",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:07:41.510+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 835
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3483",
      "type": "companies",
      "attributes": {
        "name": "Client2658",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:41.557+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 835
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get deal reports
GET/api/v2/reports/deal_reports


Entitlement Reports

Supported filter params

Supported filter params can be found on entitlements endpoint

Supported group params

  • entitlement

  • event

  • person

  • organization

  • people_custom_fields

Supported date period dates

  • start_date

  • end_date

GET /api/v2/reports/entitlement_reports
Requestsreturns entitlement reports

GET  /api/v2/reports/entitlement_reports

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "entitlement-report-entitlement-27-d41d8cd98f00b204e9800998ecf8427e",
      "type": "entitlement_reports",
      "attributes": {
        "group": "entitlement",
        "count": 1,
        "total_allocated": 22,
        "total_used": 0,
        "total_available": 22,
        "people_custom_fields": {},
        "formula_fields": {},
        "start_date_period": null,
        "end_date_period": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "866"
          }
        },
        "entitlement": {
          "data": {
            "type": "entitlements",
            "id": "27"
          }
        },
        "person": {
          "data": null
        },
        "event": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "27",
      "type": "entitlements",
      "attributes": {
        "start_date": "2021-07-23",
        "end_date": "2021-08-03",
        "allocated": 22,
        "used": 0,
        "pending": 0,
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 866
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "106"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2622"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    },
    {
      "id": "106",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 866
          }
        }
      }
    },
    {
      "id": "2622",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2565@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:07:49.000+02:00",
        "is_user": true,
        "user_id": 2605,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:07:49.422+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 866
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3667"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3667",
      "type": "companies",
      "attributes": {
        "name": "Client2811",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:49.418+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 866
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/entitlement_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/entitlement_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get entitlement reports
GET/api/v2/reports/entitlement_reports


Expense Reports

Supported filter params

Supported filter params can be found on expenses endpoint

Supported group params

  • expense

  • deal

  • service_type

  • project

  • company

  • person

  • responsible

  • status

  • invoiced

  • approval_status

  • reimbursement

  • organization

  • vendor

Supported date period dates

  • date

  • pay_on

  • paid_on

GET /api/v2/reports/expense_reports
Requestsreturns expense reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "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": 877
          }
        },
        "expense": {
          "data": {
            "type": "expenses",
            "id": "42"
          }
        },
        "deal": {
          "data": null
        },
        "project": {
          "data": null
        },
        "company": {
          "data": null
        },
        "service_type": {
          "data": null
        },
        "service": {
          "data": null
        },
        "vendor": {
          "data": null
        },
        "person": {
          "data": null
        },
        "approver": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "42",
      "type": "expenses",
      "attributes": {
        "name": "Višak",
        "date": "2021-07-24",
        "pay_on": null,
        "paid_on": null,
        "position": 1,
        "invoiced": false,
        "approved": true,
        "approved_at": "2021-07-24T01:07:51.408+02:00",
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "deleted_at": null,
        "reimbursable": null,
        "reimbursed_on": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-07-24",
        "created_at": "2021-07-24T01:07:51.409+02:00",
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "billable_amount": 0,
        "billable_amount_default": 0,
        "billable_amount_normalized": 0,
        "profit": -10000,
        "profit_default": -12500,
        "profit_normalized": -10000
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "437"
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "261"
          }
        },
        "person": {
          "data": null
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2655"
          }
        },
        "approver": {
          "data": {
            "type": "people",
            "id": "2656"
          }
        },
        "rejecter": {
          "data": null
        },
        "vendor": {
          "data": null
        },
        "service": {
          "data": null
        },
        "attachment": {
          "data": null
        }
      }
    },
    {
      "id": "437",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-07-24",
        "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": "2e16d640b734968fe0a139dd46cb148c",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-07-24T01:07:51.321+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-07-24",
        "sales_closed_on": null,
        "sample_data": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2655"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3701"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2656"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "4689"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "261",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null,
        "description": "test description"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        }
      }
    },
    {
      "id": "2655",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2598@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:07:51.000+02:00",
        "last_seen_at": "2021-07-24T01:07:51.442+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 2638,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:07:51.255+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3700"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2656",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2599@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:07:51.000+02:00",
        "is_user": true,
        "user_id": 2639,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:07:51.287+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3702"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3701",
      "type": "companies",
      "attributes": {
        "name": "Client2834",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:51.277+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4689",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        }
      }
    },
    {
      "id": "3700",
      "type": "companies",
      "attributes": {
        "name": "Organization877",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:07:51.254+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3702",
      "type": "companies",
      "attributes": {
        "name": "Client2835",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:07:51.283+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get expense reports
GET/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
Requestsreturns financial item reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "financial-item-report-financial_item-time_entry-9-d41d8cd98f00b204e9800998ecf8427e",
      "type": "financial_item_reports",
      "attributes": {
        "group": "financial_item",
        "count": 1,
        "financial_item_id": 9,
        "financial_item_type": "time_entry",
        "financial_item_date": "2021-07-24",
        "total_time": 480,
        "total_billable_time": 0,
        "total_scheduled_time": 0,
        "total_recognized_time": null,
        "pricing_type_id": null,
        "project_type_id": null,
        "average_recognized_margin": null,
        "future": null,
        "approval_status": null,
        "date_period": null,
        "formula_fields": {},
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_recognized_revenue": null,
        "total_recognized_revenue_default": null,
        "total_recognized_revenue_normalized": null,
        "total_scheduled_revenue": 0,
        "total_scheduled_revenue_default": 0,
        "total_scheduled_revenue_normalized": 0,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_recognized_profit": null,
        "total_recognized_profit_default": null,
        "total_recognized_profit_normalized": null,
        "average_blended_rate": null,
        "average_blended_rate_default": null,
        "average_blended_rate_normalized": null,
        "total_budget_used": 0,
        "total_budget_used_default": 0,
        "total_budget_used_normalized": 0,
        "total_invoiced": 0,
        "total_invoiced_default": 0,
        "total_invoiced_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "person": {
          "data": null
        },
        "service": {
          "data": null
        },
        "service_type": {
          "data": null
        },
        "budget": {
          "data": null
        },
        "company": {
          "data": null
        },
        "project": {
          "data": null
        },
        "time_entry": {
          "data": {
            "type": "time_entries",
            "id": "9"
          }
        },
        "booking_item": {
          "data": null
        },
        "expense": {
          "data": null
        },
        "invoice_attribution": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "9",
      "type": "time_entries",
      "attributes": {
        "date": "2021-07-24",
        "created_at": "2021-07-24T01:08:17.042+02:00",
        "time": 480,
        "billable_time": 480,
        "note": "test note",
        "track_method_id": null,
        "started_at": null,
        "timer_started_at": null,
        "timer_stopped_at": null,
        "approved": false,
        "approved_at": null,
        "updated_at": "2021-07-24T01:08:17.042+02:00",
        "calendar_event_id": null,
        "invoiced": false,
        "overhead": false,
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "overhead_cost": 0,
        "overhead_cost_default": 0,
        "overhead_cost_normalized": 0,
        "internal_overhead_cost": 0,
        "internal_overhead_cost_default": 0,
        "internal_overhead_cost_normalized": 0,
        "facility_overhead_cost": 0,
        "facility_overhead_cost_default": 0,
        "facility_overhead_cost_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2923"
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "305"
          }
        },
        "task": {
          "data": null
        },
        "approver": {
          "data": null
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "2922"
          }
        },
        "rejecter": {
          "data": null
        }
      }
    },
    {
      "id": "2923",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2866@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:08:16.000+02:00",
        "is_user": true,
        "user_id": 2906,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:08:16.936+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4190"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "305",
      "type": "services",
      "attributes": {
        "name": "test name",
        "position": 1,
        "deleted_at": null,
        "billable": true,
        "description": null,
        "tracking_enabled": true,
        "pricing_type_id": 1,
        "billing_type_id": null,
        "worked_time": 480,
        "unapproved_time": 480,
        "billable_time": 0,
        "estimated_time": null,
        "booked_time": 0,
        "budgeted_time": 0,
        "profit_margin": 100,
        "unit_id": 2,
        "quantity": "1.0",
        "discount": null,
        "future_booked_time": 0,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "hourly_rate": null,
        "hourly_rate_default": null,
        "hourly_rate_normalized": null,
        "price": 100000,
        "price_default": 125000,
        "price_normalized": 100000,
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "expense_amount": 0,
        "expense_amount_default": 0,
        "expense_amount_normalized": 0,
        "expense_billable_amount": 0,
        "expense_billable_amount_default": 0,
        "expense_billable_amount_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "458"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "633"
          }
        },
        "section": {
          "data": null
        }
      }
    },
    {
      "id": "2922",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2865@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:08:17.000+02:00",
        "last_seen_at": "2021-07-24T01:08:17.078+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 2905,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:08:16.904+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4189"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4190",
      "type": "companies",
      "attributes": {
        "name": "Client3276",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:08:16.932+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "458",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null,
        "description": "test description"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        }
      }
    },
    {
      "id": "633",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-07-24",
        "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": "094760234ac34594734e5891dacbea7b",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 100,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 480,
        "time_to_close": null,
        "unapproved_entries_count": 1,
        "rejected_entries_count": 0,
        "estimated_remaining_time": -480,
        "unapproved_time": 480,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-07-24T01:08:17.012+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-07-24",
        "sales_closed_on": null,
        "sample_data": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "services_revenue": 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": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 100000,
        "pending_invoicing_default": 125000,
        "pending_invoicing_normalized": 100000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 100000,
        "budget_remaining_default": 125000,
        "budget_remaining_normalized": 100000,
        "projected_revenue": 50000,
        "projected_revenue_default": 62500,
        "projected_revenue_normalized": 50000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 100000,
        "forecasted_revenue_default": 125000,
        "forecasted_revenue_normalized": 100000,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 100000,
        "forecasted_profit_default": 125000,
        "forecasted_profit_normalized": 100000,
        "forecasted_budget_used": 100000,
        "forecasted_budget_used_default": 125000,
        "forecasted_budget_used_normalized": 100000,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2922"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4191"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2924"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "5104"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4189",
      "type": "companies",
      "attributes": {
        "name": "Organization924",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:08:16.902+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4191",
      "type": "companies",
      "attributes": {
        "name": "Client3277",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:08:16.963+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2924",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2867@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:08:16.000+02:00",
        "is_user": true,
        "user_id": 2907,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:08:16.975+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4192"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "5104",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        }
      }
    },
    {
      "id": "4192",
      "type": "companies",
      "attributes": {
        "name": "Client3278",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:08:16.971+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 924
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get financial item reports
GET/api/v2/reports/financial_item_reports


Invoice Reports

Supported filter params

Supported filter params can be found on invoices endpoint

Supported group params

  • invoice

  • company

  • subsidiary

  • sent_status

  • payment_status

  • overdue_status

  • invoice_aging

  • invoice_status

  • organization

  • custom_fields

Supported date period dates

  • invoiced_on

  • pay_on

  • sent_on

  • delivery_on

  • paid_on

GET /api/v2/reports/invoice_reports
Requestsreturns invoice reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "invoice-report-invoice-67-d41d8cd98f00b204e9800998ecf8427e",
      "type": "invoice_reports",
      "attributes": {
        "group": "invoice",
        "count": 1,
        "sent_status": null,
        "payment_status": null,
        "overdue_status": null,
        "invoice_status": null,
        "invoice_aging": null,
        "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": 925
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "67"
          }
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "67",
      "type": "invoices",
      "attributes": {
        "number": "2016/01",
        "subject": null,
        "invoiced_on": "2021-07-24",
        "sent_on": null,
        "pay_on": "2021-08-03",
        "delivery_on": null,
        "paid_on": null,
        "finalized_on": null,
        "discount": null,
        "tax1_name": null,
        "tax1_value": null,
        "tax2_name": null,
        "tax2_value": null,
        "deleted_at": null,
        "tag_list": [],
        "note": null,
        "exported_at": null,
        "export_integration_type_id": null,
        "note_interpolated": null,
        "email_key": "e6d1bcc1a7d08751f58c27c7fb8fe0af",
        "purchase_order_number": null,
        "export_invoice_url": null,
        "company_reference_id": null,
        "created_at": "2021-07-24T01:08:17.361+02:00",
        "exchange_rate": "1.25",
        "exchange_date": "2021-07-24",
        "custom_fields": null,
        "updated_at": "2021-07-24T01:08:17.361+02:00",
        "sample_data": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "amount": 0,
        "amount_default": 0,
        "amount_normalized": 0,
        "amount_tax": 0,
        "amount_tax_default": 0,
        "amount_tax_normalized": 0,
        "amount_with_tax": 0,
        "amount_with_tax_default": 0,
        "amount_with_tax_normalized": 0,
        "amount_paid": 0,
        "amount_paid_default": 0,
        "amount_paid_normalized": 0,
        "amount_written_off": 0,
        "amount_written_off_default": 0,
        "amount_written_off_normalized": 0,
        "amount_unpaid": 0,
        "amount_unpaid_default": 0,
        "amount_unpaid_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 925
          }
        },
        "bill_to": {
          "data": null
        },
        "bill_from": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4194"
          }
        },
        "document_type": {
          "data": {
            "type": "document_types",
            "id": "25"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2925"
          }
        },
        "subsidiary": {
          "data": null
        },
        "invoice_attributions": {
          "data": []
        },
        "attachment": {
          "data": null
        }
      }
    },
    {
      "id": "4194",
      "type": "companies",
      "attributes": {
        "name": "Client3279",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:08:17.356+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 925
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "25",
      "type": "document_types",
      "attributes": {
        "name": "Standard Document Type",
        "tax1_name": "VAT",
        "tax1_value": "25.0",
        "tax2_name": null,
        "tax2_value": null,
        "locale": "en_US",
        "document_template_id": 1,
        "exportable_type_id": 1,
        "note": null,
        "footer": null,
        "template_options": {},
        "archived_at": null,
        "header_template": null,
        "body_template": null,
        "footer_template": null,
        "scss_template": null,
        "exporter_options": {},
        "email_template": null,
        "email_subject": null,
        "email_data": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 925
          }
        },
        "subsidiary": {
          "data": {
            "type": "subsidiaries",
            "id": "136"
          }
        },
        "document_style": {
          "data": null
        },
        "attachments": {
          "data": []
        }
      }
    },
    {
      "id": "2925",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2868@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:08:17.000+02:00",
        "last_seen_at": "2021-07-24T01:08:17.379+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 2908,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:08:17.328+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 925
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4193"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "136",
      "type": "subsidiaries",
      "attributes": {
        "name": "Subsidiary136",
        "invoice_number_format": null,
        "archived_at": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 925
          }
        },
        "bill_from": {
          "data": null
        },
        "integration": {
          "data": null
        }
      }
    },
    {
      "id": "4193",
      "type": "companies",
      "attributes": {
        "name": "Organization925",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:08:17.326+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 925
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get invoice reports
GET/api/v2/reports/invoice_reports


Payment Reports

Supported filter params

Supported filter params can be found on payments endpoint

Supported group params

  • payment

  • invoice

  • company

  • subsidiary

  • organization

Supported date period dates

  • paid_on
GET /api/v2/reports/payment_reports
Requestsreturns payment reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "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": 972
          }
        },
        "payment": {
          "data": {
            "type": "payments",
            "id": "28"
          }
        },
        "invoice": {
          "data": null
        },
        "company": {
          "data": null
        },
        "deal": {
          "meta": {
            "included": false
          }
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "28",
      "type": "payments",
      "attributes": {
        "paid_on": "2021-07-24",
        "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": 972
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "878"
          }
        }
      }
    },
    {
      "id": "878",
      "type": "invoices",
      "attributes": {
        "number": "2016/01",
        "subject": null,
        "invoiced_on": "2021-07-24",
        "sent_on": null,
        "pay_on": "2021-08-03",
        "delivery_on": null,
        "paid_on": "2021-07-24",
        "finalized_on": null,
        "discount": null,
        "tax1_name": null,
        "tax1_value": null,
        "tax2_name": null,
        "tax2_value": null,
        "deleted_at": null,
        "tag_list": [],
        "note": null,
        "exported_at": null,
        "export_integration_type_id": null,
        "note_interpolated": null,
        "email_key": "8baab80c346e8523bb73c4cef3e7f83f",
        "purchase_order_number": null,
        "export_invoice_url": null,
        "company_reference_id": null,
        "created_at": "2021-07-24T01:08:27.625+02:00",
        "exchange_rate": "1.25",
        "exchange_date": "2021-07-24",
        "custom_fields": null,
        "updated_at": "2021-07-24T01:08:27.638+02:00",
        "sample_data": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "amount": 0,
        "amount_default": 0,
        "amount_normalized": 0,
        "amount_tax": 0,
        "amount_tax_default": 0,
        "amount_tax_normalized": 0,
        "amount_with_tax": 0,
        "amount_with_tax_default": 0,
        "amount_with_tax_normalized": 0,
        "amount_paid": 10000,
        "amount_paid_default": 12500,
        "amount_paid_normalized": 10000,
        "amount_written_off": 0,
        "amount_written_off_default": 0,
        "amount_written_off_normalized": 0,
        "amount_unpaid": -10000,
        "amount_unpaid_default": -12500,
        "amount_unpaid_normalized": -10000
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 972
          }
        },
        "bill_to": {
          "data": null
        },
        "bill_from": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4384"
          }
        },
        "document_type": {
          "data": {
            "type": "document_types",
            "id": "74"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2996"
          }
        },
        "subsidiary": {
          "data": null
        },
        "invoice_attributions": {
          "data": []
        },
        "attachment": {
          "data": null
        }
      }
    },
    {
      "id": "4384",
      "type": "companies",
      "attributes": {
        "name": "Client3422",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:08:27.620+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 972
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "74",
      "type": "document_types",
      "attributes": {
        "name": "Standard Document Type",
        "tax1_name": "VAT",
        "tax1_value": "25.0",
        "tax2_name": null,
        "tax2_value": null,
        "locale": "en_US",
        "document_template_id": 1,
        "exportable_type_id": 1,
        "note": null,
        "footer": null,
        "template_options": {},
        "archived_at": null,
        "header_template": null,
        "body_template": null,
        "footer_template": null,
        "scss_template": null,
        "exporter_options": {},
        "email_template": null,
        "email_subject": null,
        "email_data": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 972
          }
        },
        "subsidiary": {
          "data": {
            "type": "subsidiaries",
            "id": "185"
          }
        },
        "document_style": {
          "data": null
        },
        "attachments": {
          "data": []
        }
      }
    },
    {
      "id": "2996",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2939@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:08:27.000+02:00",
        "last_seen_at": "2021-07-24T01:08:27.652+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 2979,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:08:27.586+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 972
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4383"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "185",
      "type": "subsidiaries",
      "attributes": {
        "name": "Subsidiary185",
        "invoice_number_format": null,
        "archived_at": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 972
          }
        },
        "bill_from": {
          "data": null
        },
        "integration": {
          "data": null
        }
      }
    },
    {
      "id": "4383",
      "type": "companies",
      "attributes": {
        "name": "Organization972",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:08:27.584+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 972
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get payment reports
GET/api/v2/reports/payment_reports


Person Reports

Supported filter params

Supported filter params can be found on people endpoint

Supported group params

  • person

  • company

  • subsidiary

  • role_id

  • type

  • status

  • organization

  • custom_fields

Supported date period dates

  • created_at

  • joined_at

GET /api/v2/reports/person_reports
Requestsreturns person reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "person-report-person-3038-d41d8cd98f00b204e9800998ecf8427e",
      "type": "person_reports",
      "attributes": {
        "group": "person",
        "count": 1,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "role_id": null,
        "status": null,
        "type": null,
        "custom_fields": {},
        "contact_phone": null,
        "contact_email": null,
        "contact_website": null,
        "contact_city": null,
        "contact_state": null,
        "contact_country": null,
        "contact_zipcode": null,
        "contact_address": null,
        "created_at_period": null,
        "joined_at_period": null,
        "deactivated_at_period": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 994
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "3038"
          }
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "3038",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2981@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:08:32.000+02:00",
        "last_seen_at": "2021-07-24T01:08:32.934+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 3021,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:08:32.908+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 994
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4478"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4478",
      "type": "companies",
      "attributes": {
        "name": "Organization994",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:08:32.907+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 994
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get person reports
GET/api/v2/reports/person_reports


Project Reports

Supported filter params

Supported filter params can be found on projects endpoint

Supported group params

  • project

  • company

  • project_manager

  • project_status

  • project_type

  • public_access

  • organization

  • custom_fields

Supported date period dates

  • created_at

  • last_activity_at

GET /api/v2/reports/project_reports
Requestsreturns project reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "project-report-project-575-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": 1051
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "575"
          }
        },
        "company": {
          "data": null
        },
        "project_manager": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "575",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-07-24T01:08:39.015+02:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1051
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4593"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "3154"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4593",
      "type": "companies",
      "attributes": {
        "name": "Client3552",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:08:39.013+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1051
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3154",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3095@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:08:38.000+02:00",
        "is_user": true,
        "user_id": 3135,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:08:38.989+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1051
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4592"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4592",
      "type": "companies",
      "attributes": {
        "name": "Client3551",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:08:38.986+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1051
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get project reports
GET/api/v2/reports/project_reports


Salary Reports

Supported filter params

  • ended_on

  • salary_id

  • salary_type_id (1: monthly, 2: hourly, 3: weekly, 4: bi-weekly, 5: annually)

  • person_id

  • started_on

  • time

Supported relationship filter params

  • person

Supported group params

  • salary

  • organization

  • people_custom_fields

  • person

Supported date period dates

  • start_date

  • end_date

GET /api/v2/reports/salary_reports
Requestsreturns engagement reports

GET  /api/v2/reports/salary_reports

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "salary-report-salary-179-d41d8cd98f00b204e9800998ecf8427e",
      "type": "new_salary_reports",
      "attributes": {
        "group": "salary",
        "count": 537,
        "time": 184480,
        "salary_type_id": null,
        "total_estimated_weekly_hours": 2400,
        "overhead": null,
        "people_custom_fields": {},
        "formula_fields": {},
        "start_date_period": null,
        "end_date_period": null,
        "date_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_hourly_cost": 2500,
        "total_hourly_cost_default": 2500,
        "total_hourly_cost_normalized": 2500,
        "total_weekly_cost": 100000,
        "total_weekly_cost_default": 100000,
        "total_weekly_cost_normalized": 100000,
        "total_bi_weekly_cost": 200000,
        "total_bi_weekly_cost_default": 200000,
        "total_bi_weekly_cost_normalized": 200000,
        "total_monthly_cost": 400000,
        "total_monthly_cost_default": 400000,
        "total_monthly_cost_normalized": 400000,
        "total_annually_cost": 5200000,
        "total_annually_cost_default": 5200000,
        "total_annually_cost_normalized": 5200000
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1088
          }
        },
        "person": {
          "data": null
        },
        "salary": {
          "data": {
            "type": "salaries",
            "id": "179"
          }
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "179",
      "type": "salaries",
      "attributes": {
        "working_days": [],
        "working_hours": [
          8,
          8,
          8,
          8,
          8,
          0,
          0
        ],
        "salary_type_id": 2,
        "started_on": "2021-07-14",
        "ended_on": null,
        "hours": "8.0",
        "overhead": true,
        "note": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "cost": 2000,
        "cost_default": 2500,
        "cost_normalized": 2000,
        "hourly_rate": 2000,
        "hourly_rate_default": 2500,
        "hourly_rate_normalized": 2000
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1088
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "3347"
          }
        }
      }
    },
    {
      "id": "3347",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3288@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:08:52.000+02:00",
        "is_user": true,
        "user_id": 3328,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:08:52.854+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1088
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4928"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4928",
      "type": "companies",
      "attributes": {
        "name": "Client3850",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:08:52.850+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1088
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/salary_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/salary_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get salary reports
GET/api/v2/reports/salary_reports


Service Reports

Supported filter params

Supported filter params can be found on services endpoint

Supported group params

  • service

  • budget

  • service_type

  • company

  • responsible

  • subsidiary

  • project

  • budget_status

  • project_type

  • organization

  • recurring

  • budget_custom_fields

  • pricing_type

  • billable

Supported date period dates

  • date
GET /api/v2/reports/service_reports
Requestsreturns service reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "service-report-service-340-d41d8cd98f00b204e9800998ecf8427e",
      "type": "service_reports",
      "attributes": {
        "group": "service",
        "count": 1,
        "budget_status": null,
        "project_type": null,
        "billing_type": null,
        "pricing_type": null,
        "billable": null,
        "total_booked_time": 0,
        "total_worked_time": 0,
        "total_billable_time": 0,
        "total_estimated_time": null,
        "total_budgeted_time": 0,
        "total_estimated_remaining_time": null,
        "total_unapproved_time": 0,
        "total_future_booked_time": 0,
        "total_forecasted_billable_time": 0,
        "average_forecasted_margin": "100.0",
        "average_forecasted_budget_usage": "100.0",
        "average_forecasted_time_usage": null,
        "average_profit_margin": "100.0",
        "average_budget_usage": "0.0",
        "average_discount": null,
        "recurring": false,
        "budget_custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_revenue": 125000,
        "total_revenue_default": 125000,
        "total_revenue_normalized": 125000,
        "total_price": 100000,
        "total_price_default": 100000,
        "total_price_normalized": 100000,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_profit": 125000,
        "total_profit_default": 125000,
        "total_profit_normalized": 125000,
        "total_budget_total": 125000,
        "total_budget_total_default": 125000,
        "total_budget_total_normalized": 125000,
        "total_budget_used": 0,
        "total_budget_used_default": 0,
        "total_budget_used_normalized": 0,
        "total_budget_remaining": 125000,
        "total_budget_remaining_default": 125000,
        "total_budget_remaining_normalized": 125000,
        "average_actual_rate": null,
        "average_actual_rate_default": null,
        "average_actual_rate_normalized": null,
        "average_hourly_rate": null,
        "average_hourly_rate_default": null,
        "average_hourly_rate_normalized": null,
        "total_future_revenue": 0,
        "total_future_revenue_default": 0,
        "total_future_revenue_normalized": 0,
        "total_future_budget_used": 125000,
        "total_future_budget_used_default": 125000,
        "total_future_budget_used_normalized": 125000,
        "total_future_cost": 0,
        "total_future_cost_default": 0,
        "total_future_cost_normalized": 0,
        "total_forecasted_revenue": 125000,
        "total_forecasted_revenue_default": 125000,
        "total_forecasted_revenue_normalized": 125000,
        "total_forecasted_cost": 0,
        "total_forecasted_cost_default": 0,
        "total_forecasted_cost_normalized": 0,
        "total_forecasted_profit": 125000,
        "total_forecasted_profit_default": 125000,
        "total_forecasted_profit_normalized": 125000,
        "total_forecasted_budget_used": 125000,
        "total_forecasted_budget_used_default": 125000,
        "total_forecasted_budget_used_normalized": 125000,
        "total_discount_amount": 0,
        "total_discount_amount_default": 0,
        "total_discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "340"
          }
        },
        "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": "340",
      "type": "services",
      "attributes": {
        "name": "test name",
        "position": 1,
        "deleted_at": null,
        "billable": true,
        "description": null,
        "tracking_enabled": true,
        "pricing_type_id": 1,
        "billing_type_id": null,
        "worked_time": 0,
        "unapproved_time": 0,
        "billable_time": 0,
        "estimated_time": null,
        "booked_time": 0,
        "budgeted_time": 0,
        "profit_margin": 100,
        "unit_id": 2,
        "quantity": "1.0",
        "discount": null,
        "future_booked_time": 0,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "hourly_rate": null,
        "hourly_rate_default": null,
        "hourly_rate_normalized": null,
        "price": 100000,
        "price_default": 125000,
        "price_normalized": 100000,
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "expense_amount": 0,
        "expense_amount_default": 0,
        "expense_amount_normalized": 0,
        "expense_billable_amount": 0,
        "expense_billable_amount_default": 0,
        "expense_billable_amount_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "533"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "686"
          }
        },
        "section": {
          "data": null
        }
      }
    },
    {
      "id": "533",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null,
        "description": "test description"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        }
      }
    },
    {
      "id": "686",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-12-01",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "expense_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 100,
        "discount": null,
        "email_key": "f275eec7a9c8579ec7470184635abbdf",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 100,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-12-01T00:00:00.000+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2020-12-01",
        "sales_closed_on": null,
        "sample_data": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "services_revenue": 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": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 100000,
        "pending_invoicing_default": 125000,
        "pending_invoicing_normalized": 100000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 100000,
        "budget_remaining_default": 125000,
        "budget_remaining_normalized": 100000,
        "projected_revenue": 50000,
        "projected_revenue_default": 62500,
        "projected_revenue_normalized": 50000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 100000,
        "forecasted_revenue_default": 125000,
        "forecasted_revenue_normalized": 100000,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 100000,
        "forecasted_profit_default": 125000,
        "forecasted_profit_normalized": 100000,
        "forecasted_budget_used": 100000,
        "forecasted_budget_used_default": 125000,
        "forecasted_budget_used_normalized": 100000,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "3436"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5018"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "3437"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "6010"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3436",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3377@email.com",
        "title": null,
        "joined_at": "2020-12-01T00:00:00.000+01:00",
        "last_seen_at": "2020-12-01T00:00:00.000+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 3417,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:09:02.204+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5017"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "5018",
      "type": "companies",
      "attributes": {
        "name": "Client3923",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-12-01T00:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3437",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3378@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2020-12-01T00:00:00.000+01:00",
        "is_user": true,
        "user_id": 3418,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-12-01T00:00:00.000+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5019"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6010",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        }
      }
    },
    {
      "id": "5017",
      "type": "companies",
      "attributes": {
        "name": "Organization1105",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:09:02.202+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "5019",
      "type": "companies",
      "attributes": {
        "name": "Client3924",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-12-01T00:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1105
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get service reports
GET/api/v2/reports/service_reports


Task Reports

Supported filter params

Supported filter params can be found on tasks endpoint

Supported group params

  • task

  • project

  • task_list

  • board

  • assignee

  • creator

  • last_actor

  • company

  • status

  • organization

  • custom_fields

Supported date period dates

  • created_at

  • closed_at

  • last_activity_at

  • due_date

  • start_date

GET /api/v2/reports/task_reports
Requestsreturns task reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "task-report-task-145-d41d8cd98f00b204e9800998ecf8427e",
      "type": "task_reports",
      "attributes": {
        "group": "task",
        "count": 1,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "status": null,
        "total_worked_time": null,
        "total_initial_estimate": null,
        "total_remaining_time": 0,
        "total_estimation_offset_time": null,
        "total_estimate_at_completion": null,
        "custom_fields": {},
        "formula_fields": {},
        "created_at_period": null,
        "closed_at_period": null,
        "last_activity_at_period": null,
        "due_date_period": null,
        "start_date_period": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "task": {
          "data": {
            "type": "tasks",
            "id": "145"
          }
        },
        "project": {
          "data": null
        },
        "task_list": {
          "data": null
        },
        "board": {
          "data": null
        },
        "assignee": {
          "data": null
        },
        "creator": {
          "data": null
        },
        "last_actor": {
          "data": null
        },
        "company": {
          "data": null
        },
        "parent_task": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "145",
      "type": "tasks",
      "attributes": {
        "title": "Ticket title",
        "description": null,
        "number": 1,
        "private": false,
        "due_date": null,
        "start_date": null,
        "closed_at": null,
        "created_at": "2021-07-24T01:09:27.479+02:00",
        "updated_at": "2021-07-24T01:09:27.479+02:00",
        "repeat_schedule_id": null,
        "repeat_on_interval": null,
        "repeat_on_monthday": null,
        "repeat_on_weekday": [],
        "repeat_on_date": null,
        "repeat_origin_id": null,
        "email_key": "825d5e21c721be76147e5e891f6e087b",
        "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": 1190
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "934"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "3724"
          }
        },
        "assignee": {
          "data": null
        },
        "last_actor": {
          "data": null
        },
        "task_list": {
          "data": {
            "type": "task_lists",
            "id": "145"
          }
        },
        "parent_task": {
          "data": null
        },
        "attachments": {
          "data": []
        }
      }
    },
    {
      "id": "934",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-07-24T01:09:27.300+02:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5498"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "3723"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "3724",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3665@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:09:27.000+02:00",
        "is_user": true,
        "user_id": 3705,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:09:27.323+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5499"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "145",
      "type": "task_lists",
      "attributes": {
        "name": "Milestone120",
        "position": 1,
        "archived_at": null,
        "email_key": "21f44735daaa41994162b5797d4d0300"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "935"
          }
        },
        "board": {
          "data": {
            "type": "boards",
            "id": "173"
          }
        }
      }
    },
    {
      "id": "5498",
      "type": "companies",
      "attributes": {
        "name": "Client4318",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:09:27.298+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3723",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3664@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:09:27.000+02:00",
        "is_user": true,
        "user_id": 3704,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:09:27.273+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5497"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "5499",
      "type": "companies",
      "attributes": {
        "name": "Client4319",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:09:27.320+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "935",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 2,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-07-24T01:09:27.380+02:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5501"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "3725"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "173",
      "type": "boards",
      "attributes": {
        "name": "Board133",
        "position": 1,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "936"
          }
        }
      }
    },
    {
      "id": "5497",
      "type": "companies",
      "attributes": {
        "name": "Client4317",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:09:27.269+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "5501",
      "type": "companies",
      "attributes": {
        "name": "Client4321",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:09:27.378+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3725",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3666@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:09:27.000+02:00",
        "is_user": true,
        "user_id": 3706,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:09:27.354+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5500"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "936",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 3,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-07-24T01:09:27.427+02:00",
        "board_count": 1,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5503"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "3726"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "5500",
      "type": "companies",
      "attributes": {
        "name": "Client4320",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:09:27.351+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "5503",
      "type": "companies",
      "attributes": {
        "name": "Client4323",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:09:27.425+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3726",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3667@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:09:27.000+02:00",
        "is_user": true,
        "user_id": 3707,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:09:27.401+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5502"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "5502",
      "type": "companies",
      "attributes": {
        "name": "Client4322",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:09:27.398+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1190
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get task reports
GET/api/v2/reports/task_reports


Time Entry Reports

Supported filter params

Supported filter params can be found on time entries endpoint

Supported group params

  • time_entry

  • person

  • task

  • service

  • service_type

  • pricing_type_id

  • budget

  • project

  • responsible

  • company

  • status

  • invoiced

  • organization

  • people_custom_fields

  • project_type_id

Supported date period dates

  • date

  • created_at

GET /api/v2/reports/time_entry_reports
Requestsreturns time entry reports

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "time-entry-report-time_entry-12-d41d8cd98f00b204e9800998ecf8427e",
      "type": "time_entry_reports",
      "attributes": {
        "group": "time_entry",
        "count": 1,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "day": null,
        "status": null,
        "jira_issue_id": null,
        "invoiced": false,
        "overhead": false,
        "total_time": 480,
        "total_billable_time": 480,
        "total_recognized_time": null,
        "pricing_type_id": null,
        "unit_id": null,
        "project_type_id": null,
        "track_method_id": null,
        "average_recognized_margin": null,
        "people_custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "created_at_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_work_cost": 0,
        "total_work_cost_default": 0,
        "total_work_cost_normalized": 0,
        "total_overhead_cost": 0,
        "total_overhead_cost_default": 0,
        "total_overhead_cost_normalized": 0,
        "total_internal_overhead_cost": 0,
        "total_internal_overhead_cost_default": 0,
        "total_internal_overhead_cost_normalized": 0,
        "total_facility_overhead_cost": 0,
        "total_facility_overhead_cost_default": 0,
        "total_facility_overhead_cost_normalized": 0,
        "average_blended_rate": null,
        "average_blended_rate_default": null,
        "average_blended_rate_normalized": null,
        "total_recognized_revenue": null,
        "total_recognized_revenue_default": null,
        "total_recognized_revenue_normalized": null,
        "total_recognized_profit": null,
        "total_recognized_profit_default": null,
        "total_recognized_profit_normalized": null,
        "total_billable_revenue": null,
        "total_billable_revenue_default": null,
        "total_billable_revenue_normalized": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "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
        },
        "approver": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "12",
      "type": "time_entries",
      "attributes": {
        "date": "2021-07-24",
        "created_at": "2021-07-24T01:10:08.346+02:00",
        "time": 480,
        "billable_time": 480,
        "note": "test note",
        "track_method_id": null,
        "started_at": null,
        "timer_started_at": null,
        "timer_stopped_at": null,
        "approved": false,
        "approved_at": null,
        "updated_at": "2021-07-24T01:10:08.346+02:00",
        "calendar_event_id": null,
        "invoiced": false,
        "overhead": false,
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "overhead_cost": 0,
        "overhead_cost_default": 0,
        "overhead_cost_normalized": 0,
        "internal_overhead_cost": 0,
        "internal_overhead_cost_default": 0,
        "internal_overhead_cost_normalized": 0,
        "facility_overhead_cost": 0,
        "facility_overhead_cost_default": 0,
        "facility_overhead_cost_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "4451"
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "509"
          }
        },
        "task": {
          "data": null
        },
        "approver": {
          "data": null
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "4450"
          }
        },
        "rejecter": {
          "data": null
        }
      }
    },
    {
      "id": "4451",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user4392@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:10:08.000+02:00",
        "is_user": true,
        "user_id": 4432,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:10:08.246+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6634"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "509",
      "type": "services",
      "attributes": {
        "name": "test name",
        "position": 1,
        "deleted_at": null,
        "billable": true,
        "description": null,
        "tracking_enabled": true,
        "pricing_type_id": 1,
        "billing_type_id": null,
        "worked_time": 480,
        "unapproved_time": 480,
        "billable_time": 0,
        "estimated_time": null,
        "booked_time": 0,
        "budgeted_time": 0,
        "profit_margin": 100,
        "unit_id": 2,
        "quantity": "1.0",
        "discount": null,
        "future_booked_time": 0,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "hourly_rate": null,
        "hourly_rate_default": null,
        "hourly_rate_normalized": null,
        "price": 100000,
        "price_default": 125000,
        "price_normalized": 100000,
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "expense_amount": 0,
        "expense_amount_default": 0,
        "expense_amount_normalized": 0,
        "expense_billable_amount": 0,
        "expense_billable_amount_default": 0,
        "expense_billable_amount_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "702"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "835"
          }
        },
        "section": {
          "data": null
        }
      }
    },
    {
      "id": "4450",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user4391@email.com",
        "title": null,
        "joined_at": "2021-07-24T01:10:08.000+02:00",
        "last_seen_at": "2021-07-24T01:10:08.377+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 4431,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:10:08.217+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6633"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6634",
      "type": "companies",
      "attributes": {
        "name": "Client5397",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:10:08.242+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "702",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null,
        "description": "test description"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        }
      }
    },
    {
      "id": "835",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-07-24",
        "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": "a936385d01ffeef3dde29ee384201fb6",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 100,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 480,
        "time_to_close": null,
        "unapproved_entries_count": 1,
        "rejected_entries_count": 0,
        "estimated_remaining_time": -480,
        "unapproved_time": 480,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-07-24T01:10:08.316+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-07-24",
        "sales_closed_on": null,
        "sample_data": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "services_revenue": 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": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 100000,
        "pending_invoicing_default": 125000,
        "pending_invoicing_normalized": 100000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 100000,
        "budget_remaining_default": 125000,
        "budget_remaining_normalized": 100000,
        "projected_revenue": 50000,
        "projected_revenue_default": 62500,
        "projected_revenue_normalized": 50000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 100000,
        "forecasted_revenue_default": 125000,
        "forecasted_revenue_normalized": 100000,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 100000,
        "forecasted_profit_default": 125000,
        "forecasted_profit_normalized": 100000,
        "forecasted_budget_used": 100000,
        "forecasted_budget_used_default": 125000,
        "forecasted_budget_used_normalized": 100000,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "4450"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6635"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "4452"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "6847"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6633",
      "type": "companies",
      "attributes": {
        "name": "Organization1247",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-07-24T01:10:08.216+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "6635",
      "type": "companies",
      "attributes": {
        "name": "Client5398",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:10:08.272+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4452",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user4393@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-07-24T01:10:08.000+02:00",
        "is_user": true,
        "user_id": 4433,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-07-24T01:10:08.281+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6636"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6847",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        }
      }
    },
    {
      "id": "6636",
      "type": "companies",
      "attributes": {
        "name": "Client5399",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-07-24T01:10:08.278+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1247
          }
        },
        "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
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "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": {