Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Line Item Locks

Line Item Locks provide a way for you to lock time in the past so that previous time entries cannot be edited or updated and new time entries cannot be created before the selected lock date.

Line Items can be locked to any Saturday in the past on a per-account basis.

Keep in mind that this feature does not lock the ability to invoice approved time entries, nor does it lock the submission or approval of expenses.

Also note: Line Item Locks cannot be modified or deleted. If you would like to move the lock date forward, simply create a new lock at a later date, and your account will be locked at the new date. Once your account has been locked, the lock cannot be moved earlier, or removed.

Fetching a list of Line Item Locks

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.

Request
query Parameters
include
string

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.
only
string

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.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
Responses
200

A list of Line Item Locks have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/line_item_locks
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "line_item_locks": {
    },
  • "users": {
    }
}
Creating a new Line Item Lock
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.


Request 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
locked_to
required
string <date> 
Specify the date before which no one on the account will be able to submit or edit time entries.
(note: This must be a Saturday.) If any Line Item Locks previously existed on your account,
this must be set to a later date than said preexisting lock. The date must be in ISO 8601 format.


 
Responses 
200
Line Item Lock has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/line_item_locks
Request samples 
application/json
{
  • "line_item_lock": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "line_item_locks": {
    },
  • "users": {
    }
}
Fetching a single Line Item Lock
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Responses 
200
The Line Item Lock has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/line_item_locks/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "line_item_locks": {
    },
  • "users": {
    }
}
➔ Next to Time Entries