Skip to content

Rate Cards (Multiple Currencies)

Rate Cards belong to a Rate Card Set and represent the currencies in that set. Rate Cards have many Rate Card Versions which represent the effective version of a Rate Card at a specified point of time. Rate Cards are accessible to users with Financial access (Project Lead or higher) on the account. However, they can only created, modified or deleted by Administrators on the account.

Operations

Fetching a list of Rate Cards

Request

Returns Rate Cards on every Rate Card Set belonging to the account of the user that is logged-in. This endpoint is only accessible to users with Financial access (Project Lead or higher) on the account.

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

Query
activeboolean

Returns Rate Cards that have been published.

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.

currenciesstring

Restricts Rate Cards to the specified currencies e.g. 'USD,CAD,GBP'.

external_reference_external_messagestring

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_statusstring

Filter by the status of the external object in the external system.

external_reference_service_modelstring

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_refinteger, (int32)

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refsstring

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_namestring

Filter by the name of the provider for integration.

external_reference_statusstring

Filter by the status of the integration, this can be successful or fail.

has_external_referencesboolean

Filter by whether or not the object has external references.

includestring

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

  • effective_rate_card_version (RateCardVersion) - Returns todays effective Rate Card Version for the user that is logged-in. Must be used with the only parameter.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • rate_card_set (RateCardSet) - The Rate Card Set to which this Rate Card belongs.
  • rate_card_versions (RateCardVersion) - Includes only Rate Card Versions which this Rate Card owns.
matchingstring

Returns rate cards whose set title matches the provided text (substring).

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_set_idinteger, (int32)

Restricts Rate Cards to the specified Rate Card Set.

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.

without_external_reference_service_namestring

Exclude by the existence of an external reference with the specified service name.

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/rate_cards?active=true&created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&currencies=string&external_reference_external_message=string&external_reference_external_status=string&external_reference_service_model=string&external_reference_service_model_ref=0&external_reference_service_model_refs=string&external_reference_service_name=string&external_reference_status=string&has_external_references=true&include=string&matching=string&only=string&order=created_at%3Adesc&page=1&per_page=20&rate_card_set_id=0&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&without_external_reference_service_name=string'

Responses

A list of Rate Cards have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
rate_cardsobject
external_referencesobject
rate_card_setsobject
rate_card_versionsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "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
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "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"
    }
  }
}