API Documentation

Overheads ¶

For more details about what overheads are, please refer to the help article.

The Overhead object represents overhead costs for a particular month of a fiscal year. Productive generates overhead objects automatically every month, starting the month when you opened your Productive account.

Please note that some overhead settings are also defined at the organisation level. This settings can be changed by modifying the Organizations object.

Supported attributes ¶

• facility_costs (integer)

• facility_costs_breakdown (json)

• use_overhead (boolean)

• overhead_controls (json)

• averaging_period (integer)

Costs are always defined in cents.

Facility cost breakdown can be defined as:

{
  "sections": [
    {
      "name": "Section",
      "rows": [
        {
          "cost": 200000,
          "name": "Facility cost"
        }
      ]
    }
  ]
}

There are six overhead controls which can be set to true or false inside a json object:

{
  "exclude_work_overhead": false,
  "exclude_expense_overhead": false,
  "exclude_facility_overhead": false,
  "exclude_overtime_overhead": true,
  "exclude_time_off_overhead": false,
  "exclude_undertime_overhead": true
}

These are default control settings when a new overhead is created. When changed for the current month, the settings are transferred to the next month.

Averaging period can only contain integer values from 1 to 12 which represents the number of months.

To change the overhead recalculation day and to globally enable or disable overhead, please use the Organization object.

Supported filters ¶

There are no supported filters for Overhead objects.

Supported sort params ¶

There are no supported params for Overhead objects. Default sorting is by Overhead id in a descending order (from newest to oldest).