Kantata Kantata OX Knowledge Base Release Notes Status Page

Activations

The Rate Card activation endpoints allow you to check whether the Rate Cards feature has been activated on the user's account. It also allows you to activate the feature on the user's account.

Check Rate Cards Activation Status

This endpoint allows you to check whether the Rate Cards feature has been activated on the user's account. This endpoint is only accessible to users with Financial access (Project Lead or higher) on the account.

Responses
200

A list of objects have been retrieved.

Response Schema: application/json
activated
boolean

Indicates whether the Rate Card feature has been enabled on the user's account.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/account_rate_cards_activations
Request samples
Response samples
application/json
{
  • "activated": true
}

Activate Rate Cards

Activate Rate Cards on a user's account by submitting a rate card set version that belongs to the default Rate Card Set. Only an Account Administrator can activate rate cards on an account.

The initial request to this endpoint will generate an account default Rate Card Set and 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.

Request
query Parameters
rate_card_set_version_id
required
integer <int32>

The ID of the Rate Card Set Version belonging to the account default Rate Card Set.

Responses
200

object has been created.

Response Schema: application/json
activated
boolean

Indicates whether the Rate Card feature has been enabled on the user's account.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

post/account_rate_cards_activations
Request samples
Response samples
application/json
{
  • "activated": true
}