Timesheets

Timesheets ensure that workers are paid appropriately. They also help project managers invoice clients and track overall project costs and expenses over time. Timesheets are used in both Projects and Time & Expenses. A subscription to Projects is required to approve timesheets and save timesheets as drafts.

Each time a timesheet entry is submitted, a timesheet approval history object is created for tracking purposes. Many settings that impact required timesheet information are configured in Projects. See Configure Projects in the Sage Intacct Help Center for more information.

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 timesheets

get/objects/time/timesheet

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

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

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "101",
      • "id": "101",
      • "href": "/objects/time/timesheet/101"
      },
    • {
      • "key": "102",
      • "id": "102",
      • "href": "/objects/time/timesheet/102"
      },
    • {
      • "key": "103",
      • "id": "103",
      • "href": "/objects/time/timesheet/103"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}

Create a timesheet

post/objects/time/timesheet

Creates a new timesheet.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Project Manager, or Employee
PermissionsAdd timesheets
SecurityOAuth2
Request
Request Body schema: application/json

timesheet

beginDate
required
string <date>

Begin date of the work period.

Example: "2024-01-01"
postingDate
string <date>

Defaults to timesheet endDate. If endDate falls within a closed GL period, then postingDate automatically defaults to the first day of the next open GL period.

Example: "2024-01-01"
state
string
Default: "draft"

State of the timesheet in the approval cycle, such as approved or declined.

Enum: "approved" "declined" "draft" "partiallyApproved" "partiallyDeclined" "saved" "submitted"
Example: "submitted"
description
string

Timesheet description.

Example: "Week of 2024-01-01 to cover help desk"
object

The employee who performed the work and whose time is being tracked.

key
string

Unique key for the employee.

Example: "973"
id
string

Unique identifier for the employee.

Example: "E-001"
object

Supporting documentation for the timesheet.

key
string

Unique key for the attachment.

Example: "8420"
id
string

Unique identifier for the attachment.

Example: "Attach-01"
Array of objects

Time entries

Array
object

The timesheet to which the line belongs.

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.

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.

object
Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "beginDate": "2024-01-01",
  • "state": "submitted",
  • "description": "Week of 01/01/24",
  • "employee": {
    • "key": "973"
    },
  • "attachment": {
    • "key": "8420"
    },
  • "lines": [
    • {
      • "dimensions": {
        },
      • "entryDate": "2024-04-01",
      • "quantity": 6,
      • "description": "Week of 04/01/24",
      • "notes": "Talked to client regarding project",
      • "timeType": {
        },
      • "isBillable": true
      }
    ]
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "40",
    • "id": "40",
    • "href": "/objects/time/timesheet/40"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}

Get a timesheet

get/objects/time/timesheet/{key}

Returns detailed information for a specified timesheet.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Project Manager, or Employee
PermissionsList Timesheets
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the timesheet.

Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "23",
    • "id": "23",
    • "href": "/objects/time/timesheet/23",
    • "beginDate": "2024-01-01",
    • "endDate": "2024-12-31",
    • "postingDate": "2024-01-01",
    • "state": "submitted",
    • "unitOfMeasure": "Hours",
    • "hoursInDay": 8,
    • "description": "Week of 01/01/24",
    • "calculationMethod": "hourly",
    • "postActualLaborCost": false,
    • "employee": {
      • "key": "973",
      • "id": "E-001",
      • "href": "/objects/company-config/employee/973"
      },
    • "employeeContact": {
      • "key": "977",
      • "id": "John Smith",
      • "firstName": "John",
      • "lastName": "Smith",
      • "href": "/objects/company-config/contact/977"
      },
    • "attachment": {
      • "key": "8420",
      • "id": "Attach-01",
      • "href": "/objects/company-config/attachment/973"
      },
    • "employeeClassId": "EMP_CLS_001",
    • "employeeDepartmentId": "DEP-11",
    • "employeeLocation": {
      • "key": "22",
      • "id": "LOC-22",
      • "href": "/objects/company-config/location/22"
      },
    • "employeePositionId": "MGR",
    • "lines": [
      • {
        }
      ],
    • "audit": {
      • "createdDateTime": "2022-04-20T16:20:00Z",
      • "modifiedDateTime": "2022-04-20T16:20:00Z",
      • "createdBy": "1",
      • "modifiedBy": "95"
      }
    },
  • "ia::meta": {
    • "totalCount": 3
    }
}

Update a timesheet

patch/objects/time/timesheet/{key}

Updates an existing timesheet by setting field values. Any fields not provided remain unchanged.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Project Manager, or Employee
PermissionsUpdate Timesheets
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the timesheet.

Request Body schema: application/json
beginDate
string <date>

Begin date of the work period.

Example: "2024-01-01"
postingDate
string <date>

Defaults to timesheet endDate. If endDate falls within a closed GL period, then postingDate automatically defaults to the first day of the next open GL period.

Example: "2024-01-01"
state
string
Default: "draft"

State of the timesheet in the approval cycle, such as approved or declined.

Enum: "approved" "declined" "draft" "partiallyApproved" "partiallyDeclined" "saved" "submitted"
Example: "submitted"
description
string

Timesheet description.

Example: "Week of 2024-01-01 to cover help desk"
object

The employee who performed the work and whose time is being tracked.

key
string

Unique key for the employee.

Example: "973"
id
string

Unique identifier for the employee.

Example: "E-001"
object

Supporting documentation for the timesheet.

key
string

Unique key for the attachment.

Example: "8420"
id
string

Unique identifier for the attachment.

Example: "Attach-01"
Array of objects

Time entries

Array
object

The timesheet to which the line belongs.

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.

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.

object
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "state": "submitted",
  • "description": "Week of 01/01/24"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "40",
    • "id": "40",
    • "href": "/objects/time/timesheet/40"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}

Delete a timesheet

delete/objects/time/timesheet/{key}

Deletes a timesheet.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Project Manager, or Employee
PermissionsDelete Timesheets
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the timesheet.

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 timesheets

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"
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
    }
}