Skip to content

Creating a new Project Template Expense Budget

Request

Adds an expense budget to a project template.

Bulk Create

This endpoint supports bulk creating up to 100 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:

{
  "project_template_expense_budgets": [
    {
      "project_template_id": 123,
      "title": "Expense",
      "billable": true,
      "burns_budget": true,
      "fixed_fee": false,
      "cost_per_unit_in_subunits": 10000,
      "markup_type": "percentage",
      "markup_percentage": 10,
      "quantity": 1
    },
    {
      "project_template_id": 123,
      "title": "Expense 2",
      "billable": true,
      "burns_budget": true,
      "fixed_fee": false,
      "cost_per_unit_in_subunits": 20000,
      "markup_type": "percentage",
      "markup_percentage": 10,
      "quantity": 1
    }
  ]
}

This endpoint returns structured Project Template Expense Budget objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the project_template_expense_budgets top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • project_template (ProjectTemplate) - Retrieves the template the expense budget is on. The response will include project_template_id, which references the data in the project_templates top-level key.
Bodyapplication/jsonrequired
project_template_expense_budgetobject
{
  "project_template_expense_budget": {
    "project_template_id": 0,
    "title": "string",
    "description": "string",
    "billable": true,
    "burns_budget": true,
    "fixed_fee": true,
    "cost_per_unit_in_subunits": 0,
    "markup_type": "string",
    "markup_per_unit_in_subunits": 0,
    "markup_percentage": 0.1,
    "quantity": 0,
    "relative_expected_by_date": 0
  }
}

Responses

Project Template Expense Budget has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
project_template_expense_budgetsobject
project_templatesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "project_template_expense_budgets": {
    "property1": {
      "billable": true,
      "burns_budget": true,
      "cost_per_unit_in_subunits": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "fixed_fee": true,
      "markup_per_unit_in_subunits": 0,
      "markup_percentage": 0,
      "markup_type": "string",
      "project_template_id": 0,
      "quantity": 0,
      "relative_expected_by_date": 0,
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "billable": true,
      "burns_budget": true,
      "cost_per_unit_in_subunits": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "fixed_fee": true,
      "markup_per_unit_in_subunits": 0,
      "markup_percentage": 0,
      "markup_type": "string",
      "project_template_id": 0,
      "quantity": 0,
      "relative_expected_by_date": 0,
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "project_templates": {
    "property1": {
      "budget": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "duration": 0,
      "is_budgeted": true,
      "item_count": 0,
      "permissions": {
        "can_edit_project_template": true
      },
      "project_template_additional_tab_ids": [
        "string"
      ],
      "project_template_assignment_ids": [
        "string"
      ],
      "raw_json": "string",
      "shared": true,
      "sharing": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "budget": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "duration": 0,
      "is_budgeted": true,
      "item_count": 0,
      "permissions": {
        "can_edit_project_template": true
      },
      "project_template_additional_tab_ids": [
        "string"
      ],
      "project_template_assignment_ids": [
        "string"
      ],
      "raw_json": "string",
      "shared": true,
      "sharing": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  }
}