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

Rate Card Versions

Rate Card Versions represent a snapshot of a Rate Card at a specified point in time. They are used to set the default rate. Rate Card Versions belong to a Rate Card Set Version and own many Rate Card Roles.

Rate Card Versions cannot be explicitly created. This is done through the creation of Rate Cards or Rate Card Set Versions.

Fetching a list of Rate Card Versions

Rate Card Versions are only accessible by Administrators on the account.

This endpoint returns structured Rate Card Version 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_versions 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.

effective_on_date
string <date>

Returns Rate Card Versions that are effective on the requested date. The date should be in <ISO_8601 Date Format> eg. '2014-02-25'. The date 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.

  • rate_card (RateCard) - The Rate Card to which this version belongs.
  • rate_card_roles (RateCardRole) - The Rate Card Roles owned by this Rate Card Version.
  • rate_card_set_version (RateCardSetVersion) - The Rate Card Set Version to which this version belongs.
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 and created_at:desc.

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

Restricts Rate Card Versions to the specified Rate Card ID.

rate_card_set_id
integer <int32>

Restricts Rate Card Versions to the specified Rate Card Set ID.

rate_card_set_version_id
integer <int32>

Restricts Rate Card Versions to the specified Rate Card Set Version 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 Rate Card Versions have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
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_versions
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_versions": {
    },
  • "rate_cards": {
    },
  • "rate_card_set_versions": {
    },
  • "rate_card_roles": {
    }
}
Fetching a single Rate Card Version
Rate Card Versions are only accessible by Administrators on the account.


This endpoint returns structured Rate Card Version 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_versions 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 (RateCard) - The Rate Card to which this version belongs.
    • 

  • rate_card_roles (RateCardRole) - The Rate Card Roles owned by this Rate Card Version.
    • 

  • rate_card_set_version (RateCardSetVersion) - The Rate Card Set Version to which this version belongs.
    • 



 
Responses 
200
The Rate Card Version has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
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_versions/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_versions": {
    },
  • "rate_cards": {
    },
  • "rate_card_set_versions": {
    },
  • "rate_card_roles": {
    }
}
Updating an existing Rate Card Version
Rate Card Versions can only be modified by Administrators on the account.


This endpoint returns structured Rate Card Version 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_versions 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 (RateCard) - The Rate Card to which this version belongs.
    • 

  • rate_card_roles (RateCardRole) - The Rate Card Roles owned by this Rate Card Version.
    • 

  • rate_card_set_version (RateCardSetVersion) - The Rate Card Set Version to which this version belongs.
    • 



 
Request Body schema: application/json
required
object
 
default_rate
required
integer <int32> 
The default rate for all roles that do not have explicit rates associated with them.


 
Responses 
200
Rate Card Version has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
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_versions/{id}
Request samples 
application/json
{
  • "rate_card_version": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_versions": {
    },
  • "rate_cards": {
    },
  • "rate_card_set_versions": {
    },
  • "rate_card_roles": {
    }
}
➔ Next to Rate Cards (Multiple Currencies)