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-03-06",
        "end_date": "2021-03-06",
        "pricing_type_id": null,
        "project_type": null,
        "total_recognized_time": null,
        "average_recognized_margin": null,
        "people_custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "average_blended_rate": null,
        "average_blended_rate_default": null,
        "average_blended_rate_normalized": null,
        "total_recognized_revenue": null,
        "total_recognized_revenue_default": null,
        "total_recognized_revenue_normalized": null,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_recognized_profit": null,
        "total_recognized_profit_default": null,
        "total_recognized_profit_normalized": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "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-03-06",
        "ended_on": "2021-03-06",
        "note": null,
        "total_time": 0,
        "total_working_days": 0,
        "percentage": null,
        "created_at": "2021-03-06T00:05:33.827+01:00",
        "updated_at": "2021-03-06T00:05:33.827+01:00",
        "people_custom_fields": null,
        "approved": true,
        "approved_at": "2021-03-06T00:05:33.827+01:00",
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "canceled": false,
        "canceled_at": null,
        "booking_method_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "63"
          }
        },
        "event": {
          "data": null
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1539"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1536"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "1536"
          }
        },
        "approver": {
          "data": {
            "type": "people",
            "id": "1536"
          }
        },
        "rejecter": {
          "data": null
        },
        "canceler": {
          "data": null
        },
        "origin": {
          "data": null
        }
      }
    },
    {
      "id": "63",
      "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,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "121"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "172"
          }
        },
        "section": {
          "data": null
        }
      }
    },
    {
      "id": "1539",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1488@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:05:33.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:05:33.788+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2051"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1536",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1485@email.com",
        "title": null,
        "joined_at": "2021-03-06T00:05:34.000+01:00",
        "last_seen_at": "2021-03-06T00:05:34.184+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:05:33.608+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2047"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "121",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        }
      }
    },
    {
      "id": "172",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-03-06",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "expense_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 100,
        "discount": null,
        "email_key": "0c7e403b1821ebea00d304d209d0378b",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 200,
        "forecasted_time_usage": 0,
        "budget_usage": 100,
        "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-03-06T00:05:33.730+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-03-06",
        "sales_closed_on": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "services_revenue": 100000,
        "services_revenue_default": 125000,
        "services_revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 100000,
        "pending_invoicing_default": 125000,
        "pending_invoicing_normalized": 100000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 50000,
        "projected_revenue_default": 62500,
        "projected_revenue_normalized": 50000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 100000,
        "forecasted_revenue_default": 125000,
        "forecasted_revenue_normalized": 100000,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 100000,
        "forecasted_profit_default": 125000,
        "forecasted_profit_normalized": 100000,
        "forecasted_budget_used": 200000,
        "forecasted_budget_used_default": 250000,
        "forecasted_budget_used_normalized": 200000,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1536"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2049"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1538"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "3206"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "2051",
      "type": "companies",
      "attributes": {
        "name": "Client1433",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:05:33.784+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2047",
      "type": "companies",
      "attributes": {
        "name": "Organization619",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:05:33.606+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2049",
      "type": "companies",
      "attributes": {
        "name": "Client1431",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:05:33.675+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1538",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1487@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:05:33.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:05:33.688+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2050"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3206",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        }
      }
    },
    {
      "id": "2050",
      "type": "companies",
      "attributes": {
        "name": "Client1432",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:05:33.683+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 619
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/booking_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/booking_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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-308-d41d8cd98f00b204e9800998ecf8427e",
      "type": "budget_reports",
      "attributes": {
        "group": "budget",
        "count": 1,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "status": null,
        "project_type": null,
        "total_worked_time": 0,
        "total_billable_time": 0,
        "total_estimated_time": 0,
        "total_budgeted_time": 0,
        "total_estimated_remaining_time": 0,
        "total_unapproved_time": 0,
        "total_future_booked_time": 0,
        "total_forecasted_billable_time": 0,
        "average_forecasted_margin": null,
        "average_forecasted_budget_usage": null,
        "average_forecasted_time_usage": null,
        "average_profit_margin": null,
        "average_budget_usage": null,
        "average_forecasted_budget_overrun": null,
        "recurring": false,
        "custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "created_at_period": null,
        "closed_at_period": null,
        "end_date_period": null,
        "last_activity_at_period": null,
        "delivered_on_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_revenue": 0,
        "total_revenue_default": 0,
        "total_revenue_normalized": 0,
        "total_services_revenue": 0,
        "total_services_revenue_default": 0,
        "total_services_revenue_normalized": 0,
        "total_work_cost": 0,
        "total_work_cost_default": 0,
        "total_work_cost_normalized": 0,
        "total_expense": 0,
        "total_expense_default": 0,
        "total_expense_normalized": 0,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_profit": 0,
        "total_profit_default": 0,
        "total_profit_normalized": 0,
        "total_budget_total": 0,
        "total_budget_total_default": 0,
        "total_budget_total_normalized": 0,
        "total_budget_used": 0,
        "total_budget_used_default": 0,
        "total_budget_used_normalized": 0,
        "total_budget_remaining": 0,
        "total_budget_remaining_default": 0,
        "total_budget_remaining_normalized": 0,
        "total_invoiced": 0,
        "total_invoiced_default": 0,
        "total_invoiced_normalized": 0,
        "total_pending_invoicing": 0,
        "total_pending_invoicing_default": 0,
        "total_pending_invoicing_normalized": 0,
        "average_actual_rate": null,
        "average_actual_rate_default": null,
        "average_actual_rate_normalized": null,
        "average_invoiced_rate": null,
        "average_invoiced_rate_default": null,
        "average_invoiced_rate_normalized": null,
        "total_future_revenue": 0,
        "total_future_revenue_default": 0,
        "total_future_revenue_normalized": 0,
        "total_future_budget_used": 0,
        "total_future_budget_used_default": 0,
        "total_future_budget_used_normalized": 0,
        "total_future_cost": 0,
        "total_future_cost_default": 0,
        "total_future_cost_normalized": 0,
        "total_forecasted_revenue": 0,
        "total_forecasted_revenue_default": 0,
        "total_forecasted_revenue_normalized": 0,
        "total_forecasted_cost": 0,
        "total_forecasted_cost_default": 0,
        "total_forecasted_cost_normalized": 0,
        "total_forecasted_profit": 0,
        "total_forecasted_profit_default": 0,
        "total_forecasted_profit_normalized": 0,
        "total_forecasted_budget_used": 0,
        "total_forecasted_budget_used_default": 0,
        "total_forecasted_budget_used_normalized": 0,
        "total_expense_billable": 0,
        "total_expense_billable_default": 0,
        "total_expense_billable_normalized": 0,
        "total_forecasted_budget_overrun": 0,
        "total_forecasted_budget_overrun_default": 0,
        "total_forecasted_budget_overrun_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 655
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "308"
          }
        },
        "contract": {
          "data": null
        },
        "project": {
          "data": null
        },
        "company": {
          "data": null
        },
        "responsible": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "308",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-03-06",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "expense_approval": false,
        "client_access": false,
        "deal_type_id": 2,
        "budget": true,
        "sales_status_id": null,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "discount": null,
        "email_key": "418b11bc0be71018c003fb355cc0c12f",
        "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,
        "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-03-06T00:06:34.458+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-03-06",
        "sales_closed_on": 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": 655
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1962"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2622"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1963"
          }
        },
        "deal_status": {
          "meta": {
            "included": false
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "314"
          }
        },
        "lost_reason": {
          "meta": {
            "included": false
          }
        },
        "contract": {
          "data": null
        },
        "contact": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1962",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1911@email.com",
        "title": null,
        "joined_at": "2021-03-06T00:06:34.000+01:00",
        "last_seen_at": "2021-03-06T00:06:34.484+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:06:34.260+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 655
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2621"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2622",
      "type": "companies",
      "attributes": {
        "name": "Client1968",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:06:34.333+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 655
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1963",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1912@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:06:34.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:06:34.346+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 655
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2623"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "314",
      "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-03-06T00:06:34.431+01:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": 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": 655
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2625"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1964"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "2621",
      "type": "companies",
      "attributes": {
        "name": "Organization655",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:06:34.258+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 655
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2623",
      "type": "companies",
      "attributes": {
        "name": "Client1969",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:06:34.341+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 655
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2625",
      "type": "companies",
      "attributes": {
        "name": "Client1971",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:06:34.427+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 655
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1964",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1913@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:06:34.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:06:34.391+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 655
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2624"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2624",
      "type": "companies",
      "attributes": {
        "name": "Client1970",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:06:34.386+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 655
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/budget_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/budget_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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": 682
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "123"
          }
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "123",
      "type": "companies",
      "attributes": {
        "name": "Client2196",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:06:49.593+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 682
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/company_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/company_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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-367-d41d8cd98f00b204e9800998ecf8427e",
      "type": "deal_reports",
      "attributes": {
        "group": "deal",
        "count": 1,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "sales_status_id": null,
        "total_worked_time": 0,
        "total_billable_time": 0,
        "total_estimated_time": 0,
        "total_budgeted_time": 0,
        "total_estimated_remaining_time": 0,
        "custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "created_at_period": null,
        "last_activity_at_period": null,
        "sales_closed_at_period": null,
        "sales_closed_on_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_revenue": 0,
        "total_revenue_default": 0,
        "total_revenue_normalized": 0,
        "total_services_revenue": 0,
        "total_services_revenue_default": 0,
        "total_services_revenue_normalized": 0,
        "total_projected_revenue": 0,
        "total_projected_revenue_default": 0,
        "total_projected_revenue_normalized": 0,
        "total_work_cost": 0,
        "total_work_cost_default": 0,
        "total_work_cost_normalized": 0,
        "total_expense": 0,
        "total_expense_default": 0,
        "total_expense_normalized": 0,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_profit": 0,
        "total_profit_default": 0,
        "total_profit_normalized": 0,
        "total_budget_total": 0,
        "total_budget_total_default": 0,
        "total_budget_total_normalized": 0,
        "total_budget_used": 0,
        "total_budget_used_default": 0,
        "total_budget_used_normalized": 0,
        "total_invoiced": 0,
        "total_invoiced_default": 0,
        "total_invoiced_normalized": 0,
        "total_pending_invoicing": 0,
        "total_pending_invoicing_default": 0,
        "total_pending_invoicing_normalized": 0,
        "average_actual_rate": 0,
        "average_actual_rate_default": 0,
        "average_actual_rate_normalized": 0,
        "average_rate": 0,
        "average_rate_default": 0,
        "average_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 701
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "367"
          }
        },
        "company": {
          "data": null
        },
        "responsible": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "deal_status": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "367",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-03-06",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "expense_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "discount": null,
        "email_key": "20a688d7af4a8ee26f73fbb93e4a72cf",
        "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,
        "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-03-06T00:06:52.448+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-03-06",
        "sales_closed_on": 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": 701
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2120"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2924"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2121"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "3746"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "2120",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2069@email.com",
        "title": null,
        "joined_at": "2021-03-06T00:06:52.000+01:00",
        "last_seen_at": "2021-03-06T00:06:52.481+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:06:52.349+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 701
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2923"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2924",
      "type": "companies",
      "attributes": {
        "name": "Client2233",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:06:52.381+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 701
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2121",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2070@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:06:52.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:06:52.398+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 701
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2925"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3746",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 701
          }
        }
      }
    },
    {
      "id": "2923",
      "type": "companies",
      "attributes": {
        "name": "Organization701",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:06:52.347+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 701
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2925",
      "type": "companies",
      "attributes": {
        "name": "Client2234",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:06:52.392+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 701
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/deal_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/deal_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

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


Engagement Reports

Supported filter params

  • ended_on

  • engagement_id

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

  • person_id

  • started_on

  • time

Supported relationship filter params

  • person

Supported group params

  • engagement

  • organization

  • people_custom_fields

  • person

Supported date period dates

  • start_date

  • end_date

GET /api/v2/reports/engagement_reports
Requestsreturns engagement reports

GET  /api/v2/reports/engagement_reports

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "engagement-report-engagement-164-d41d8cd98f00b204e9800998ecf8427e",
      "type": "engagement_reports",
      "attributes": {
        "group": "engagement",
        "count": 312,
        "time": 107680,
        "engagement_type_id": null,
        "people_custom_fields": {},
        "formula_fields": {},
        "start_date_period": null,
        "end_date_period": null,
        "date_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_rate": 4486666,
        "total_rate_default": 4486666,
        "total_rate_normalized": 4486666
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 732
          }
        },
        "person": {
          "data": null
        },
        "engagement": {
          "data": {
            "type": "salaries",
            "id": "164"
          }
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "164",
      "type": "salaries",
      "attributes": {
        "working_days": [],
        "working_hours": [
          8,
          8,
          8,
          8,
          8,
          0,
          0
        ],
        "salary_type_id": 2,
        "started_on": "2021-02-24",
        "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": 732
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2228"
          }
        }
      }
    },
    {
      "id": "2228",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2177@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:07:05.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:07:05.252+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 732
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3110"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3110",
      "type": "companies",
      "attributes": {
        "name": "Client2388",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:07:05.247+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 732
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/engagement_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/engagement_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get booking reports
GET/api/v2/reports/engagement_reports


Entitlement Reports

Supported filter params

Supported filter params can be found on entitlements endpoint

Supported group params

  • entitlement

  • event

  • person

  • organization

  • people_custom_fields

Supported date period dates

  • start_date

  • end_date

GET /api/v2/reports/entitlement_reports
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": "booking-report-entitlement-26-d41d8cd98f00b204e9800998ecf8427e",
      "type": "entitlement_reports",
      "attributes": {
        "group": "entitlement",
        "count": 1,
        "total_allocated": 22,
        "total_used": 0,
        "people_custom_fields": {},
        "formula_fields": {},
        "start_date_period": null,
        "end_date_period": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "749"
          }
        },
        "entitlement": {
          "data": {
            "type": "entitlements",
            "id": "26"
          }
        },
        "person": {
          "data": null
        },
        "event": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "26",
      "type": "entitlements",
      "attributes": {
        "start_date": "2021-03-05",
        "end_date": "2021-03-16",
        "allocated": 22,
        "used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 749
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "81"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2318"
          }
        }
      }
    },
    {
      "id": "81",
      "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": 749
          }
        }
      }
    },
    {
      "id": "2318",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2267@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:07:15.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:07:15.943+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 749
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3200"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3200",
      "type": "companies",
      "attributes": {
        "name": "Client2461",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:07:15.937+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 749
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/entitlement_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/entitlement_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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": 760
          }
        },
        "expense": {
          "data": {
            "type": "expenses",
            "id": "42"
          }
        },
        "deal": {
          "data": null
        },
        "project": {
          "data": null
        },
        "company": {
          "data": null
        },
        "service_type": {
          "data": null
        },
        "vendor": {
          "data": null
        },
        "person": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "42",
      "type": "expenses",
      "attributes": {
        "name": "Višak",
        "date": "2021-03-06",
        "pay_on": null,
        "paid_on": null,
        "position": 1,
        "invoiced": false,
        "approved": true,
        "approved_at": "2021-03-06T00:07:18.925+01:00",
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "deleted_at": null,
        "reimbursable": null,
        "reimbursed_on": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-03-06",
        "created_at": "2021-03-06T00:07:18.927+01:00",
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "billable_amount": 0,
        "billable_amount_default": 0,
        "billable_amount_normalized": 0,
        "profit": -10000,
        "profit_default": -12500,
        "profit_normalized": -10000
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 760
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "434"
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "260"
          }
        },
        "person": {
          "data": null
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2351"
          }
        },
        "approver": {
          "data": {
            "type": "people",
            "id": "2352"
          }
        },
        "rejecter": {
          "data": null
        },
        "vendor": {
          "data": null
        },
        "attachment": {
          "data": null
        }
      }
    },
    {
      "id": "434",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-03-06",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "expense_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "discount": null,
        "email_key": "091c6849ca6aa44224871f72bfd4e0e3",
        "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,
        "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-03-06T00:07:18.773+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-03-06",
        "sales_closed_on": 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": 10000,
        "cost_default": 12500,
        "cost_normalized": 10000,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": -10000,
        "profit_default": -12500,
        "profit_normalized": -10000,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 10000,
        "expense_default": 12500,
        "expense_normalized": 10000,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 10000,
        "forecasted_cost_default": 12500,
        "forecasted_cost_normalized": 10000,
        "forecasted_profit": -10000,
        "forecasted_profit_default": -12500,
        "forecasted_profit_normalized": -10000,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 760
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2351"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3234"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2352"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "4104"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "260",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 760
          }
        }
      }
    },
    {
      "id": "2351",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2300@email.com",
        "title": null,
        "joined_at": "2021-03-06T00:07:18.000+01:00",
        "last_seen_at": "2021-03-06T00:07:18.972+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:07:18.679+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 760
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3233"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2352",
      "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,
        "invited_at": "2021-03-06T00:07:18.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:07:18.725+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 760
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3235"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3234",
      "type": "companies",
      "attributes": {
        "name": "Client2484",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:07:18.709+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 760
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4104",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 760
          }
        }
      }
    },
    {
      "id": "3233",
      "type": "companies",
      "attributes": {
        "name": "Organization760",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:07:18.677+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 760
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3235",
      "type": "companies",
      "attributes": {
        "name": "Client2485",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:07:18.719+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 760
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/expense_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/expense_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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-03-06",
        "total_time": 480,
        "total_billable_time": 0,
        "total_recognized_time": null,
        "pricing_type_id": null,
        "project_type_id": null,
        "average_profit_margin": null,
        "average_recognized_margin": null,
        "future": null,
        "approval_status": null,
        "date_period": null,
        "formula_fields": {},
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_revenue": null,
        "total_revenue_default": null,
        "total_revenue_normalized": null,
        "total_recognized_revenue": null,
        "total_recognized_revenue_default": null,
        "total_recognized_revenue_normalized": null,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_profit": null,
        "total_profit_default": null,
        "total_profit_normalized": null,
        "total_recognized_profit": null,
        "total_recognized_profit_default": null,
        "total_recognized_profit_normalized": null,
        "average_blended_rate": null,
        "average_blended_rate_default": null,
        "average_blended_rate_normalized": null,
        "total_budget_used": 0,
        "total_budget_used_default": 0,
        "total_budget_used_normalized": 0,
        "total_invoiced": 0,
        "total_invoiced_default": 0,
        "total_invoiced_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "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-03-06",
        "created_at": "2021-03-06T00:07:51.449+01:00",
        "time": 480,
        "billable_time": 480,
        "note": "test note",
        "track_method_id": 1,
        "tracking_type_id": null,
        "started_at": null,
        "timer_started_at": null,
        "timer_stopped_at": null,
        "approved": false,
        "approved_at": null,
        "updated_at": "2021-03-06T00:07:51.449+01:00",
        "calendar_event_id": null,
        "invoiced": false,
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "overhead_cost": 0,
        "overhead_cost_default": 0,
        "overhead_cost_normalized": 0,
        "internal_overhead_cost": 0,
        "internal_overhead_cost_default": 0,
        "internal_overhead_cost_normalized": 0,
        "facility_overhead_cost": 0,
        "facility_overhead_cost_default": 0,
        "facility_overhead_cost_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2619"
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "300"
          }
        },
        "task": {
          "data": null
        },
        "approver": {
          "data": null
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "2618"
          }
        },
        "rejecter": {
          "data": null
        }
      }
    },
    {
      "id": "2619",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2568@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:07:51.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:07:51.331+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3723"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "300",
      "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,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "457"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "630"
          }
        },
        "section": {
          "data": null
        }
      }
    },
    {
      "id": "2618",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2567@email.com",
        "title": null,
        "joined_at": "2021-03-06T00:07:51.000+01:00",
        "last_seen_at": "2021-03-06T00:07:51.501+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:07:51.301+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3722"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3723",
      "type": "companies",
      "attributes": {
        "name": "Client2926",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:07:51.327+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "457",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        }
      }
    },
    {
      "id": "630",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-03-06",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "expense_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 100,
        "discount": null,
        "email_key": "9144769abba164614f6ef4c9d9473eb1",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 200,
        "forecasted_time_usage": 0,
        "budget_usage": 100,
        "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-03-06T00:07:51.403+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-03-06",
        "sales_closed_on": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "services_revenue": 100000,
        "services_revenue_default": 125000,
        "services_revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 100000,
        "pending_invoicing_default": 125000,
        "pending_invoicing_normalized": 100000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "actual_rate": 12500,
        "actual_rate_default": 15625,
        "actual_rate_normalized": 12500,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 50000,
        "projected_revenue_default": 62500,
        "projected_revenue_normalized": 50000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 100000,
        "forecasted_revenue_default": 125000,
        "forecasted_revenue_normalized": 100000,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 100000,
        "forecasted_profit_default": 125000,
        "forecasted_profit_normalized": 100000,
        "forecasted_budget_used": 200000,
        "forecasted_budget_used_default": 250000,
        "forecasted_budget_used_normalized": 200000,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2618"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3724"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2620"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "4519"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "3722",
      "type": "companies",
      "attributes": {
        "name": "Organization807",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:07:51.300+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3724",
      "type": "companies",
      "attributes": {
        "name": "Client2927",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:07:51.358+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2620",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2569@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:07:51.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:07:51.369+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3725"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4519",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        }
      }
    },
    {
      "id": "3725",
      "type": "companies",
      "attributes": {
        "name": "Client2928",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:07:51.365+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 807
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/financial_item_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/financial_item_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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-64-d41d8cd98f00b204e9800998ecf8427e",
      "type": "invoice_reports",
      "attributes": {
        "group": "invoice",
        "count": 1,
        "sent_status": null,
        "payment_status": null,
        "overdue_status": null,
        "invoice_status": null,
        "invoice_aging": null,
        "average_due_in": "10.0",
        "average_paid_in": null,
        "currency_id": null,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "custom_fields": {},
        "formula_fields": {},
        "invoiced_on_period": null,
        "pay_on_period": null,
        "sent_on_period": null,
        "delivery_on_period": null,
        "paid_on_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_amount": 0,
        "total_amount_default": 0,
        "total_amount_normalized": 0,
        "total_amount_tax": 0,
        "total_amount_tax_default": 0,
        "total_amount_tax_normalized": 0,
        "total_amount_with_tax": 0,
        "total_amount_with_tax_default": 0,
        "total_amount_with_tax_normalized": 0,
        "total_amount_paid": 0,
        "total_amount_paid_default": 0,
        "total_amount_paid_normalized": 0,
        "total_amount_written_off": 0,
        "total_amount_written_off_default": 0,
        "total_amount_written_off_normalized": 0,
        "total_amount_unpaid": 0,
        "total_amount_unpaid_default": 0,
        "total_amount_unpaid_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 808
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "64"
          }
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "64",
      "type": "invoices",
      "attributes": {
        "number": "2016/01",
        "subject": null,
        "invoiced_on": "2021-03-06",
        "sent_on": null,
        "pay_on": "2021-03-16",
        "delivery_on": null,
        "paid_on": null,
        "discount": null,
        "tax1_name": null,
        "tax1_value": null,
        "tax2_name": null,
        "tax2_value": null,
        "deleted_at": null,
        "tag_list": [],
        "note": null,
        "exported_at": null,
        "export_integration_type_id": null,
        "note_interpolated": null,
        "email_key": "b441b95c61f8c07b10dda72c191eb2ea",
        "purchase_order_number": null,
        "export_invoice_url": null,
        "company_reference_id": null,
        "created_at": "2021-03-06T00:07:51.749+01:00",
        "exchange_rate": "1.25",
        "exchange_date": "2021-03-06",
        "custom_fields": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "amount": 0,
        "amount_default": 0,
        "amount_normalized": 0,
        "amount_tax": 0,
        "amount_tax_default": 0,
        "amount_tax_normalized": 0,
        "amount_with_tax": 0,
        "amount_with_tax_default": 0,
        "amount_with_tax_normalized": 0,
        "amount_paid": 0,
        "amount_paid_default": 0,
        "amount_paid_normalized": 0,
        "amount_written_off": 0,
        "amount_written_off_default": 0,
        "amount_written_off_normalized": 0,
        "amount_unpaid": 0,
        "amount_unpaid_default": 0,
        "amount_unpaid_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 808
          }
        },
        "bill_to": {
          "data": null
        },
        "bill_from": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3727"
          }
        },
        "document_type": {
          "data": {
            "type": "document_types",
            "id": "24"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2621"
          }
        },
        "invoice_attributions": {
          "data": []
        },
        "attachment": {
          "data": null
        }
      }
    },
    {
      "id": "3727",
      "type": "companies",
      "attributes": {
        "name": "Client2929",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:07:51.743+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 808
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "24",
      "type": "document_types",
      "attributes": {
        "name": "Standard Document Type",
        "tax1_name": "VAT",
        "tax1_value": "25.0",
        "tax2_name": null,
        "tax2_value": null,
        "locale": "en_US",
        "document_template_id": 1,
        "exportable_type_id": 1,
        "note": null,
        "footer": null,
        "template_options": {},
        "archived_at": null,
        "header_template": null,
        "body_template": null,
        "footer_template": null,
        "scss_template": null,
        "exporter_options": {},
        "email_template": null,
        "email_subject": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 808
          }
        },
        "subsidiary": {
          "data": {
            "type": "subsidiaries",
            "id": "132"
          }
        }
      }
    },
    {
      "id": "2621",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2570@email.com",
        "title": null,
        "joined_at": "2021-03-06T00:07:51.000+01:00",
        "last_seen_at": "2021-03-06T00:07:51.767+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:07:51.713+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 808
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3726"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "132",
      "type": "subsidiaries",
      "attributes": {
        "name": "Subsidiary132",
        "invoice_number_format": null,
        "archived_at": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 808
          }
        },
        "bill_from": {
          "data": null
        },
        "integration": {
          "data": null
        }
      }
    },
    {
      "id": "3726",
      "type": "companies",
      "attributes": {
        "name": "Organization808",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:07:51.711+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 808
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/invoice_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/invoice_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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": 855
          }
        },
        "payment": {
          "data": {
            "type": "payments",
            "id": "28"
          }
        },
        "invoice": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "deal": {
          "meta": {
            "included": false
          }
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "28",
      "type": "payments",
      "attributes": {
        "paid_on": "2021-03-06",
        "written_off_on": null,
        "note": null,
        "external_id": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 855
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "878"
          }
        }
      }
    },
    {
      "id": "878",
      "type": "invoices",
      "attributes": {
        "number": "2016/01",
        "subject": null,
        "invoiced_on": "2021-03-06",
        "sent_on": null,
        "pay_on": "2021-03-16",
        "delivery_on": null,
        "paid_on": "2021-03-06",
        "discount": null,
        "tax1_name": null,
        "tax1_value": null,
        "tax2_name": null,
        "tax2_value": null,
        "deleted_at": null,
        "tag_list": [],
        "note": null,
        "exported_at": null,
        "export_integration_type_id": null,
        "note_interpolated": null,
        "email_key": "13fd2ee76a93444f3e69634ad27d30a8",
        "purchase_order_number": null,
        "export_invoice_url": null,
        "company_reference_id": null,
        "created_at": "2021-03-06T00:08:03.399+01:00",
        "exchange_rate": "1.25",
        "exchange_date": "2021-03-06",
        "custom_fields": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "amount": 0,
        "amount_default": 0,
        "amount_normalized": 0,
        "amount_tax": 0,
        "amount_tax_default": 0,
        "amount_tax_normalized": 0,
        "amount_with_tax": 0,
        "amount_with_tax_default": 0,
        "amount_with_tax_normalized": 0,
        "amount_paid": 10000,
        "amount_paid_default": 12500,
        "amount_paid_normalized": 10000,
        "amount_written_off": 0,
        "amount_written_off_default": 0,
        "amount_written_off_normalized": 0,
        "amount_unpaid": -10000,
        "amount_unpaid_default": -12500,
        "amount_unpaid_normalized": -10000
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 855
          }
        },
        "bill_to": {
          "data": null
        },
        "bill_from": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3917"
          }
        },
        "document_type": {
          "data": {
            "type": "document_types",
            "id": "73"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2692"
          }
        },
        "invoice_attributions": {
          "data": []
        },
        "attachment": {
          "data": null
        }
      }
    },
    {
      "id": "3917",
      "type": "companies",
      "attributes": {
        "name": "Client3072",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:08:03.392+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 855
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "73",
      "type": "document_types",
      "attributes": {
        "name": "Standard Document Type",
        "tax1_name": "VAT",
        "tax1_value": "25.0",
        "tax2_name": null,
        "tax2_value": null,
        "locale": "en_US",
        "document_template_id": 1,
        "exportable_type_id": 1,
        "note": null,
        "footer": null,
        "template_options": {},
        "archived_at": null,
        "header_template": null,
        "body_template": null,
        "footer_template": null,
        "scss_template": null,
        "exporter_options": {},
        "email_template": null,
        "email_subject": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 855
          }
        },
        "subsidiary": {
          "data": {
            "type": "subsidiaries",
            "id": "181"
          }
        }
      }
    },
    {
      "id": "2692",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2641@email.com",
        "title": null,
        "joined_at": "2021-03-06T00:08:03.000+01:00",
        "last_seen_at": "2021-03-06T00:08:03.436+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:08:03.351+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 855
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3916"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "181",
      "type": "subsidiaries",
      "attributes": {
        "name": "Subsidiary181",
        "invoice_number_format": null,
        "archived_at": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 855
          }
        },
        "bill_from": {
          "data": null
        },
        "integration": {
          "data": null
        }
      }
    },
    {
      "id": "3916",
      "type": "companies",
      "attributes": {
        "name": "Organization855",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:08:03.349+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 855
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/payment_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/payment_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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-2734-d41d8cd98f00b204e9800998ecf8427e",
      "type": "person_reports",
      "attributes": {
        "group": "person",
        "count": 1,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "role_id": null,
        "status": null,
        "type": null,
        "custom_fields": {},
        "contact_phone": null,
        "contact_email": null,
        "contact_website": null,
        "contact_city": null,
        "contact_state": null,
        "contact_country": null,
        "contact_zipcode": null,
        "contact_address": null,
        "created_at_period": null,
        "joined_at_period": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2734"
          }
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "2734",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2683@email.com",
        "title": null,
        "joined_at": "2021-03-06T00:08:09.000+01:00",
        "last_seen_at": "2021-03-06T00:08:09.579+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:08:09.551+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4011"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4011",
      "type": "companies",
      "attributes": {
        "name": "Organization877",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:08:09.549+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 877
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/person_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/person_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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-415-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": 934
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "415"
          }
        },
        "company": {
          "data": null
        },
        "project_manager": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "415",
      "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-03-06T00:08:16.990+01:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": 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": 934
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4126"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "2850"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4126",
      "type": "companies",
      "attributes": {
        "name": "Client3202",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:08:16.987+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 934
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2850",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user2797@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:08:16.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:08:16.958+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 934
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4125"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4125",
      "type": "companies",
      "attributes": {
        "name": "Client3201",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:08:16.953+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 934
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/project_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/project_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

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


Service Reports

Supported filter params

Supported filter params can be found on services endpoint

Supported group params

  • service

  • budget

  • service_type

  • company

  • responsible

  • subsidiary

  • project

  • budget_status

  • project_type

  • organization

  • recurring

  • budget_custom_fields

  • pricing_type

  • billable

Supported date period dates

  • date
GET /api/v2/reports/service_reports
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-343-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": "200.0",
        "average_forecasted_time_usage": null,
        "average_profit_margin": "100.0",
        "average_budget_usage": "100.0",
        "average_discount": null,
        "recurring": false,
        "budget_custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_revenue": 125000,
        "total_revenue_default": 125000,
        "total_revenue_normalized": 125000,
        "total_price": 100000,
        "total_price_default": 100000,
        "total_price_normalized": 100000,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_profit": 125000,
        "total_profit_default": 125000,
        "total_profit_normalized": 125000,
        "total_budget_total": 125000,
        "total_budget_total_default": 125000,
        "total_budget_total_normalized": 125000,
        "total_budget_used": 125000,
        "total_budget_used_default": 125000,
        "total_budget_used_normalized": 125000,
        "total_budget_remaining": 0,
        "total_budget_remaining_default": 0,
        "total_budget_remaining_normalized": 0,
        "average_actual_rate": null,
        "average_actual_rate_default": null,
        "average_actual_rate_normalized": null,
        "average_hourly_rate": null,
        "average_hourly_rate_default": null,
        "average_hourly_rate_normalized": null,
        "total_future_revenue": 0,
        "total_future_revenue_default": 0,
        "total_future_revenue_normalized": 0,
        "total_future_budget_used": 125000,
        "total_future_budget_used_default": 125000,
        "total_future_budget_used_normalized": 125000,
        "total_future_cost": 0,
        "total_future_cost_default": 0,
        "total_future_cost_normalized": 0,
        "total_forecasted_revenue": 125000,
        "total_forecasted_revenue_default": 125000,
        "total_forecasted_revenue_normalized": 125000,
        "total_forecasted_cost": 0,
        "total_forecasted_cost_default": 0,
        "total_forecasted_cost_normalized": 0,
        "total_forecasted_profit": 125000,
        "total_forecasted_profit_default": 125000,
        "total_forecasted_profit_normalized": 125000,
        "total_forecasted_budget_used": 250000,
        "total_forecasted_budget_used_default": 250000,
        "total_forecasted_budget_used_normalized": 250000,
        "total_discount_amount": 0,
        "total_discount_amount_default": 0,
        "total_discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "343"
          }
        },
        "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": "343",
      "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,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "540"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "697"
          }
        },
        "section": {
          "data": null
        }
      }
    },
    {
      "id": "540",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        }
      }
    },
    {
      "id": "697",
      "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": "a032be6637bef358207111ee038d6ce4",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 200,
        "forecasted_time_usage": 0,
        "budget_usage": 100,
        "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,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "services_revenue": 100000,
        "services_revenue_default": 125000,
        "services_revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 100000,
        "pending_invoicing_default": 125000,
        "pending_invoicing_normalized": 100000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 50000,
        "projected_revenue_default": 62500,
        "projected_revenue_normalized": 50000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 100000,
        "forecasted_revenue_default": 125000,
        "forecasted_revenue_normalized": 100000,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 100000,
        "forecasted_profit_default": 125000,
        "forecasted_profit_normalized": 100000,
        "forecasted_budget_used": 200000,
        "forecasted_budget_used_default": 250000,
        "forecasted_budget_used_normalized": 200000,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "3055"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4488"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "3056"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "5354"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "3055",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3002@email.com",
        "title": null,
        "joined_at": "2020-12-01T00:00:00.000+01:00",
        "last_seen_at": "2020-12-01T00:00:00.000+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:08:35.166+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4487"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4488",
      "type": "companies",
      "attributes": {
        "name": "Client3527",
        "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": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3056",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3003@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-12-01T00:00:00.000+01:00",
        "is_user": true,
        "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": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4489"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "5354",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        }
      }
    },
    {
      "id": "4487",
      "type": "companies",
      "attributes": {
        "name": "Organization971",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:08:35.164+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4489",
      "type": "companies",
      "attributes": {
        "name": "Client3528",
        "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": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 971
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/service_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/service_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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-68-d41d8cd98f00b204e9800998ecf8427e",
      "type": "task_reports",
      "attributes": {
        "group": "task",
        "count": 1,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "status": null,
        "total_worked_time": null,
        "total_initial_estimate": null,
        "total_remaining_time": null,
        "total_estimation_offset_time": null,
        "custom_fields": {},
        "formula_fields": {},
        "created_at_period": null,
        "closed_at_period": null,
        "last_activity_at_period": null,
        "due_date_period": null,
        "start_date_period": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "task": {
          "data": {
            "type": "tasks",
            "id": "68"
          }
        },
        "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": "68",
      "type": "tasks",
      "attributes": {
        "title": "Ticket title",
        "description": null,
        "number": 1,
        "private": false,
        "due_date": null,
        "start_date": null,
        "closed_at": null,
        "created_at": "2021-03-06T00:09:11.056+01:00",
        "updated_at": "2021-03-06T00:09:11.056+01:00",
        "repeat_schedule_id": null,
        "repeat_on_interval": null,
        "repeat_on_monthday": null,
        "repeat_on_weekday": [],
        "repeat_on_date": null,
        "repeat_origin_id": null,
        "email_key": "200dae5aa589905b4a0cc210f7f72f8b",
        "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": 1056
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "934"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "3343"
          }
        },
        "assignee": {
          "data": null
        },
        "last_actor": {
          "data": null
        },
        "task_list": {
          "data": {
            "type": "task_lists",
            "id": "67"
          }
        },
        "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-03-06T00:09:10.795+01:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": 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": 1056
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4968"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "3342"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "3343",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3290@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:09:10.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:09:10.823+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4969"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "67",
      "type": "task_lists",
      "attributes": {
        "name": "Milestone63",
        "position": 1,
        "archived_at": null,
        "email_key": "c86014be3c6d5e26614cab2f52c49061"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "935"
          }
        },
        "board": {
          "data": {
            "type": "boards",
            "id": "82"
          }
        }
      }
    },
    {
      "id": "4968",
      "type": "companies",
      "attributes": {
        "name": "Client3922",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:09:10.791+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3342",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3289@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:09:10.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:09:10.756+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4967"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4969",
      "type": "companies",
      "attributes": {
        "name": "Client3923",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:09:10.818+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "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-03-06T00:09:10.902+01:00",
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": 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": 1056
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4971"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "3344"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "82",
      "type": "boards",
      "attributes": {
        "name": "Board62",
        "position": 1,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "936"
          }
        }
      }
    },
    {
      "id": "4967",
      "type": "companies",
      "attributes": {
        "name": "Client3921",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:09:10.750+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4971",
      "type": "companies",
      "attributes": {
        "name": "Client3925",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:09:10.898+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3344",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3291@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:09:10.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:09:10.862+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4970"
          }
        },
        "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-03-06T00:09:10.972+01:00",
        "board_count": 1,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": 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": 1056
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4973"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "3345"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4970",
      "type": "companies",
      "attributes": {
        "name": "Client3924",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:09:10.857+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4973",
      "type": "companies",
      "attributes": {
        "name": "Client3927",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:09:10.968+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3345",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user3292@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:09:10.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:09:10.934+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4972"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4972",
      "type": "companies",
      "attributes": {
        "name": "Client3926",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:09:10.929+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1056
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/task_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/task_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "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,
        "total_time": 480,
        "total_billable_time": 480,
        "total_recognized_time": null,
        "pricing_type_id": null,
        "unit_id": null,
        "project_type_id": null,
        "average_recognized_margin": null,
        "people_custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "created_at_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_work_cost": 0,
        "total_work_cost_default": 0,
        "total_work_cost_normalized": 0,
        "total_overhead_cost": 0,
        "total_overhead_cost_default": 0,
        "total_overhead_cost_normalized": 0,
        "total_internal_overhead_cost": 0,
        "total_internal_overhead_cost_default": 0,
        "total_internal_overhead_cost_normalized": 0,
        "total_facility_overhead_cost": 0,
        "total_facility_overhead_cost_default": 0,
        "total_facility_overhead_cost_normalized": 0,
        "total_revenue": null,
        "total_revenue_default": null,
        "total_revenue_normalized": null,
        "total_profit": null,
        "total_profit_default": null,
        "total_profit_normalized": null,
        "average_blended_rate": null,
        "average_blended_rate_default": null,
        "average_blended_rate_normalized": null,
        "total_recognized_revenue": null,
        "total_recognized_revenue_default": null,
        "total_recognized_revenue_normalized": null,
        "total_recognized_profit": null,
        "total_recognized_profit_default": null,
        "total_recognized_profit_normalized": null,
        "total_billable_revenue": null,
        "total_billable_revenue_default": null,
        "total_billable_revenue_normalized": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "time_entry": {
          "data": {
            "type": "time_entries",
            "id": "12"
          }
        },
        "person": {
          "data": null
        },
        "task": {
          "data": null
        },
        "service": {
          "data": null
        },
        "service_type": {
          "data": null
        },
        "budget": {
          "data": null
        },
        "project": {
          "data": null
        },
        "responsible": {
          "data": null
        },
        "company": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "12",
      "type": "time_entries",
      "attributes": {
        "date": "2021-03-06",
        "created_at": "2021-03-06T00:10:04.055+01:00",
        "time": 480,
        "billable_time": 480,
        "note": "test note",
        "track_method_id": 1,
        "tracking_type_id": null,
        "started_at": null,
        "timer_started_at": null,
        "timer_stopped_at": null,
        "approved": false,
        "approved_at": null,
        "updated_at": "2021-03-06T00:10:04.055+01:00",
        "calendar_event_id": null,
        "invoiced": false,
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "overhead_cost": 0,
        "overhead_cost_default": 0,
        "overhead_cost_normalized": 0,
        "internal_overhead_cost": 0,
        "internal_overhead_cost_default": 0,
        "internal_overhead_cost_normalized": 0,
        "facility_overhead_cost": 0,
        "facility_overhead_cost_default": 0,
        "facility_overhead_cost_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "4070"
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "512"
          }
        },
        "task": {
          "data": null
        },
        "approver": {
          "data": null
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "4069"
          }
        },
        "rejecter": {
          "data": null
        }
      }
    },
    {
      "id": "4070",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user4017@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:10:03.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:10:03.925+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6104"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "512",
      "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,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "709"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "846"
          }
        },
        "section": {
          "data": null
        }
      }
    },
    {
      "id": "4069",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user4016@email.com",
        "title": null,
        "joined_at": "2021-03-06T00:10:04.000+01:00",
        "last_seen_at": "2021-03-06T00:10:04.096+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:10:03.890+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6103"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6104",
      "type": "companies",
      "attributes": {
        "name": "Client5001",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:10:03.920+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "709",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        }
      }
    },
    {
      "id": "846",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-03-06",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "expense_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 100,
        "discount": null,
        "email_key": "b0ef0e069811635031d3169bb6cbbbd7",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 200,
        "forecasted_time_usage": 0,
        "budget_usage": 100,
        "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-03-06T00:10:04.011+01:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-03-06",
        "sales_closed_on": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "services_revenue": 100000,
        "services_revenue_default": 125000,
        "services_revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 100000,
        "pending_invoicing_default": 125000,
        "pending_invoicing_normalized": 100000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "actual_rate": 12500,
        "actual_rate_default": 15625,
        "actual_rate_normalized": 12500,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 50000,
        "projected_revenue_default": 62500,
        "projected_revenue_normalized": 50000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 100000,
        "forecasted_revenue_default": 125000,
        "forecasted_revenue_normalized": 100000,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 100000,
        "forecasted_profit_default": 125000,
        "forecasted_profit_normalized": 100000,
        "forecasted_budget_used": 200000,
        "forecasted_budget_used_default": 250000,
        "forecasted_budget_used_normalized": 200000,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "4069"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6105"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "4071"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "6191"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "6103",
      "type": "companies",
      "attributes": {
        "name": "Organization1113",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-03-06T00:10:03.889+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "6105",
      "type": "companies",
      "attributes": {
        "name": "Client5002",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:10:03.957+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4071",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user4018@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:10:03.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:10:03.972+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6106"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6191",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        }
      }
    },
    {
      "id": "6106",
      "type": "companies",
      "attributes": {
        "name": "Client5003",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:10:03.967+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1113
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/time_entry_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/time_entry_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulses": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

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


Time Reports

Supported group params

  • person

  • service

  • service_type

  • budget

  • project

  • company

  • event

  • future

  • organization

  • people_custom_fields

Supported date period dates

  • date
GET /api/v2/reports/time_reports
Requestsreturns time reports

GET  /api/v2/reports/time_reports

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "time-report-person-4428-d41d8cd98f00b204e9800998ecf8427e",
      "type": "new_time_reports",
      "attributes": {
        "group": "person",
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "day": null,
        "count": 1,
        "future": null,
        "people_custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "capacity": 0,
        "available_time": 0,
        "scheduled_time": 0,
        "scheduled_internal_time": 0,
        "scheduled_client_time": 0,
        "scheduled_event_time": "0.0",
        "internal_time": 0,
        "client_time": 480,
        "billable_time": 0,
        "unapproved_time": 480,
        "worked_time": 480,
        "paid_event_time": 0,
        "unpaid_event_time": 0,
        "event_time": 0,
        "worked_available_diff": 480,
        "client_worked_ratio": "1.0",
        "worked_available_ratio": null,
        "worked_scheduled_ratio": null,
        "available_capacity_ratio": null,
        "billable_available_ratio": null,
        "billable_client_ratio": "0.0",
        "billable_worked_ratio": "0.0",
        "client_available_ratio": null,
        "scheduled_available_ratio": null,
        "client_scheduled_available_ratio": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1179
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "4428"
          }
        },
        "service": {
          "data": null
        },
        "service_type": {
          "data": null
        },
        "budget": {
          "data": null
        },
        "company": {
          "data": null
        },
        "project": {
          "data": null
        },
        "event": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "4428",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user4375@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-03-06T00:10:34.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-03-06T00:10:34.749+01:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1179
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6611"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6611",
      "type": "companies",
      "attributes": {
        "name": "Client5442",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-03-06T00:10:34.745+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1179
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/reports/time_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/reports/time_reports?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "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
      },
      "pulses": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get time reports
GET/api/v2/reports/time_reports


Generated by aglio on 05 Mar 2021