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

Rate Card Role (Rate for a Role)

Rate Card Roles belong to a Rate Card Version and represent the bill rate, in cents per hour, for a specific Role. For example, the rate for the role of Developer may be 2000 cents per hour. It is not necessary, however, to create a Rate Card Role for every role on your account if the rate is the same as the default rate on the Rate Card Version. When an explicit Rate Card Role does not exist for a role on the account, the default rate on the Rate Card Version is used to calculate the total bill rate.

Rate Card Roles can only be accessed, edited, or deleted by an Administrator on the account.

Fetching a list of Rate Card Roles

Returns the Rate Card Roles associated with all Rate Card Versions on Rate Cards that belong to the logged-in user's account.

Rate Card Roles can only be accessed by an Administrator on the account.

This endpoint returns structured Rate Card Role 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 rate_card_roles 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.

  • rate_card_version (RateCardVersion) - The Rate Card Version to which this Rate Card Role belongs.
  • role (Role) - The account Role that this Rate Card Role represents.
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:asc"

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

Valid values: created_at:asc and created_at:desc.

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

Restricts Rate Card Roles to the specified Rate Card Version.

updated_after
string

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

with_role_ids
Array of integers <int32>

Restricts Rate Card Roles to the specified role ids.

Responses
200

A list of Rate Card Roles 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/rate_card_roles
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_roles": {
    },
  • "roles": {
    },
  • "rate_card_versions": {
    }
}
Creating a new Rate Card Role
A Rate Card Role can only be created by an Administrator on the account.


This endpoint returns structured Rate Card Role 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 rate_card_roles 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.


    

  • rate_card_version (RateCardVersion) - The Rate Card Version to which this Rate Card Role belongs.
    • 

  • role (Role) - The account Role that this Rate Card Role represents.
    • 



 
Request Body schema: application/json
object
 
rate_card_version_id
required
integer <int32> 
The ID of the Rate Card Version to which the Rate Card Role belongs.


 
role_id
required
integer <int32> 
The ID of the Role being represented by the Rate Card Role.


 
rate
required
integer <int32> 
The bill rate, in cents per hour, for the associated role.


 
Responses 
200
Rate Card Role 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/rate_card_roles
Request samples 
application/json
{
  • "rate_card_role": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_roles": {
    },
  • "roles": {
    },
  • "rate_card_versions": {
    }
}
Fetching a single Rate Card Role
A Rate Card Role can only be accessed by an Administrator on the account.


This endpoint returns structured Rate Card Role 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 rate_card_roles 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.


    

  • rate_card_version (RateCardVersion) - The Rate Card Version to which this Rate Card Role belongs.
    • 

  • role (Role) - The account Role that this Rate Card Role represents.
    • 



 
Responses 
200
The Rate Card Role 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/rate_card_roles/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_roles": {
    },
  • "roles": {
    },
  • "rate_card_versions": {
    }
}
Updating an existing Rate Card Role
A Rate Card Role can only be modified by an Administrator on the account.


This endpoint returns structured Rate Card Role 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 rate_card_roles 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.


    

  • rate_card_version (RateCardVersion) - The Rate Card Version to which this Rate Card Role belongs.
    • 

  • role (Role) - The account Role that this Rate Card Role represents.
    • 



 
Request Body schema: application/json
object
 
rate
integer <int32> 
The bill rate, in cents per hour, for the associated role.


 
Responses 
200
Rate Card Role 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/rate_card_roles/{id}
Request samples 
application/json
{
  • "rate_card_role": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_roles": {
    },
  • "roles": {
    },
  • "rate_card_versions": {
    }
}
Deleting an existing Rate Card Role
If a A Rate Card Role belongs to a Rate Card Version that is in use, it cannot be deleted. A Rate Card Role can
only be deleted by an Administrator on the account.


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
Rate Card Role has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/rate_card_roles/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Rate Card Set Version (Effective version by Date)