TRANXACT.AI Help

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.

Type REST14 operationsBase path /api/ats/timesheetsPublished as /api/v1/timesheets

Download specification (OpenAPI 3.1) Screen: Contractor Timesheets

Overview

PackageTalent & Contingent Workforce
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableats.timesheets · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
placement_iduuidYesPlacement
candidate_iduuidNoWorker
client_iduuidNoClient
work_order_iduuidNoWork order
period_startdateYesFrom
period_enddateYesTo
regular_hoursnumericNoRegular hours
overtime_hoursnumericNoOvertime hours
doubletime_hoursnumericNoDouble-time hours
holiday_hoursnumericNoHoliday hours
pto_hoursnumericNoPaid leave hours
currencytextNoCurrency
statustextNoStatus
Allowed: draft submitted approved rejected invoiced paid void
approver_nametextNoClient approver
rejection_reasontextNoRejection reason
external_reftextNoReference over there
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
placement_iduuidYesPlacement
candidate_iduuidNoWorker
client_iduuidNoClient
work_order_iduuidNoWork order
period_startdateYesFrom
period_enddateYesTo
regular_hoursnumericNoRegular hours
overtime_hoursnumericNoOvertime hours
doubletime_hoursnumericNoDouble-time hours
holiday_hoursnumericNoHoliday hours
pto_hoursnumericNoPaid leave hours
currencytextNoCurrency
statustextNoStatus
Allowed: draft submitted approved rejected invoiced paid void
approver_nametextNoClient approver
rejection_reasontextNoRejection reason
external_reftextNoReference over there
notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, approverName

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/approve" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrideBudget":"value","approverName":"value"}'
POST/api/ats/timesheets/{id}/rejectReject

Path parameters

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
timesheet_notextread onlyTimesheet no
placement_iduuidread, writePlacement
candidate_iduuidread, writeWorker
client_iduuidread, writeClient
work_order_iduuidread, writeWork order
period_startdateread, writeFrom
period_enddateread, writeTo
regular_hoursnumericread, writeRegular hours
overtime_hoursnumericread, writeOvertime hours
doubletime_hoursnumericread, writeDouble-time hours
holiday_hoursnumericread, writeHoliday hours
pto_hoursnumericread, writePaid leave hours
total_hoursnumericread onlyTotal hours
currencytextread, writeCurrency
bill_amountnumericread onlyBill amount
pay_amountnumericread onlyPay amount
margin_amountnumericread onlyMargin amount
statustextread, writeStatus
Allowed: draft submitted approved rejected invoiced paid void
submitted_attimestamp with time zoneread onlySubmitted at
submitted_byuuidread onlySubmitted by
approved_attimestamp with time zoneread onlyApproved at
approved_byuuidread onlyApproved by
approver_nametextread, writeClient approver
rejection_reasontextread, writeRejection reason
invoice_iduuidread onlyInvoice id
hr_timesheet_iduuidread onlyHr timesheet id
external_reftextread, writeReference over there
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Talent & Contingent Workforce › Contractor Timesheets for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.