Skip to content

Creating one or many Cost Rates

Request

Creates a new cost rate for a specified account membership and currency. If a cost rate already exists for the specified account membership and currency, it will be overridden, effectively making this an update request as well. Up to 100 cost rates can be created or updated at once.

Note: Updating a cost rate will set the cost rate for future work. Existing time entries will not be affected.

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
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.
Bodyapplication/jsonrequired
cost_rateobject
cost_ratesArray of objects

Multiple cost rates and their attributes in an array.

{
  "cost_rate": {
    "account_membership_id": 0,
    "currency": "string",
    "amount_in_subunits": 0
  },
  "cost_rates": [
    {
      "account_membership_id": 0,
      "currency": "string",
      "amount_in_subunits": 0
    }
  ]
}

Responses

Cost Rate has been created.

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"
    }
  }
}