Skip to content

Creating a new Rate Card Set

Request

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.

Query
clone_version_idinteger, (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.
includestring

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.
Bodyapplication/jsonrequired
rate_card_setobject
{ "rate_card_set": { "title": "string" } }

Responses

Rate Card Set has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
rate_card_setsobject
rate_cardsobject
rate_card_set_versionsobject
workspace_groupsobject
Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "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_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" ] } }, "workspace_groups": { "property1": { "address": "string", "company": true, "contact_name": "string", "created_at": "2019-08-24T14:15:22Z", "email": "string", "external_reference_ids": [ "string" ], "name": "string", "notes": "string", "phone_number": "string", "rate_card_set_ids": [ "string" ], "updated_at": "2019-08-24T14:15:22Z", "website": "string", "workspace_ids": [ "string" ] }, "property2": { "address": "string", "company": true, "contact_name": "string", "created_at": "2019-08-24T14:15:22Z", "email": "string", "external_reference_ids": [ "string" ], "name": "string", "notes": "string", "phone_number": "string", "rate_card_set_ids": [ "string" ], "updated_at": "2019-08-24T14:15:22Z", "website": "string", "workspace_ids": [ "string" ] } } }