Timesheet lines

A timesheet line is an entry on a timesheet that represents work done by one employee on a single day. Each timesheet line should reflect the dimensions used by the company. That is, work done for one customer or project should be recorded in a separate timesheet line from work done for another customer or project, etc. Reports and invoices use the dimension values to group timesheet lines for billing.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List timesheet lines

get/objects/time/timesheet-line

Returns up to 100 object references from the collection with a key, ID, and link for each timesheet line. This operation is mostly for use in testing; use query to find timesheet lines that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Project Manager, or Employee
PermissionsList and View timesheets
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "4101",
      • "id": "4101",
      • "href": "/objects/time/timesheet-line/4101"
      },
    • {
      • "key": "4102",
      • "id": "4102",
      • "href": "/objects/time/timesheet-line/4102"
      },
    • {
      • "key": "4103",
      • "id": "4103",
      • "href": "/objects/time/timesheet-line/4103"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}
Create a timesheet line
post/objects/time/timesheet-line
Creates a new timesheet line.



Permissions and other requirements



SubscriptionTime & Expenses


User typeBusiness, Project Manager, or Employee


PermissionsAdd timesheets







SecurityOAuth2 
Request 
Request Body schema: application/json
timesheet-line


entryDate
required
string <date> 
Date of the timesheet line entry.


 
 Example:  "2024-04-01"
quantity
required
number
Number of hours or quantity.


 
 Example:  6
object
The timesheet to which the line belongs.


 
key
string
Unique key for the timesheet.


 
 Example:  "11"
id
string
Unique identifier of the timesheet.


 
 Example:  "11"
description
string or null
Description of the individual timesheet line.


 
 Example:  "04/01/24: work on Project Z."
notes
string or null
Notes about the timesheet line.


 
 Example:  "Talked to client regarding project"
object
Categorizes the time. Each company's time types can differ and can include salary, contract hours, overtime, vacation, travel time, and so on.


 
key
string or null
Unique key for the time type.


 
 Example:  "1"
id
string or null
Unique identifier of the Time type.


 
 Example:  "Salaries At Root"
isBillable
boolean
 Default:  false
Indicates whether the line can be billed. Set to true if the line can be billed to a customer.


 
 Example:  true
object
External payroll details, such as information from Sage Intacct Construction Payroll.


 
costRate
number or null
External cost rate used.


 
 Example:  115
billingRate
number or null
External billing rate used.


 
 Example:  1
amount
string or null <decimal-precision-2> 
Labor amount. (Construction subscription.)


 
 Example:  "90"
employerTaxes
number or null
Employer taxes. (Construction subscription.)


 
 Example:  15
fringes
number or null
Amount of the fringes cost. (Construction subscription.)


 
 Example:  10
cashFringes
number or null
Amount of the cash fringes cost. (Construction subscription.)


 
 Example:  2
object
 
object
Company location.


 
key
string or null
Location key


 
 Example:  "1"
id
string or null
Location


 
 Example:  "1"
object
Company department.


 
key
string or null
Department key


 
 Example:  "1"
id
string or null
Department


 
 Example:  "1"
object
 
key
string or null
Employee key


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
 
key
string or null
Project key


 
 Example:  "2"
id
string or null
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string or null
Customer key


 
 Example:  "13"
id
string or null
Customer ID


 
 Example:  "CUST-13"
object
 
key
string or null
Vendor key


 
 Example:  "357"
id
string or null
Vendor ID


 
 Example:  "1605212096809"
object
 
key
string or null
Item key


 
 Example:  "13"
id
string or null
Item ID


 
 Example:  "Case 13"
object
 
key
string or null
Warehouse key


 
 Example:  "6"
id
string or null
Warehouse ID


 
 Example:  "WH01"
object
 
key
string or null
Class key


 
 Example:  "731"
id
string or null
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string or null
Task ID


 
 Example:  "1"
key
string or null
Task key


 
 Example:  "1"
object
 
id
string or null
Cost Type ID


 
 Example:  "2"
key
string or null
Cost Type key


 
 Example:  "2"
object
 
id
string or null
Asset ID


 
 Example:  "A001"
key
string or null
Asset key


 
 Example:  "1"
object
 
id
string or null
Contract ID


 
 Example:  "CON-0045-1"
key
string or null
Contract key


 
 Example:  "12"
object
 
key
string or null
Affiliate entity key.


 
 Example:  "23"
id
string or null
Affiliate entity ID.


 
 Example:  "AFF-23"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "timesheet": {
    • "key": "11"
    },
  • "dimensions": {
    • "department": {
      • "key": "11"
      },
    • "location": {
      • "key": "22"
      },
    • "project": {
      • "key": "1"
      },
    • "costType": {
      • "key": "2"
      },
    • "task": {
      • "key": "1"
      },
    • "customer": {
      • "key": "13"
      },
    • "item": {
      • "key": "13"
      }
    },
  • "entryDate": "2024-04-01",
  • "quantity": 6,
  • "description": "Week of 04/01/24",
  • "notes": "Talked to client regarding project",
  • "timeType": {
    • "key": "1"
    },
  • "isBillable": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4108",
    • "id": "4108",
    • "href": "/objects/time/timesheet-line/4108"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a timesheet line
get/objects/time/timesheet-line/{key}
Returns detailed information for a specified timesheet line.



Permissions and other requirements



SubscriptionTime & Expenses


User typeBusiness, Project Manager, or Employee


PermissionsList and View timesheets







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the timesheet line.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1411",
    • "id": "1411",
    • "href": "/objects/time/timesheet-line/1411",
    • "timesheet": {
      • "key": "11",
      • "id": "11",
      • "href": "/objects/time/timesheet/11"
      },
    • "dimensions": {
      • "employee": {
        },
      • "department": {
        },
      • "location": {
        },
      • "project": {
        },
      • "costType": {
        },
      • "task": {
        },
      • "customer": {
        },
      • "item": {
        }
      },
    • "entryDate": "2024-04-01",
    • "quantity": 6,
    • "lineNumber": 1,
    • "description": "Week of 04/01/24",
    • "notes": "Talked to client regarding project",
    • "state": "approved",
    • "timeType": {
      • "key": "1",
      • "id": "Salaries At Root",
      • "href": "/objects/time/time-type/1"
      },
    • "isBillable": true,
    • "isBilled": "false",
    • "statisticalJournal": {
      • "key": "7483",
      • "id": "TSSJ",
      • "href": "/objects/general-ledger/statistical-account/10"
      },
    • "billableUtilizedAccount": {
      • "key": "8293",
      • "id": "9293",
      • "href": "/objects/general-ledger/statistical-account/8293"
      },
    • "nonBbillableUtilizedAccount": {
      • "key": "8294",
      • "id": "9294",
      • "href": "/objects/general-ledger/statistical-account/8294"
      },
    • "billableNonUtilizedAccount": {
      • "key": "8295",
      • "id": "9295",
      • "href": "/objects/general-ledger/statistical-account/8295"
      },
    • "nonBillableNonUtilizedAccount": {
      • "key": "8296",
      • "id": "9296",
      • "href": "/objects/general-ledger/statistical-account/8296"
      },
    • "hours": {
      • "billable": 8,
      • "nonBillable": 2,
      • "approved": 10,
      • "approvedBillable": 8,
      • "approvedNonBillable": 2,
      • "utilized": 10,
      • "nonUtilized": 4,
      • "approvedUtilized": 3,
      • "approvedNonUtilized": 2
      },
    • "externalPayroll": {
      • "costRate": 1,
      • "billingRate": 1,
      • "amount": "90",
      • "employerTaxes": 15,
      • "fringes": 10,
      • "cashFringes": 2
      },
    • "laborClass": {
      • "key": "15",
      • "id": "LC001",
      • "name": "Labor Class",
      • "href": "/objects/construction/labor-class/15"
      },
    • "laborShift": {
      • "key": "18",
      • "id": "LS001",
      • "name": "Labor Shift",
      • "href": "/objects/construction/labor-class/18"
      },
    • "laborUnion": {
      • "key": "20",
      • "id": "LU001",
      • "name": "Labor Union",
      • "href": "/objects/construction/labor-class/20"
      },
    • "audit": {
      • "createdDateTime": "2022-04-20T16:20:00Z",
      • "modifiedDateTime": "2022-04-20T16:20:00Z",
      • "createdBy": "1",
      • "modifiedBy": "95"
      }
    },
  • "ia::meta": {
    • "totalCount": 3
    }
}
Update a timesheet line
patch/objects/time/timesheet-line/{key}
Updates an existing timesheet line by setting field values. Any fields not provided remain unchanged. Whether approvals are turned on for a company, and where a timesheet is in the approval process determines if a timesheet line can be edited.



Permissions and other requirements



SubscriptionTime & Expenses


User typeBusiness, Project Manager, or Employee


PermissionsEdit timesheets







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the timesheet line.


 
Request Body schema: application/json
object
The timesheet to which the line belongs.


 
key
string
Unique key for the timesheet.


 
 Example:  "11"
id
string
Unique identifier of the timesheet.


 
 Example:  "11"
entryDate
string <date> 
Date of the timesheet line entry.


 
 Example:  "2024-04-01"
quantity
number
Number of hours or quantity.


 
 Example:  6
description
string or null
Description of the individual timesheet line.


 
 Example:  "04/01/24: work on Project Z."
notes
string or null
Notes about the timesheet line.


 
 Example:  "Talked to client regarding project"
object
Categorizes the time. Each company's time types can differ and can include salary, contract hours, overtime, vacation, travel time, and so on.


 
key
string or null
Unique key for the time type.


 
 Example:  "1"
id
string or null
Unique identifier of the Time type.


 
 Example:  "Salaries At Root"
isBillable
boolean
 Default:  false
Indicates whether the line can be billed. Set to true if the line can be billed to a customer.


 
 Example:  true
object
External payroll details, such as information from Sage Intacct Construction Payroll.


 
costRate
number or null
External cost rate used.


 
 Example:  115
billingRate
number or null
External billing rate used.


 
 Example:  1
amount
string or null <decimal-precision-2> 
Labor amount. (Construction subscription.)


 
 Example:  "90"
employerTaxes
number or null
Employer taxes. (Construction subscription.)


 
 Example:  15
fringes
number or null
Amount of the fringes cost. (Construction subscription.)


 
 Example:  10
cashFringes
number or null
Amount of the cash fringes cost. (Construction subscription.)


 
 Example:  2
object
 
object
Company location.


 
key
string or null
Location key


 
 Example:  "1"
id
string or null
Location


 
 Example:  "1"
object
Company department.


 
key
string or null
Department key


 
 Example:  "1"
id
string or null
Department


 
 Example:  "1"
object
 
key
string or null
Employee key


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
 
key
string or null
Project key


 
 Example:  "2"
id
string or null
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string or null
Customer key


 
 Example:  "13"
id
string or null
Customer ID


 
 Example:  "CUST-13"
object
 
key
string or null
Vendor key


 
 Example:  "357"
id
string or null
Vendor ID


 
 Example:  "1605212096809"
object
 
key
string or null
Item key


 
 Example:  "13"
id
string or null
Item ID


 
 Example:  "Case 13"
object
 
key
string or null
Warehouse key


 
 Example:  "6"
id
string or null
Warehouse ID


 
 Example:  "WH01"
object
 
key
string or null
Class key


 
 Example:  "731"
id
string or null
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string or null
Task ID


 
 Example:  "1"
key
string or null
Task key


 
 Example:  "1"
object
 
id
string or null
Cost Type ID


 
 Example:  "2"
key
string or null
Cost Type key


 
 Example:  "2"
object
 
id
string or null
Asset ID


 
 Example:  "A001"
key
string or null
Asset key


 
 Example:  "1"
object
 
id
string or null
Contract ID


 
 Example:  "CON-0045-1"
key
string or null
Contract key


 
 Example:  "12"
object
 
key
string or null
Affiliate entity key.


 
 Example:  "23"
id
string or null
Affiliate entity ID.


 
 Example:  "AFF-23"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "40",
  • "description": "Week of 04/01/24",
  • "notes": "Talked to client regarding project"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "40",
    • "id": "40",
    • "href": "/objects/time/timesheet-line/40"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalFailure": 0
    }
}
Delete a timesheet line
delete/objects/time/timesheet-line/{key}
Deletes a timesheet line. If a timesheet has posted to the General Ledger or has been invoiced, it cannot be deleted.



Permissions and other requirements



SubscriptionTime and Expenses


User typeBusiness, Project Manager, or Employee


PermissionsDelete Timesheets







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the timesheet line.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query timesheet lines
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "time/timesheet-line"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}