Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Project Template Expense Budgets

Project Template Expense Budgets are expense budgets configured in a project template that are added to a project when the template is applied.

Fetching a list of Project Template Expense Budgets

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.

Request
query Parameters
created_after
string <date-time>

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_before
string <date-time>

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

include
string

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.
only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

order
string
Default: "created_at:desc"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc, created_at:desc, title:asc, and title:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
project_template_id
integer <int32>

Filter by project template ID.

updated_after
string <date-time>

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_before
string <date-time>

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

Responses
200

A list of Project Template Expense Budgets have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/project_template_expense_budgets
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_expense_budgets": {
    },
  • "project_templates": {
    }
}
Creating a new Project Template Expense Budget
Adds an expense budget to a project template.


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.


Request 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
project_template_id
required
integer <int32> 
The ID of the template to add the expense budget to.


 
title
required
string
The name of the expense budget.


 
description
string
The description of the expense budget.


 
billable
required
boolean
Whether the expense will be billed to the client.


 
burns_budget
required
boolean
Whether the expense budget impacts the project margin.


 
fixed_fee
required
boolean
Whether the expense will be billed as a fixed cost.


 
cost_per_unit_in_subunits
integer <int32> 
The cost, in the subunits of the currency (e.g. cents for USD).


 
markup_type
string
The markup type. Possible values are percentage and flat_fee.


 
markup_per_unit_in_subunits
integer <int32> 
The markup per unit, in the subunits of the currency (e.g. cents for USD).


 
markup_percentage
number <float> 
If the markup_type is percentage, this is the markup percentage to apply to the expenses.


 
quantity
integer <int32> 
The number of expected units for the expense budget.


 
relative_expected_by_date
integer <int32> 
When the expenses are expected to be logged, relative to the project’s start date.
You can provide a negative value to indicate expenses are expected before the
project’s start date.


 
Responses 
200
Project Template Expense Budget has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/project_template_expense_budgets
Request samples 
application/json
{
  • "project_template_expense_budget": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_expense_budgets": {
    },
  • "project_templates": {
    }
}
Fetching a single Project Template Expense Budget
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Responses 
200
The Project Template Expense Budget has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/project_template_expense_budgets/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_expense_budgets": {
    },
  • "project_templates": {
    }
}
Updating an existing Project Template Expense Budget
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
title
string
The name of the expense budget.


 
billable
boolean
Whether the expense will be billed to the client.


 
burns_budget
boolean
Whether the expense budget impacts the project margin.


 
fixed_fee
boolean
Whether the expense will be billed as a fixed cost.


 
description
string
The description of the expense budget.


 
cost_per_unit_in_subunits
integer <int32> 
The cost, in the subunits of the currency (e.g. cents for USD).


 
markup_type
string
The markup type. Possible values are percentage and flat_fee.


 
markup_per_unit_in_subunits
integer <int32> 
The markup per unit, in the subunits of the currency (e.g. cents for USD).


 
markup_percentage
number <float> 
If the markup_type is percentage, this is the markup percentage to apply to the expenses.


 
quantity
integer <int32> 
The number of expected units for the expense budget.


 
relative_expected_by_date
integer <int32> 
When the expenses are expected to be logged, relative to the project’s start date.
You can provide a negative value to indicate expenses are expected before the
project’s start date.


 
Responses 
200
Project Template Expense Budget has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/project_template_expense_budgets/{id}
Request samples 
application/json
{
  • "project_template_expense_budget": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_expense_budgets": {
    },
  • "project_templates": {
    }
}
Deleting an existing Project Template Expense Budget
Removes an expense budget from a project template.


The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Project Template Expense Budget has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/project_template_expense_budgets/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Project Templates