Skip to content

Creating a new Line Item Lock

Request

A line item lock will be created on your account at the specified lock date. On successful creation of a line item lock, a representation of it will be returned to you.

If your account requires time to be approved, creation will fail unless all time entries before the specified lock date have been approved. The Kantata OX UI has an auto approval tool for your convenience if you find yourself in this scenario.

This endpoint returns structured Line Item Lock 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 line_item_locks 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.

  • creator (User) - The user that set the line item lock on the account.
Bodyapplication/jsonrequired
line_item_lockobject
{
  "line_item_lock": {
    "locked_to": "2019-08-24"
  }
}

Responses

Line Item Lock has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
line_item_locksobject
usersobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "line_item_locks": {
    "property1": {
      "account_id": 0,
      "creator_id": "string",
      "locked_to": "2019-08-24"
    },
    "property2": {
      "account_id": 0,
      "creator_id": "string",
      "locked_to": "2019-08-24"
    }
  },
  "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"
      ]
    }
  }
}