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.

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 ID


 
 Example:  "1"
object
Company department.


 
key
string or null
Department key


 
 Example:  "1"
id
string or null
Department ID


 
 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.


 
 Example:  74
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.


 
 Example:  74
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 ID


 
 Example:  "1"
object
Company department.


 
key
string or null
Department key


 
 Example:  "1"
id
string or null
Department ID


 
 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.


 
 Example:  74
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
Use the query service to find timesheet lines that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples