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

Billable Utilizations

Represents the billable utilization target for an account member. Each record has an effective date; the active billable utilization is the one with the most recent effective date. These endpoints are only accessible to users who are Administrators on the account.

Fetching a list of Billable Utilizations

This endpoint returns structured Billable Utilization 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 billable_utilizations top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

include
string

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

  • account_membership (AccountMembership) - The account membership for the user with whom the billable utilization is associated.
  • creator (User) - The user who created the billable utilization.
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.

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

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

Responses
200

A list of Billable Utilizations have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/billable_utilizations
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "billable_utilizations": {
    },
  • "account_memberships": {
    },
  • "users": {
    }
}
Creating a new Billable Utilization
This endpoint returns structured Billable Utilization 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 billable_utilizations 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.


    

  • account_membership (AccountMembership) - The account membership for the user with whom the billable utilization is associated.
    • 

  • creator (User) - The user who created the billable utilization.
    • 



 
Request Body schema: application/json
object
 
effective_date
required
string <date> 
The date the billable utilization becomes active, in ISO8601 format.


 
target
required
integer <int32> 
The percentage of logged time that should be billable for the account member.


 
account_membership_id
required
integer <int32> 
The account membership ID of the user to set the billable utilization for.


 
Responses 
200
Billable Utilization has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/billable_utilizations
Request samples 
application/json
{
  • "billable_utilization": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "billable_utilizations": {
    },
  • "account_memberships": {
    },
  • "users": {
    }
}
Fetching a single Billable Utilization
This endpoint returns structured Billable Utilization 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 billable_utilizations 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.


    

  • account_membership (AccountMembership) - The account membership for the user with whom the billable utilization is associated.
    • 

  • creator (User) - The user who created the billable utilization.
    • 



 
Responses 
200
The Billable Utilization has been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/billable_utilizations/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "billable_utilizations": {
    },
  • "account_memberships": {
    },
  • "users": {
    }
}
Updating an existing Billable Utilization
This endpoint returns structured Billable Utilization 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 billable_utilizations 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.


    

  • account_membership (AccountMembership) - The account membership for the user with whom the billable utilization is associated.
    • 

  • creator (User) - The user who created the billable utilization.
    • 



 
Request Body schema: application/json
object
 
effective_date
required
string <date> 
The date the billable utilization becomes active, ISO8601.


 
target
required
integer <int32> 
The percentage of logged time that should be billable for the account member.


 
Responses 
200
Billable Utilization has been updated.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/billable_utilizations/{id}
Request samples 
application/json
{
  • "billable_utilization": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "billable_utilizations": {
    },
  • "account_memberships": {
    },
  • "users": {
    }
}
Deleting an existing Billable Utilization
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
Billable Utilization has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/billable_utilizations/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Cost Rates