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 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-68-d41d8cd98f00b204e9800998ecf8427e",
      "type": "booking_reports",
      "attributes": {
        "group": "booking",
        "count": 1,
        "time": 640,
        "start_date": "2020-09-28",
        "end_date": "2020-09-28",
        "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": 568
          }
        },
        "booking": {
          "data": {
            "type": "bookings",
            "id": "68"
          }
        },
        "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": "68",
      "type": "bookings",
      "attributes": {
        "hours": 6,
        "time": 360,
        "started_on": "2020-09-28",
        "ended_on": "2020-09-28",
        "note": null,
        "total_time": 0,
        "percentage": null,
        "created_at": "2020-09-28T01:05:12.512+02:00",
        "updated_at": "2020-09-28T01:05:12.512+02:00",
        "people_custom_fields": null,
        "approved": true,
        "approved_at": "2020-09-28T01:05:12.512+02:00",
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "booking_method_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 568
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "25"
          }
        },
        "event": {
          "data": null
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1398"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1395"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "1395"
          }
        },
        "approver": {
          "data": {
            "type": "people",
            "id": "1395"
          }
        },
        "rejecter": {
          "data": null
        },
        "origin": {
          "data": null
        }
      }
    },
    {
      "id": "25",
      "type": "services",
      "attributes": {
        "name": "test name",
        "position": 1,
        "deleted_at": null,
        "billable": true,
        "description": null,
        "pricing_type_id": 1,
        "worked_time": 0,
        "unapproved_time": 0,
        "billable_time": 0,
        "estimated_time": null,
        "booked_time": 0,
        "budgeted_time": 0,
        "profit_margin": 100,
        "unit_id": 2,
        "quantity": "1.0",
        "discount": null,
        "future_booked_time": 0,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "hourly_rate": null,
        "hourly_rate_default": null,
        "hourly_rate_normalized": null,
        "price": 100000,
        "price_default": 125000,
        "price_normalized": 100000,
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 568
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "84"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "135"
          }
        }
      }
    },
    {
      "id": "1398",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1356@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:12.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:12.489+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 568
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1886"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1395",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1353@email.com",
        "title": null,
        "joined_at": "2020-09-28T01:05:12.000+02:00",
        "last_seen_at": "2020-09-28T01:05:12.749+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:12.373+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 568
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1882"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "84",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 568
          }
        }
      }
    },
    {
      "id": "135",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-09-28",
        "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": "ade9bbe49494488a5b6806f93ead133a",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 200,
        "forecasted_time_usage": 0,
        "budget_usage": 100,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-09-28T01:05:12.450+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2020-09-28",
        "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": 568
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1395"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1884"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1397"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "2916"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "1886",
      "type": "companies",
      "attributes": {
        "name": "Client1319",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:12.485+02: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": 568
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1882",
      "type": "companies",
      "attributes": {
        "name": "Organization568",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:12.372+02: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": 568
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1884",
      "type": "companies",
      "attributes": {
        "name": "Client1317",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:12.416+02: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": 568
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1397",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1355@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:12.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:12.425+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 568
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1885"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2916",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 568
          }
        }
      }
    },
    {
      "id": "1885",
      "type": "companies",
      "attributes": {
        "name": "Client1318",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:12.422+02: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": 568
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Budget Reports

Supported group params

  • budget

  • company

  • responsible

  • subsidiary

  • contract

  • project

  • status

  • project_type

  • organization

  • recurring

  • custom_fields

Supported date period dates

  • date

  • created_at

  • closed_at

  • end_date

  • last_activity_at

  • delivered_on

GET /api/v2/reports/budget_reports
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-137-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": 569
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "137"
          }
        },
        "contract": {
          "data": null
        },
        "project": {
          "data": null
        },
        "company": {
          "data": null
        },
        "responsible": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "137",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-09-28",
        "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": "742fc57ce222d140e6a4f70752156f3a",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 100,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-09-28T01:05:13.034+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2020-09-28",
        "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": 569
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1402"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1892"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1403"
          }
        },
        "deal_status": {
          "meta": {
            "included": false
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "298"
          }
        },
        "lost_reason": {
          "meta": {
            "included": false
          }
        },
        "contract": {
          "data": null
        },
        "contact": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1402",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1360@email.com",
        "title": null,
        "joined_at": "2020-09-28T01:05:13.000+02:00",
        "last_seen_at": "2020-09-28T01:05:13.052+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:12.898+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 569
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1891"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1892",
      "type": "companies",
      "attributes": {
        "name": "Client1324",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:12.958+02: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": 569
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1403",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1361@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:12.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:12.968+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 569
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1893"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "298",
      "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,
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 569
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1895"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1404"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1891",
      "type": "companies",
      "attributes": {
        "name": "Organization569",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:12.896+02: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": 569
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1893",
      "type": "companies",
      "attributes": {
        "name": "Client1325",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:12.965+02: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": 569
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1895",
      "type": "companies",
      "attributes": {
        "name": "Client1327",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:13.011+02: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": 569
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1404",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1362@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:12.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:12.994+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 569
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1894"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1894",
      "type": "companies",
      "attributes": {
        "name": "Client1326",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:12.990+02: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": 569
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Company Reports

Supported group params

  • company, key: :company_id

  • status

  • organization

  • custom_fields

Supported date period dates

  • created_at
GET /api/v2/reports/company_reports
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-1896-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": 570
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1896"
          }
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "1896",
      "type": "companies",
      "attributes": {
        "name": "Organization570",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:13.204+02: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": 570
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Deal Reports

Supported group params

  • deal

  • company

  • responsible

  • subsidiary

  • sales_status_id

  • deal_status

  • lost_reason

  • organization

  • custom_fields

  • contact

Supported date period dates

  • date

  • created_at

  • last_activity_at

  • sales_status_updated_at

  • sales_closed_at

GET /api/v2/reports/deal_reports
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-138-d41d8cd98f00b204e9800998ecf8427e",
      "type": "deal_reports",
      "attributes": {
        "group": "deal",
        "count": 1,
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "sales_status_id": null,
        "total_worked_time": 0,
        "total_billable_time": 0,
        "total_estimated_time": 0,
        "total_budgeted_time": 0,
        "total_estimated_remaining_time": 0,
        "custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "created_at_period": null,
        "last_activity_at_period": null,
        "sales_closed_at_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_revenue": 0,
        "total_revenue_default": 0,
        "total_revenue_normalized": 0,
        "total_services_revenue": 0,
        "total_services_revenue_default": 0,
        "total_services_revenue_normalized": 0,
        "total_projected_revenue": 0,
        "total_projected_revenue_default": 0,
        "total_projected_revenue_normalized": 0,
        "total_work_cost": 0,
        "total_work_cost_default": 0,
        "total_work_cost_normalized": 0,
        "total_expense": 0,
        "total_expense_default": 0,
        "total_expense_normalized": 0,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_profit": 0,
        "total_profit_default": 0,
        "total_profit_normalized": 0,
        "total_budget_total": 0,
        "total_budget_total_default": 0,
        "total_budget_total_normalized": 0,
        "total_budget_used": 0,
        "total_budget_used_default": 0,
        "total_budget_used_normalized": 0,
        "total_invoiced": 0,
        "total_invoiced_default": 0,
        "total_invoiced_normalized": 0,
        "total_pending_invoicing": 0,
        "total_pending_invoicing_default": 0,
        "total_pending_invoicing_normalized": 0,
        "average_actual_rate": 0,
        "average_actual_rate_default": 0,
        "average_actual_rate_normalized": 0,
        "average_rate": 0,
        "average_rate_default": 0,
        "average_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 571
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "138"
          }
        },
        "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": "138",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-09-28",
        "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": "c1c071f9d628071996cf63394f8c3377",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-09-28T01:05:13.349+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2020-09-28",
        "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": 571
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1406"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1898"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1407"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "2933"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "1406",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1364@email.com",
        "title": null,
        "joined_at": "2020-09-28T01:05:13.000+02:00",
        "last_seen_at": "2020-09-28T01:05:13.368+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:13.300+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 571
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1897"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1898",
      "type": "companies",
      "attributes": {
        "name": "Client1328",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:13.315+02: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": 571
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1407",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1365@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:13.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:13.324+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 571
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1899"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2933",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 571
          }
        }
      }
    },
    {
      "id": "1897",
      "type": "companies",
      "attributes": {
        "name": "Organization571",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:13.299+02: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": 571
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1899",
      "type": "companies",
      "attributes": {
        "name": "Client1329",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:13.321+02: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": 571
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Expense Reports

Supported group params

  • expense

  • deal

  • service_type

  • project

  • company

  • person

  • responsible

  • status

  • invoiced

  • approval_status

  • reimbursement

  • organization

  • vendor

Supported date period dates

  • date

  • pay_on

  • paid_on

GET /api/v2/reports/expense_reports
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,
        "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": 572
          }
        },
        "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": "test name",
        "date": "2020-09-28",
        "pay_on": null,
        "paid_on": null,
        "position": 1,
        "invoiced": false,
        "approved": true,
        "approved_at": "2020-09-28T01:05:13.558+02:00",
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "deleted_at": null,
        "reimbursable": null,
        "reimbursed_on": null,
        "exchange_rate": "1.25",
        "exchange_date": "2020-09-28",
        "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": 572
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "139"
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "86"
          }
        },
        "person": {
          "data": null
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1408"
          }
        },
        "approver": {
          "data": {
            "type": "people",
            "id": "1409"
          }
        },
        "rejecter": {
          "data": null
        },
        "vendor": {
          "data": null
        },
        "attachment": {
          "data": null
        }
      }
    },
    {
      "id": "139",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-09-28",
        "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": "2e6244e9fbde64e7449d2f4596bf9944",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-09-28T01:05:13.545+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2020-09-28",
        "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": 572
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1408"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1901"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1409"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "2939"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "86",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 572
          }
        }
      }
    },
    {
      "id": "1408",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1366@email.com",
        "title": null,
        "joined_at": "2020-09-28T01:05:13.000+02:00",
        "last_seen_at": "2020-09-28T01:05:13.589+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:13.492+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 572
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1900"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1409",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1367@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:13.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:13.518+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 572
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1902"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1901",
      "type": "companies",
      "attributes": {
        "name": "Client1330",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:13.508+02: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": 572
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2939",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 572
          }
        }
      }
    },
    {
      "id": "1900",
      "type": "companies",
      "attributes": {
        "name": "Organization572",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:13.491+02: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": 572
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1902",
      "type": "companies",
      "attributes": {
        "name": "Client1331",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:13.514+02: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": 572
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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",
        "financial_item_id": 9,
        "financial_item_type": "time_entry",
        "financial_item_date": "2020-09-28",
        "total_time": 480,
        "total_billable_time": 480,
        "total_recognized_time": null,
        "pricing_type_id": null,
        "project_type_id": null,
        "average_profit_margin": null,
        "average_recognized_margin": null,
        "future": null,
        "approval_status": null,
        "date_period": null,
        "formula_fields": {},
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_revenue": null,
        "total_revenue_default": null,
        "total_revenue_normalized": null,
        "total_recognized_revenue": null,
        "total_recognized_revenue_default": null,
        "total_recognized_revenue_normalized": null,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_profit": null,
        "total_profit_default": null,
        "total_profit_normalized": null,
        "total_recognized_profit": null,
        "total_recognized_profit_default": null,
        "total_recognized_profit_normalized": null,
        "average_blended_rate": null,
        "average_blended_rate_default": null,
        "average_blended_rate_normalized": null,
        "total_budget_used": 0,
        "total_budget_used_default": 0,
        "total_budget_used_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 573
          }
        },
        "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
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "9",
      "type": "time_entries",
      "attributes": {
        "date": "2020-09-28",
        "created_at": "2020-09-28T01:05:13.833+02:00",
        "time": 480,
        "billable_time": 480,
        "note": "test note",
        "track_method_id": 1,
        "tracking_type_id": null,
        "started_at": null,
        "timer_started_at": null,
        "approved": false,
        "approved_at": null,
        "updated_at": "2020-09-28T01:05:13.833+02:00",
        "invoiced": false,
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "overhead_cost": 0,
        "overhead_cost_default": 0,
        "overhead_cost_normalized": 0,
        "internal_overhead_cost": 0,
        "internal_overhead_cost_default": 0,
        "internal_overhead_cost_normalized": 0,
        "facility_overhead_cost": 0,
        "facility_overhead_cost_default": 0,
        "facility_overhead_cost_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 573
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1411"
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "27"
          }
        },
        "task": {
          "data": null
        },
        "approver": {
          "data": null
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "1410"
          }
        },
        "rejecter": {
          "data": null
        }
      }
    },
    {
      "id": "1411",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1369@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:13.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:13.735+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 573
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1904"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "27",
      "type": "services",
      "attributes": {
        "name": "test name",
        "position": 1,
        "deleted_at": null,
        "billable": true,
        "description": null,
        "pricing_type_id": 1,
        "worked_time": 480,
        "unapproved_time": 480,
        "billable_time": 0,
        "estimated_time": null,
        "booked_time": 0,
        "budgeted_time": 0,
        "profit_margin": 100,
        "unit_id": 2,
        "quantity": "1.0",
        "discount": null,
        "future_booked_time": 0,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "hourly_rate": null,
        "hourly_rate_default": null,
        "hourly_rate_normalized": null,
        "price": 100000,
        "price_default": 125000,
        "price_normalized": 100000,
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 573
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "87"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "140"
          }
        }
      }
    },
    {
      "id": "1410",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1368@email.com",
        "title": null,
        "joined_at": "2020-09-28T01:05:13.000+02:00",
        "last_seen_at": "2020-09-28T01:05:13.873+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:13.714+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 573
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1903"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1904",
      "type": "companies",
      "attributes": {
        "name": "Client1332",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:13.732+02: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": 573
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "87",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 573
          }
        }
      }
    },
    {
      "id": "140",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-09-28",
        "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": "0af17187722fbd7273a71f3061811c53",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 200,
        "forecasted_time_usage": 0,
        "budget_usage": 100,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 480,
        "time_to_close": null,
        "unapproved_entries_count": 1,
        "rejected_entries_count": 0,
        "estimated_remaining_time": -480,
        "unapproved_time": 480,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-09-28T01:05:13.794+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2020-09-28",
        "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": 573
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1410"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1905"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1412"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "2945"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "1903",
      "type": "companies",
      "attributes": {
        "name": "Organization573",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:13.712+02: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": 573
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1905",
      "type": "companies",
      "attributes": {
        "name": "Client1333",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:13.756+02: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": 573
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1412",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1370@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:13.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:13.767+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 573
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1906"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2945",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 573
          }
        }
      }
    },
    {
      "id": "1906",
      "type": "companies",
      "attributes": {
        "name": "Client1334",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:13.763+02: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": 573
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Payment Reports

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-12-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": 574
          }
        },
        "payment": {
          "data": {
            "type": "payments",
            "id": "12"
          }
        },
        "invoice": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "deal": {
          "meta": {
            "included": false
          }
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "12",
      "type": "payments",
      "attributes": {
        "paid_on": "2020-09-28",
        "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": 574
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "61"
          }
        }
      }
    },
    {
      "id": "61",
      "type": "invoices",
      "attributes": {
        "number": "2016/01",
        "subject": null,
        "invoiced_on": "2020-09-28",
        "sent_on": null,
        "pay_on": "2020-10-08",
        "delivery_on": null,
        "paid_on": "2020-09-28",
        "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": "0ecd48fc3e8142757fd22473d6121cc9",
        "purchase_order_number": null,
        "export_invoice_url": null,
        "company_reference_id": null,
        "created_at": "2020-09-28T01:05:14.123+02:00",
        "exchange_rate": "1.25",
        "exchange_date": "2020-09-28",
        "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": 574
          }
        },
        "bill_to": {
          "data": null
        },
        "bill_from": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1908"
          }
        },
        "document_type": {
          "data": {
            "type": "document_types",
            "id": "15"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1413"
          }
        },
        "invoice_attributions": {
          "data": []
        },
        "attachment": {
          "data": null
        }
      }
    },
    {
      "id": "1908",
      "type": "companies",
      "attributes": {
        "name": "Client1335",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.117+02: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": 574
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "15",
      "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": 574
          }
        },
        "subsidiary": {
          "data": {
            "type": "subsidiaries",
            "id": "95"
          }
        }
      }
    },
    {
      "id": "1413",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1371@email.com",
        "title": null,
        "joined_at": "2020-09-28T01:05:14.000+02:00",
        "last_seen_at": "2020-09-28T01:05:14.151+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:14.094+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 574
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1907"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "95",
      "type": "subsidiaries",
      "attributes": {
        "name": "Subsidiary95",
        "invoice_number_format": null,
        "archived_at": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 574
          }
        },
        "bill_from": {
          "data": null
        },
        "integration": {
          "data": null
        }
      }
    },
    {
      "id": "1907",
      "type": "companies",
      "attributes": {
        "name": "Organization574",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:14.093+02: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": 574
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Person Reports

Supported group params

  • person

  • company

  • subsidiary

  • role_id

  • type

  • status

  • organization

  • custom_fields

Supported date period dates

  • created_at

  • joined_at

GET /api/v2/reports/person_reports
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-1414-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": {},
        "created_at_period": null,
        "joined_at_period": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1414"
          }
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "1414",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1372@email.com",
        "title": null,
        "joined_at": "2020-09-28T01:05:14.000+02:00",
        "last_seen_at": "2020-09-28T01:05:14.280+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:14.255+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 575
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1909"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1909",
      "type": "companies",
      "attributes": {
        "name": "Organization575",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:14.253+02: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": 575
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Project Reports

Supported group params

  • project

  • company

  • project_manager

  • project_status

  • project_type

  • public_access

  • organization

  • custom_fields

Supported date period dates

  • created_at

  • last_activity_at

GET /api/v2/reports/project_reports
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-299-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": 576
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "299"
          }
        },
        "company": {
          "data": null
        },
        "project_manager": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "299",
      "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,
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 576
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1912"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1416"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1912",
      "type": "companies",
      "attributes": {
        "name": "Client1337",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.404+02: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": 576
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1416",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1374@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:14.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:14.386+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 576
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1911"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1911",
      "type": "companies",
      "attributes": {
        "name": "Client1336",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.382+02: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": 576
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Service Reports

Supported group params

  • service

  • budget

  • service_type

  • company

  • responsible

  • subsidiary

  • project

  • budget_status

  • project_type

  • organization

  • recurring

  • budget_custom_fields

  • pricing_type

  • billable

Supported date period dates

  • date
GET /api/v2/reports/service_reports
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-28-d41d8cd98f00b204e9800998ecf8427e",
      "type": "service_reports",
      "attributes": {
        "group": "service",
        "count": 1,
        "budget_status": null,
        "project_type": null,
        "pricing_type": null,
        "billable": null,
        "total_booked_time": 0,
        "total_worked_time": 0,
        "total_billable_time": 0,
        "total_estimated_time": null,
        "total_budgeted_time": 0,
        "total_estimated_remaining_time": null,
        "total_unapproved_time": 0,
        "total_future_booked_time": 0,
        "total_forecasted_billable_time": 0,
        "average_forecasted_margin": "100.0",
        "average_forecasted_budget_usage": "200.0",
        "average_forecasted_time_usage": null,
        "average_profit_margin": "100.0",
        "average_budget_usage": "100.0",
        "average_discount": null,
        "recurring": false,
        "budget_custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_revenue": 125000,
        "total_revenue_default": 125000,
        "total_revenue_normalized": 125000,
        "total_price": 100000,
        "total_price_default": 100000,
        "total_price_normalized": 100000,
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0,
        "total_profit": 125000,
        "total_profit_default": 125000,
        "total_profit_normalized": 125000,
        "total_budget_total": 125000,
        "total_budget_total_default": 125000,
        "total_budget_total_normalized": 125000,
        "total_budget_used": 125000,
        "total_budget_used_default": 125000,
        "total_budget_used_normalized": 125000,
        "total_budget_remaining": 0,
        "total_budget_remaining_default": 0,
        "total_budget_remaining_normalized": 0,
        "average_actual_rate": null,
        "average_actual_rate_default": null,
        "average_actual_rate_normalized": null,
        "average_hourly_rate": null,
        "average_hourly_rate_default": null,
        "average_hourly_rate_normalized": null,
        "total_future_revenue": 0,
        "total_future_revenue_default": 0,
        "total_future_revenue_normalized": 0,
        "total_future_budget_used": 125000,
        "total_future_budget_used_default": 125000,
        "total_future_budget_used_normalized": 125000,
        "total_future_cost": 0,
        "total_future_cost_default": 0,
        "total_future_cost_normalized": 0,
        "total_forecasted_revenue": 125000,
        "total_forecasted_revenue_default": 125000,
        "total_forecasted_revenue_normalized": 125000,
        "total_forecasted_cost": 0,
        "total_forecasted_cost_default": 0,
        "total_forecasted_cost_normalized": 0,
        "total_forecasted_profit": 125000,
        "total_forecasted_profit_default": 125000,
        "total_forecasted_profit_normalized": 125000,
        "total_forecasted_budget_used": 250000,
        "total_forecasted_budget_used_default": 250000,
        "total_forecasted_budget_used_normalized": 250000,
        "total_discount_amount": 0,
        "total_discount_amount_default": 0,
        "total_discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 577
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "28"
          }
        },
        "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": "28",
      "type": "services",
      "attributes": {
        "name": "test name",
        "position": 1,
        "deleted_at": null,
        "billable": true,
        "description": null,
        "pricing_type_id": 1,
        "worked_time": 0,
        "unapproved_time": 0,
        "billable_time": 0,
        "estimated_time": null,
        "booked_time": 0,
        "budgeted_time": 0,
        "profit_margin": 100,
        "unit_id": 2,
        "quantity": "1.0",
        "discount": null,
        "future_booked_time": 0,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "hourly_rate": null,
        "hourly_rate_default": null,
        "hourly_rate_normalized": null,
        "price": 100000,
        "price_default": 125000,
        "price_normalized": 100000,
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 577
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "88"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "141"
          }
        }
      }
    },
    {
      "id": "88",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 577
          }
        }
      }
    },
    {
      "id": "141",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-09-28",
        "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": "395225746a744754d0e84c8096b8dd4b",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 200,
        "forecasted_time_usage": 0,
        "budget_usage": 100,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-09-28T01:05:14.593+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2020-09-28",
        "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": 577
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1417"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1914"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1418"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "2966"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "1417",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1375@email.com",
        "title": null,
        "joined_at": "2020-09-28T01:05:14.000+02:00",
        "last_seen_at": "2020-09-28T01:05:14.638+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:14.540+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 577
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1913"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1914",
      "type": "companies",
      "attributes": {
        "name": "Client1338",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.556+02: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": 577
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1418",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1376@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:14.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:14.567+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 577
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1915"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2966",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 577
          }
        }
      }
    },
    {
      "id": "1913",
      "type": "companies",
      "attributes": {
        "name": "Organization577",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:14.539+02: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": 577
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1915",
      "type": "companies",
      "attributes": {
        "name": "Client1339",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.563+02: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": 577
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Task Reports

Supported group params

  • task

  • project

  • task_list

  • board

  • assignee

  • creator

  • last_actor

  • company

  • status

  • organization

  • custom_fields

Supported date period dates

  • created_at

  • closed_at

  • last_activity_at

  • due_date

  • start_date

GET /api/v2/reports/task_reports
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-63-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": 578
          }
        },
        "task": {
          "data": {
            "type": "tasks",
            "id": "63"
          }
        },
        "project": {
          "data": null
        },
        "task_list": {
          "data": null
        },
        "board": {
          "data": null
        },
        "assignee": {
          "data": null
        },
        "creator": {
          "data": null
        },
        "last_actor": {
          "data": null
        },
        "company": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "63",
      "type": "tasks",
      "attributes": {
        "title": "Ticket title",
        "description": null,
        "number": 1,
        "private": false,
        "due_date": null,
        "start_date": null,
        "closed_at": null,
        "created_at": "2020-09-28T01:05:15.063+02:00",
        "updated_at": "2020-09-28T01:05:15.063+02:00",
        "repeat_schedule_id": null,
        "repeat_on_interval": null,
        "repeat_on_monthday": null,
        "repeat_on_weekday": [],
        "repeat_on_date": null,
        "repeat_origin_id": null,
        "email_key": "952b8757857da3409c39f6916a53a197",
        "custom_fields": null,
        "todo_count": null,
        "open_todo_count": null,
        "todo_assignee_count": null,
        "creation_method_id": 1,
        "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": 578
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "300"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1421"
          }
        },
        "assignee": {
          "data": null
        },
        "last_actor": {
          "data": null
        },
        "task_list": {
          "data": {
            "type": "task_lists",
            "id": "62"
          }
        },
        "attachments": {
          "data": []
        }
      }
    },
    {
      "id": "300",
      "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,
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 578
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1918"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1420"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1421",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1379@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:14.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:14.882+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 578
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1919"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "62",
      "type": "task_lists",
      "attributes": {
        "name": "Milestone58",
        "position": 1,
        "archived_at": null,
        "email_key": "6310621e227bfe6f65927dcddbac207e"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 578
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "301"
          }
        },
        "board": {
          "data": {
            "type": "boards",
            "id": "77"
          }
        }
      }
    },
    {
      "id": "1918",
      "type": "companies",
      "attributes": {
        "name": "Client1341",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.850+02: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": 578
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1420",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1378@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:14.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:14.829+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 578
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1917"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1919",
      "type": "companies",
      "attributes": {
        "name": "Client1342",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.877+02: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": 578
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "301",
      "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,
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 578
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1921"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1422"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "77",
      "type": "boards",
      "attributes": {
        "name": "Board57",
        "position": 1,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 578
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "302"
          }
        }
      }
    },
    {
      "id": "1917",
      "type": "companies",
      "attributes": {
        "name": "Client1340",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.824+02: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": 578
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1921",
      "type": "companies",
      "attributes": {
        "name": "Client1344",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.934+02: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": 578
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1422",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1380@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:14.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:14.913+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 578
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1920"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "302",
      "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,
        "board_count": 1,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 578
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1923"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1423"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1920",
      "type": "companies",
      "attributes": {
        "name": "Client1343",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.909+02: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": 578
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1923",
      "type": "companies",
      "attributes": {
        "name": "Client1346",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.992+02: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": 578
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1423",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1381@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:14.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:14.967+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 578
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1922"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1922",
      "type": "companies",
      "attributes": {
        "name": "Client1345",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:14.962+02: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": 578
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Time Entry Reports

Supported group params

  • time_entry

  • person

  • task

  • service

  • service_type

  • pricing_type_id

  • budget

  • project

  • responsible

  • company

  • status

  • invoiced

  • organization

  • people_custom_fields

  • project_type_id

Supported date period dates

  • date

  • created_at

GET /api/v2/reports/time_entry_reports
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-10-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": 579
          }
        },
        "time_entry": {
          "data": {
            "type": "time_entries",
            "id": "10"
          }
        },
        "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": "10",
      "type": "time_entries",
      "attributes": {
        "date": "2020-09-28",
        "created_at": "2020-09-28T01:05:15.504+02:00",
        "time": 480,
        "billable_time": 480,
        "note": "test note",
        "track_method_id": 1,
        "tracking_type_id": null,
        "started_at": null,
        "timer_started_at": null,
        "approved": false,
        "approved_at": null,
        "updated_at": "2020-09-28T01:05:15.504+02:00",
        "invoiced": false,
        "rejected": false,
        "rejected_reason": null,
        "rejected_at": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "overhead_cost": 0,
        "overhead_cost_default": 0,
        "overhead_cost_normalized": 0,
        "internal_overhead_cost": 0,
        "internal_overhead_cost_default": 0,
        "internal_overhead_cost_normalized": 0,
        "facility_overhead_cost": 0,
        "facility_overhead_cost_default": 0,
        "facility_overhead_cost_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 579
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1426"
          }
        },
        "service": {
          "data": {
            "type": "services",
            "id": "29"
          }
        },
        "task": {
          "data": null
        },
        "approver": {
          "data": null
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "1425"
          }
        },
        "rejecter": {
          "data": null
        }
      }
    },
    {
      "id": "1426",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1384@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:15.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:15.375+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 579
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1926"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "29",
      "type": "services",
      "attributes": {
        "name": "test name",
        "position": 1,
        "deleted_at": null,
        "billable": true,
        "description": null,
        "pricing_type_id": 1,
        "worked_time": 480,
        "unapproved_time": 480,
        "billable_time": 0,
        "estimated_time": null,
        "booked_time": 0,
        "budgeted_time": 0,
        "profit_margin": 100,
        "unit_id": 2,
        "quantity": "1.0",
        "discount": null,
        "future_booked_time": 0,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "hourly_rate": null,
        "hourly_rate_default": null,
        "hourly_rate_normalized": null,
        "price": 100000,
        "price_default": 125000,
        "price_normalized": 100000,
        "revenue": 100000,
        "revenue_default": 125000,
        "revenue_normalized": 100000,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 100000,
        "profit_default": 125000,
        "profit_normalized": 100000,
        "budget_total": 100000,
        "budget_total_default": 125000,
        "budget_total_normalized": 100000,
        "budget_used": 100000,
        "budget_used_default": 125000,
        "budget_used_normalized": 100000,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 100000,
        "future_budget_used_default": 125000,
        "future_budget_used_normalized": 100000,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "discount_amount": 0,
        "discount_amount_default": 0,
        "discount_amount_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 579
          }
        },
        "service_type": {
          "data": {
            "type": "service_types",
            "id": "89"
          }
        },
        "deal": {
          "data": {
            "type": "deals",
            "id": "142"
          }
        }
      }
    },
    {
      "id": "1425",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1383@email.com",
        "title": null,
        "joined_at": "2020-09-28T01:05:15.000+02:00",
        "last_seen_at": "2020-09-28T01:05:15.553+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:15.343+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 579
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1925"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1926",
      "type": "companies",
      "attributes": {
        "name": "Client1348",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:15.370+02: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": 579
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "89",
      "type": "service_types",
      "attributes": {
        "name": "test name",
        "category_id": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 579
          }
        }
      }
    },
    {
      "id": "142",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-09-28",
        "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": "db13021aa95c3e478667dc5c6f961f96",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 100,
        "forecasted_budget_usage": 200,
        "forecasted_time_usage": 0,
        "budget_usage": 100,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 480,
        "time_to_close": null,
        "unapproved_entries_count": 1,
        "rejected_entries_count": 0,
        "estimated_remaining_time": -480,
        "unapproved_time": 480,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-09-28T01:05:15.453+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2020-09-28",
        "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": 579
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1425"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1927"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1427"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "2977"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        }
      }
    },
    {
      "id": "1925",
      "type": "companies",
      "attributes": {
        "name": "Organization579",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2020-09-28T01:05:15.341+02: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": 579
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1927",
      "type": "companies",
      "attributes": {
        "name": "Client1349",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:15.403+02: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": 579
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1427",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1385@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:15.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:15.418+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 579
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1928"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2977",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 579
          }
        }
      }
    },
    {
      "id": "1928",
      "type": "companies",
      "attributes": {
        "name": "Client1350",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:15.413+02: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": 579
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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-1429-d41d8cd98f00b204e9800998ecf8427e",
      "type": "new_time_reports",
      "attributes": {
        "group": "person",
        "year": null,
        "quarter": null,
        "month": null,
        "week": null,
        "day": null,
        "count": 1,
        "future": null,
        "people_custom_fields": {},
        "formula_fields": {},
        "date_period": null,
        "capacity": null,
        "available_time": null,
        "scheduled_time": 0,
        "scheduled_internal_time": 0,
        "scheduled_client_time": 0,
        "scheduled_event_time": "0.0",
        "internal_time": 0,
        "client_time": 480,
        "billable_time": 0,
        "unapproved_time": 480,
        "worked_time": 480,
        "paid_event_time": 0,
        "unpaid_event_time": 0,
        "event_time": 0,
        "worked_available_diff": null,
        "client_worked_ratio": "1.0",
        "worked_available_ratio": null,
        "worked_scheduled_ratio": null,
        "available_capacity_ratio": null,
        "billable_available_ratio": null,
        "billable_client_ratio": "0.0",
        "billable_worked_ratio": "0.0",
        "client_available_ratio": null,
        "scheduled_available_ratio": null,
        "client_scheduled_available_ratio": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "total_cost": 0,
        "total_cost_default": 0,
        "total_cost_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 580
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1429"
          }
        },
        "service": {
          "data": null
        },
        "service_type": {
          "data": null
        },
        "budget": {
          "data": null
        },
        "company": {
          "data": null
        },
        "project": {
          "data": null
        },
        "event": {
          "data": null
        },
        "report": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "1429",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1387@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-09-28T01:05:15.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-09-28T01:05:15.793+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 580
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1930"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1930",
      "type": "companies",
      "attributes": {
        "name": "Client1351",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2020-09-28T01:05:15.788+02: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": 580
          }
        },
        "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": 30,
        "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
      }
    }
  }
}

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


Generated by aglio on 27 Sep 2020