Cost Rates

Cost Rate represents the hourly cost for an account member, specified in a specific currency. A cost rate with the same currency as the account default currency is called the default cost rate.

Operations

Get Cost Rates

Request

This endpoint returns structured Cost Rate 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 cost_rates 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.

includestring

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

account_membership (AccountMembership) - The account membership associated with the cost rate.

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:asc"

pageinteger, (int32)

Default:1

per_pageinteger, (int32), <= 200

Default:20

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

/cost_rates

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

Responses

A list of Cost Rates have been retrieved.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

cost_ratesobject

account_membershipsobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "cost_rates": {
    "property1": {
      "account_membership_id": 0,
      "amount_in_subunits": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "in_use": true,
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "account_membership_id": 0,
      "amount_in_subunits": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "in_use": true,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "account_memberships": {
    "property1": {
      "backup_approver_association_ids": [
        "string"
      ],
      "bill_rate_in_cents": 0,
      "billability_target": 0,
      "can_create_workspace": true,
      "can_log_in": true,
      "can_view_reports": true,
      "collaborator_only_license": true,
      "cost_rate_ids": [
        "string"
      ],
      "cost_rate_in_cents": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "default_read_only": true,
      "default_role_id": "string",
      "disabled_at": "2019-08-24T14:15:22Z",
      "effective_workweek_id": "string",
      "future_billable_utilization_ids": [
        "string"
      ],
      "is_administrator": true,
      "is_backup_approver": true,
      "is_owner": true,
      "is_project_lead": true,
      "is_punch_clock_user": true,
      "managee_ids": [
        "string"
      ],
      "manager_can_approve": true,
      "manager_can_edit_skills": true,
      "manager_id": "string",
      "non_participant": true,
      "permission": "string",
      "possible_managee_ids": [
        "string"
      ],
      "possible_manager_ids": [
        "string"
      ],
      "should_show_alert_on_timesheet_submission": true,
      "skill_membership_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "backup_approver_association_ids": [
        "string"
      ],
      "bill_rate_in_cents": 0,
      "billability_target": 0,
      "can_create_workspace": true,
      "can_log_in": true,
      "can_view_reports": true,
      "collaborator_only_license": true,
      "cost_rate_ids": [
        "string"
      ],
      "cost_rate_in_cents": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "default_read_only": true,
      "default_role_id": "string",
      "disabled_at": "2019-08-24T14:15:22Z",
      "effective_workweek_id": "string",
      "future_billable_utilization_ids": [
        "string"
      ],
      "is_administrator": true,
      "is_backup_approver": true,
      "is_owner": true,
      "is_project_lead": true,
      "is_punch_clock_user": true,
      "managee_ids": [
        "string"
      ],
      "manager_can_approve": true,
      "manager_can_edit_skills": true,
      "manager_id": "string",
      "non_participant": true,
      "permission": "string",
      "possible_managee_ids": [
        "string"
      ],
      "possible_manager_ids": [
        "string"
      ],
      "should_show_alert_on_timesheet_submission": true,
      "skill_membership_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  }
}