Kantata Kantata OX Knowledge Base Release Notes Status Page

Rate Card Sets (Group of Rate Cards)

A Rate Card Set represents a group of Rate Cards with multiple currencies that can be bundled together. A Rate Card Set belongs to an account and can have several Rate Card Set Versions, each representing the effective version for a specified date.

If the Rate Card feature is enabled, an account will always have an account default Rate Card Set. Rate Cards belonging to the account default Rate Card Set are applied to projects by default when a Rate Card is not explicitly set.

Additional custom Rate Card Sets can be created after the Rate Cards feature has been enabled on the account. This can be done by making a request to the activations endpoint.

Fetching a list of Rate Card Sets

Rate Card Sets are only accessible to users with Financial access (Project Lead or higher) on the account.

An initial request to this endpoint, will generate an account default Rate Card Set and a create a Rate Card Set Version. This account default Rate Card Set will include a separate Rate Card for every currency used in projects on the user's account.

This endpoint returns structured Rate Card Set 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_sets top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
active
boolean

Includes only Rate Card Sets with published Rate Card Set Versions.

created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

has_active_currency
string

Includes only Rate Card Sets that have a rate card with the specified currency and belong to a published Rate Card Set Version.

has_currency
string

Includes only Rate Card Sets that have a rate card with the specified currency.

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_set_versions (RateCardSetVersion) - Rate Card Set Versions belonging to the Rate Card Set.
  • rate_cards (RateCard) - Rate Cards (currencies) belonging to the Rate Card Set.
  • workspace_groups (WorkspaceGroup) - Groups associated with the Rate Card Set.
matching
string

Includes only Rate Card Sets with a title matching the specified term.

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, created_at:desc, title:asc, and title:desc.

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.

workspace_groups
string

Filter rate card sets by their associated workspace groups. Provide a comma-separated list of workspace group IDs, for example 10,20.

Responses
200

A list of Rate Card Sets 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_sets
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_sets": {
    },
  • "rate_cards": {
    },
  • "rate_card_set_versions": {
    },
  • "workspace_groups": {
    }
}

Creating a new Rate Card Set

This endpoint returns structured Rate Card Set 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_sets top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
clone_version_id
integer <int32>

The ID of the existing Rate Card Set Version to be cloned. Cloning creates a Rate Card Set that contains the following:

  • A clone of the specified Rate Card Set Version.
  • A clone of all the associations of the specified Rate Card Set Version.
  • A clone of all the Rate Cards belonging to the Rate Card Set for the specified Rate Card Set Version.
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_set_versions (RateCardSetVersion) - Rate Card Set Versions belonging to the Rate Card Set.
  • rate_cards (RateCard) - Rate Cards (currencies) belonging to the Rate Card Set.
  • workspace_groups (WorkspaceGroup) - Groups associated with the Rate Card Set.
Request Body schema: application/json
object
title
required
string

The title of the Rate Card Set.

Responses
200

Rate Card Set has been created.

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

post/rate_card_sets
Request samples
application/json
{
  • "rate_card_set": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_sets": {
    },
  • "rate_cards": {
    },
  • "rate_card_set_versions": {
    },
  • "workspace_groups": {
    }
}

Fetching a single Rate Card Set

A Rate Card Set can only be accessed by users with Financial access (Project Lead or higher) on the account.

This endpoint returns structured Rate Card Set 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_sets 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_set_versions (RateCardSetVersion) - Rate Card Set Versions belonging to the Rate Card Set.
  • rate_cards (RateCard) - Rate Cards (currencies) belonging to the Rate Card Set.
  • workspace_groups (WorkspaceGroup) - Groups associated with the Rate Card Set.
Responses
200

The Rate Card Set 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_sets/{id}
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_sets": {
    },
  • "rate_cards": {
    },
  • "rate_card_set_versions": {
    },
  • "workspace_groups": {
    }
}

Updating an existing Rate Card Set

This endpoint returns structured Rate Card Set 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_sets 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_set_versions (RateCardSetVersion) - Rate Card Set Versions belonging to the Rate Card Set.
  • rate_cards (RateCard) - Rate Cards (currencies) belonging to the Rate Card Set.
  • workspace_groups (WorkspaceGroup) - Groups associated with the Rate Card Set.
Request Body schema: application/json
object
title
string

The title of the Rate Card Set.

Responses
200

Rate Card Set 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_sets/{id}
Request samples
application/json
{
  • "rate_card_set": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_sets": {
    },
  • "rate_cards": {
    },
  • "rate_card_set_versions": {
    },
  • "workspace_groups": {
    }
}

Deleting an existing Rate Card Set

A Rate Card Set cannot be deleted if:

  • The Rate Card Set is the account default.
  • A Rate Card belonging to the Rate Card Set is being used by a project.

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 Set 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_sets/{id}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}