Skip to content

Rate Card Versions

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.

Operations

Fetching a list of Rate Card Versions

Request

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.

Query
created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

effective_on_datestring, (date)

Returns Rate Card 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.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • rate_card (RateCard) - The Rate Card to which this version belongs.
  • rate_card_roles (RateCardRole) - The Rate Card Roles owned by this Rate Card Version.
  • rate_card_set_version (RateCardSetVersion) - The Rate Card Set Version to which this version belongs.
onlystring

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.

orderstring

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.

Default:"created_at:desc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
rate_card_idinteger, (int32)

Restricts Rate Card Versions to the specified Rate Card ID.

rate_card_set_idinteger, (int32)

Restricts Rate Card Versions to the specified Rate Card Set ID.

rate_card_set_version_idinteger, (int32)

Restricts Rate Card Versions to the specified Rate Card Set Version ID.

updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

GET
/rate_card_versions
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/rate_card_versions?created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&effective_on_date=2019-08-24&include=string&only=string&order=created_at%3Adesc&page=1&per_page=20&rate_card_id=0&rate_card_set_id=0&rate_card_set_version_id=0&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z'

Responses

A list of Rate Card Versions have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
rate_card_versionsobject
rate_cardsobject
rate_card_set_versionsobject
rate_card_rolesobject
Response
{
  "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"
    }
  }
}