Kantata Kantata OX Knowledge Base Release Notes Status Page

Rate Card Table Rows

Each Rate Card Table Row represents a role and its rates and currencies for a specific Rate Card Set Version.

Fetch Rate Card Table Rows

Returns all Rate Card Table Rows for a specified Rate Card Set Version.

Request
path Parameters
rate_card_set_version_id
required
integer

The ID of the Rate card set version.

Responses
200

A list of objects have been retrieved.

Response Schema: application/json
count
integer <int32>

The number of Rate Card Table Rows in the Rate Card Set Version.

object
Array of objects
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_table_rows": {
    }
}

Delete a Rate Card Table Row

Deletes all Rate Card Roles for a specified Rate Card Set Version and Role.

Request
path Parameters
rate_card_set_version_id
required
integer

The ID of the Rate card set version.

role_id
required
integer

The ID of the Role.

Responses
204

object 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_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}

Create or Update Rate Card Table Row

Creates or updates a Rate Card Table Row for a specified Rate Card Set Version and Role.

Request
path Parameters
rate_card_set_version_id
required
integer

The ID of the Rate card set version.

role_id
required
integer

The ID of the Role.

Request Body schema: application/json
object
required
Array of objects

The currencies and rates for each row.

Array
currency
required
string

The ISO code of the currency.

rate
required
integer <int32>

The rate in subunits (e.g. 25000 cents = 250 dollars).

Responses
200

object has been updated.

Response Schema: application/json
count
integer <int32>

The number of Rate Card Table Rows in the Rate Card Set Version.

object
Array of objects
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

put/rate_card_set_versions/{rate_card_set_version_id}/rate_card_table_rows/{role_id}
Request samples
application/json
{
  • "rate_card_table_row": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "rate_card_table_rows": {
    }
}