Talent & Contingent Workforce · Time & Money
Contractor Timesheets
Hours worked, priced at the rate in force on the day rather than at whatever is on the placement today. Approving one is the moment money becomes real.
/api/ats/timesheetsPublished as /api/v1/timesheetsDownload specification (OpenAPI 3.1) Screen: Contractor Timesheets
Overview
| Package | Talent & Contingent Workforce |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Talent & Contingent Workforce › Contractor Timesheets on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | ats.timesheets · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ats/timesheetsList contractor timesheets
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"timesheet_no": "TIM-000001",
"placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"regular_hours": "1250.00",
"overtime_hours": "1250.00",
"doubletime_hours": "1250.00",
"holiday_hours": "1250.00",
"pto_hours": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ats/timesheets?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ats/timesheets/{id}Read one timesheets
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"timesheet_no": "TIM-000001",
"placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"regular_hours": "1250.00",
"overtime_hours": "1250.00",
"doubletime_hours": "1250.00",
"holiday_hours": "1250.00",
"pto_hours": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/timesheetsCreate a timesheets
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
placement_id | uuid | Yes | Placement |
candidate_id | uuid | No | Worker |
client_id | uuid | No | Client |
work_order_id | uuid | No | Work order |
period_start | date | Yes | From |
period_end | date | Yes | To |
regular_hours | numeric | No | Regular hours |
overtime_hours | numeric | No | Overtime hours |
doubletime_hours | numeric | No | Double-time hours |
holiday_hours | numeric | No | Holiday hours |
pto_hours | numeric | No | Paid leave hours |
currency | text | No | Currency |
status | text | No | Status Allowed: draft submitted approved rejected invoiced paid void |
approver_name | text | No | Client approver |
rejection_reason | text | No | Rejection reason |
external_ref | text | No | Reference over there |
notes | text | No | Notes |
Sample body
{
"placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"regular_hours": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"timesheet_no": "TIM-000001",
"placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"regular_hours": "1250.00",
"overtime_hours": "1250.00",
"doubletime_hours": "1250.00",
"holiday_hours": "1250.00",
"pto_hours": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/timesheets" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"placement_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_start":"2026-10-30","period_end":"2026-10-30","candidate_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","client_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","work_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","regular_hours":"1250.00"}'PUT/api/ats/timesheets/{id}Change a timesheets
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
placement_id | uuid | Yes | Placement |
candidate_id | uuid | No | Worker |
client_id | uuid | No | Client |
work_order_id | uuid | No | Work order |
period_start | date | Yes | From |
period_end | date | Yes | To |
regular_hours | numeric | No | Regular hours |
overtime_hours | numeric | No | Overtime hours |
doubletime_hours | numeric | No | Double-time hours |
holiday_hours | numeric | No | Holiday hours |
pto_hours | numeric | No | Paid leave hours |
currency | text | No | Currency |
status | text | No | Status Allowed: draft submitted approved rejected invoiced paid void |
approver_name | text | No | Client approver |
rejection_reason | text | No | Rejection reason |
external_ref | text | No | Reference over there |
notes | text | No | Notes |
Sample body
{
"placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_start": "2026-10-30"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"timesheet_no": "TIM-000001",
"placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"regular_hours": "1250.00",
"overtime_hours": "1250.00",
"doubletime_hours": "1250.00",
"holiday_hours": "1250.00",
"pto_hours": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"placement_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_start":"2026-10-30"}'DELETE/api/ats/timesheets/{id}Delete a timesheets
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/timesheets/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/ats/timesheets/{parentId}/entriesEntries
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/entries" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/timesheets/{parentId}/entriesEntries
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/entries" \
-H "Authorization: Bearer $TOKEN"PUT/api/ats/timesheets/{parentId}/entries/{lineId}Entries
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/ats/timesheets/{parentId}/entries/{lineId}Entries
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/entries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/timesheets/{id}/submitSubmit
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/timesheets/{id}/approveApprove
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrideBudget, approverNameResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrideBudget":"value","approverName":"value"}'POST/api/ats/timesheets/{id}/rejectReject
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reason*Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reject" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/ats/timesheets/{id}/payPay
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/timesheets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pay" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a timesheets, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
timesheet_no | text | read only | Timesheet no |
placement_id | uuid | read, write | Placement |
candidate_id | uuid | read, write | Worker |
client_id | uuid | read, write | Client |
work_order_id | uuid | read, write | Work order |
period_start | date | read, write | From |
period_end | date | read, write | To |
regular_hours | numeric | read, write | Regular hours |
overtime_hours | numeric | read, write | Overtime hours |
doubletime_hours | numeric | read, write | Double-time hours |
holiday_hours | numeric | read, write | Holiday hours |
pto_hours | numeric | read, write | Paid leave hours |
total_hours | numeric | read only | Total hours |
currency | text | read, write | Currency |
bill_amount | numeric | read only | Bill amount |
pay_amount | numeric | read only | Pay amount |
margin_amount | numeric | read only | Margin amount |
status | text | read, write | Status Allowed: draft submitted approved rejected invoiced paid void |
submitted_at | timestamp with time zone | read only | Submitted at |
submitted_by | uuid | read only | Submitted by |
approved_at | timestamp with time zone | read only | Approved at |
approved_by | uuid | read only | Approved by |
approver_name | text | read, write | Client approver |
rejection_reason | text | read, write | Rejection reason |
invoice_id | uuid | read only | Invoice id |
hr_timesheet_id | uuid | read only | Hr timesheet id |
external_ref | text | read, write | Reference over there |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Talent & Contingent Workforce › Contractor Timesheets for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.