Rate Card Set Version (Effective version by Date)

In the Rate Card system, Rate Card Set Versions represent snapshots of a Rate Card Set, that take effect on the set published date. A Rate Card Set Version owns a copy of each Rate Card Version of a Rate Card in the associated Rate Card Set.

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

Since Rate Cards and Rate Card Versions are immutable after they are published and in use, generating a Rate Card Set Version is the correct process for making any changes. When a new Rate Card Set Version is created or cloned, all of the Rate Card Versions from the old Rate Card Set Version are copied to a new one.

Fetching a list of Rate Card Set Versions

Rate Card Set Versions are only accessible to Administrators on the account.

This endpoint returns structured Rate Card Set 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_set_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 Set 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_set` (RateCardSet) - The Rate Card Set this version belongs to. `rate_card_versions` (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set.
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_set_id	integer <int32> Restricts Rate Card Set Versions to the specified Rate Card Set.
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 Set Versions 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_set_versions

Request samples

Response samples

application/json

{"count": 0,
"meta": {"count": 0,
"page_count": 0,
"page_number": 0,
"page_size": 0
},
"results": [{"key": "string",
"id": "string"
}
],
"rate_card_set_versions": {"property1": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24",
"rate_card_set_id": "string",
"rate_card_version_ids": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"used_currencies": ["string"
]
},
"property2": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24",
"rate_card_set_id": "string",
"rate_card_version_ids": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"used_currencies": ["string"
]
}
},
"rate_card_sets": {"property1": {"account_default": true,
"active_currencies": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"default_currencies": ["string"
],
"destroyable": true,
"rate_card_ids": ["string"
],
"rate_card_set_version_ids": ["string"
],
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_group_ids": ["string"
]
},
"property2": {"account_default": true,
"active_currencies": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"default_currencies": ["string"
],
"destroyable": true,
"rate_card_ids": ["string"
],
"rate_card_set_version_ids": ["string"
],
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_group_ids": ["string"
]
}
},
"rate_card_versions": {"property1": {"created_at": "2019-08-24T14:15:22Z",
"default_rate": 0,
"rate_card_id": "string",
"rate_card_role_ids": ["string"
],
"rate_card_set_version_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"property2": {"created_at": "2019-08-24T14:15:22Z",
"default_rate": 0,
"rate_card_id": "string",
"rate_card_role_ids": ["string"
],
"rate_card_set_version_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

Creating a new Rate Card Set Version

Rate Card Set Versions can only created by an Administrator on the account.

Creating/Cloning a Rate Card Set Version on a Rate Card Set, does the following:

Creates/Clones a Rate Card Version for each existing Rate Card on the associated Rate Card Set.
Creates/Clones necessary associations for each Rate Card Version.

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

Request

query Parameters

clone_id	integer <int32> The ID of the Rate Card Set Version to be cloned.
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` (RateCardSet) - The Rate Card Set this version belongs to. `rate_card_versions` (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set.

Request Body schema: application/json
required

object

rate_card_set_id required	integer <int32> The ID of the Rate Card Set to which this version belongs.
effective_date	string <date> The date from the which the current rate card set version takes effect. This will default to today. The date must be in ISO 8601 format.

Responses

200

Rate Card Set Version 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_set_versions

Request samples

application/json

{"rate_card_set_version": {"rate_card_set_id": 0,
"effective_date": "2019-08-24"
}
}

Response samples

application/json

{"count": 0,
"meta": {"count": 0,
"page_count": 0,
"page_number": 0,
"page_size": 0
},
"results": [{"key": "string",
"id": "string"
}
],
"rate_card_set_versions": {"property1": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24",
"rate_card_set_id": "string",
"rate_card_version_ids": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"used_currencies": ["string"
]
},
"property2": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24",
"rate_card_set_id": "string",
"rate_card_version_ids": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"used_currencies": ["string"
]
}
},
"rate_card_sets": {"property1": {"account_default": true,
"active_currencies": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"default_currencies": ["string"
],
"destroyable": true,
"rate_card_ids": ["string"
],
"rate_card_set_version_ids": ["string"
],
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_group_ids": ["string"
]
},
"property2": {"account_default": true,
"active_currencies": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"default_currencies": ["string"
],
"destroyable": true,
"rate_card_ids": ["string"
],
"rate_card_set_version_ids": ["string"
],
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_group_ids": ["string"
]
}
},
"rate_card_versions": {"property1": {"created_at": "2019-08-24T14:15:22Z",
"default_rate": 0,
"rate_card_id": "string",
"rate_card_role_ids": ["string"
],
"rate_card_set_version_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"property2": {"created_at": "2019-08-24T14:15:22Z",
"default_rate": 0,
"rate_card_id": "string",
"rate_card_role_ids": ["string"
],
"rate_card_set_version_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

Fetching a single Rate Card Set Version

A Rate Card Set Version is only accessible to an Administrator on the account.

This endpoint returns structured Rate Card Set 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_set_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_set (RateCardSet) - The Rate Card Set this version belongs to.
rate_card_versions (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set.

Responses

200

The Rate Card Set Version 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_set_versions/{id}

Request samples

Response samples

application/json

{"count": 0,
"meta": {"count": 0,
"page_count": 0,
"page_number": 0,
"page_size": 0
},
"results": [{"key": "string",
"id": "string"
}
],
"rate_card_set_versions": {"property1": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24",
"rate_card_set_id": "string",
"rate_card_version_ids": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"used_currencies": ["string"
]
},
"property2": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24",
"rate_card_set_id": "string",
"rate_card_version_ids": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"used_currencies": ["string"
]
}
},
"rate_card_sets": {"property1": {"account_default": true,
"active_currencies": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"default_currencies": ["string"
],
"destroyable": true,
"rate_card_ids": ["string"
],
"rate_card_set_version_ids": ["string"
],
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_group_ids": ["string"
]
},
"property2": {"account_default": true,
"active_currencies": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"default_currencies": ["string"
],
"destroyable": true,
"rate_card_ids": ["string"
],
"rate_card_set_version_ids": ["string"
],
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_group_ids": ["string"
]
}
},
"rate_card_versions": {"property1": {"created_at": "2019-08-24T14:15:22Z",
"default_rate": 0,
"rate_card_id": "string",
"rate_card_role_ids": ["string"
],
"rate_card_set_version_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"property2": {"created_at": "2019-08-24T14:15:22Z",
"default_rate": 0,
"rate_card_id": "string",
"rate_card_role_ids": ["string"
],
"rate_card_set_version_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

Updating an existing Rate Card Set Version

A Rate Card Set Version can only be modified when the effective date is in the future, or when it is not yet published.

This endpoint returns structured Rate Card Set 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_set_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_set (RateCardSet) - The Rate Card Set this version belongs to.
rate_card_versions (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set.

Request Body schema: application/json
required

object

effective_date

string <date>

The date from the which the current Rate Card Set Version takes effect. The date must be in ISO 8601 format.

Responses

200

Rate Card Set Version 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_set_versions/{id}

Request samples

application/json

{"rate_card_set_version": {"effective_date": "2019-08-24"
}
}

Response samples

application/json

{"count": 0,
"meta": {"count": 0,
"page_count": 0,
"page_number": 0,
"page_size": 0
},
"results": [{"key": "string",
"id": "string"
}
],
"rate_card_set_versions": {"property1": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24",
"rate_card_set_id": "string",
"rate_card_version_ids": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"used_currencies": ["string"
]
},
"property2": {"active": true,
"created_at": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24",
"rate_card_set_id": "string",
"rate_card_version_ids": ["string"
],
"updated_at": "2019-08-24T14:15:22Z",
"used_currencies": ["string"
]
}
},
"rate_card_sets": {"property1": {"account_default": true,
"active_currencies": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"default_currencies": ["string"
],
"destroyable": true,
"rate_card_ids": ["string"
],
"rate_card_set_version_ids": ["string"
],
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_group_ids": ["string"
]
},
"property2": {"account_default": true,
"active_currencies": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"default_currencies": ["string"
],
"destroyable": true,
"rate_card_ids": ["string"
],
"rate_card_set_version_ids": ["string"
],
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_group_ids": ["string"
]
}
},
"rate_card_versions": {"property1": {"created_at": "2019-08-24T14:15:22Z",
"default_rate": 0,
"rate_card_id": "string",
"rate_card_role_ids": ["string"
],
"rate_card_set_version_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"property2": {"created_at": "2019-08-24T14:15:22Z",
"default_rate": 0,
"rate_card_id": "string",
"rate_card_role_ids": ["string"
],
"rate_card_set_version_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

Deleting an existing Rate Card Set Version

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 Version 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/{id}

Request samples

Response samples

application/json

{"errors": [{"type": "string",
"message": "string"
}
]
}

Publish a Rate Card Set Version

Publishing a Rate Card Set Version means activating the version from the set effective date. A Rate Card Set Version can be published to any future date, but cannot be published on the same effective date as another Rate Card Set Version on the same Rate Card Set. Once published, a Rate Card Set Version cannot be unpublished.

This endpoint returns structured Rate Card Set 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_set_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_set (RateCardSet) - The Rate Card Set this version belongs to.
rate_card_versions (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set.

Responses

200

Rate Card Set Version has been updated.

Response Schema: application/json

activated

boolean

Indicates whether the Rate Card Set Version has been published.

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/{id}/publish

Request samples

Response samples

application/json

{"activated": true
}

Rate Card Set Version (Effective version by Date)

Fetching a list of Rate Card Set Versions

query Parameters

Response Schema: application/json

Creating a new Rate Card Set Version

query Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Fetching a single Rate Card Set Version

path Parameters

query Parameters

Response Schema: application/json

Updating an existing Rate Card Set Version

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Deleting an existing Rate Card Set Version

path Parameters

Publish a Rate Card Set Version

path Parameters

query Parameters

Response Schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required