PRproductive
Reports

Get budget reports

Changed on

Retrieve a paginated list of aggregated budget report rows. Supports filtering, grouping, and sorting by budget dimensions and metrics.

get/api/v2/reports/budget_reports

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/reports/budget_reports
  • Auth
    none declared

Query parameters

OR

Filters

{
  "0": {
    "id": {
      "eq": "123"
    }
  },
  "$op": "and"
}
sortstring[]

Sort budget report

group'budget' | 'closed_at' | 'company' | 'contract' | 'created_at' | 'custom_fields' | 'date' | 'deal_type' | 'delivered_on' | 'designated_approver' | 'end_date' | 'last_activity_at' | 'month' | 'next_occurrence_on' | 'organization' | 'origin_deal' | 'primary_contact' | 'project' | 'project_type' | 'purchase_order_number' | 'quarter' | 'recurring' | 'recurring_ends_on' | 'recurring_interval' | 'recurring_starts_on' | 'responsible' | 'revenue_distribution_type' | 'status' | 'subsidiary' | 'tracking_type_id' | 'week' | 'year'

Group budget report

Response

Collection budget report

Example response

{
  "data": [
    {
      "id": "r-003",
      "type": "budget_reports",
      "attributes": {
        "budget_total": "100000.00",
        "budget_used": "62000.00",
        "revenue": "75000.00",
        "cost": "45000.00",
        "profit": "30000.00",
        "profit_margin": 0.4,
        "billable_time": 48000,
        "nonbillable_time": 6000,
        "expense_amount": "3500.00",
        "project_id": 6899,
        "deal_id": 89,
        "currency": "USD"
      }
    }
  ],
  "included": [],
  "meta": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 42,
    "page_size": 30,
    "max_page_size": 200
  }
}

Changes

  • 7dcc2525e812Revision changes
    • info

      added the enum value -applied_scenario_margin to the property items/ of the query request parameter sort

    • info

      added the enum value applied_scenario_margin to the property items/ of the query request parameter sort

  • fa3060fd0144Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status