Billable Utilizations

Represents the billable utilization target for an account member. Each record has an effective date; the active billable utilization is the one with the most recent effective date. These endpoints are only accessible to users who are Administrators on the account.

Operations

Fetching a list of Billable Utilizations

Request

This endpoint returns structured Billable Utilization 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 billable_utilizations 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 for the user with whom the billable utilization is associated.
creator (User) - The user who created the billable utilization.

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.

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

/billable_utilizations

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

Responses

A list of Billable Utilizations have been retrieved.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

billable_utilizationsobject

account_membershipsobject

usersobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "billable_utilizations": {
    "property1": {
      "account_membership_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "effective_date": "2019-08-24",
      "target": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "account_membership_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "effective_date": "2019-08-24",
      "target": 0,
      "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"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  }
}