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.
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.
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "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"
}
}, - "rate_cards": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}
}, - "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_roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "rate": 0,
- "rate_card_version_id": "string",
- "role_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "rate": 0,
- "rate_card_version_id": "string",
- "role_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
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.
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "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"
}
}, - "rate_cards": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}
}, - "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_roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "rate": 0,
- "rate_card_version_id": "string",
- "role_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "rate": 0,
- "rate_card_version_id": "string",
- "role_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
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.
{- "rate_card_version": {
- "default_rate": 0
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "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"
}
}, - "rate_cards": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}
}, - "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_roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "rate": 0,
- "rate_card_version_id": "string",
- "role_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "rate": 0,
- "rate_card_version_id": "string",
- "role_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}