TRANXACT.AI Help

Talent & Contingent Workforce · Time & Money

Contractor Pay

What the worker is owed, and by which route. A worker on the payroll joins a real payroll run; an independent or corp-to-corp contractor is a real payable. Never both.

Type REST7 operationsBase path /api/ats/pay-recordsPublished as /api/v1/pay-records

Download specification (OpenAPI 3.1) Screen: Contractor Pay

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 Pay 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.pay_records · 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

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ats/pay-recordsList contractor pay

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",
      "pay_no": "PAY-000001",
      "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "timesheet_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "period_start": "2026-10-30",
      "period_end": "2026-10-30",
      "pay_route": "payroll",
      "currency": "USD",
      "hours": "1250.00",
      "gross_pay": "1250.00",
      "burden_amount": "1250.00",
      "total_cost": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ats/pay-records?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ats/pay-records/{id}Read one pay records

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",
  "pay_no": "PAY-000001",
  "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "timesheet_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "pay_route": "payroll",
  "currency": "USD",
  "hours": "1250.00",
  "gross_pay": "1250.00",
  "burden_amount": "1250.00",
  "total_cost": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/ats/pay-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/pay-recordsCreate a pay records

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
placement_iduuidYesPlacement
candidate_iduuidNoWorker
timesheet_iduuidNoTimesheet
period_startdateNoFrom
period_enddateNoTo
pay_routetextNoRoute
Allowed: payroll payable agency eor none
currencytextNoCurrency
hoursnumericNoHours
gross_paynumericNoGross pay
burden_amountnumericNoEmployer burden
statustextNoStatus
Allowed: draft approved posted paid void
supplier_iduuidNoPay to supplier
notestextNoNotes

Sample body

{
  "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "timesheet_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "pay_no": "PAY-000001",
  "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "timesheet_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "pay_route": "payroll",
  "currency": "USD",
  "hours": "1250.00",
  "gross_pay": "1250.00",
  "burden_amount": "1250.00",
  "total_cost": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ats/pay-records" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"placement_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","candidate_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","timesheet_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_start":"2026-10-30","period_end":"2026-10-30"}'
PUT/api/ats/pay-records/{id}Change a pay records

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
timesheet_iduuidNoTimesheet
period_startdateNoFrom
period_enddateNoTo
pay_routetextNoRoute
Allowed: payroll payable agency eor none
currencytextNoCurrency
hoursnumericNoHours
gross_paynumericNoGross pay
burden_amountnumericNoEmployer burden
statustextNoStatus
Allowed: draft approved posted paid void
supplier_iduuidNoPay to supplier
notestextNoNotes

Sample body

{
  "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "pay_no": "PAY-000001",
  "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "timesheet_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "pay_route": "payroll",
  "currency": "USD",
  "hours": "1250.00",
  "gross_pay": "1250.00",
  "burden_amount": "1250.00",
  "total_cost": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ats/pay-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"placement_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","candidate_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/ats/pay-records/{id}Delete a pay records

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/pay-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/pay-records/{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/pay-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/ats/pay-records/{id}/postPost

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):

supplierId*, invoiceDate, payDate, dueDate

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/pay-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplierId":"value","invoiceDate":"value","payDate":"value","dueDate":"value"}'

Data model

Every field of a pay records, 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
pay_notextread onlyPay no
placement_iduuidread, writePlacement
candidate_iduuidread, writeWorker
timesheet_iduuidread, writeTimesheet
period_startdateread, writeFrom
period_enddateread, writeTo
pay_routetextread, writeRoute
Allowed: payroll payable agency eor none
currencytextread, writeCurrency
hoursnumericread, writeHours
gross_paynumericread, writeGross pay
burden_amountnumericread, writeEmployer burden
total_costnumericread onlyTotal cost
statustextread, writeStatus
Allowed: draft approved posted paid void
supplier_iduuidread, writePay to supplier
ap_invoice_iduuidread onlyAp invoice id
payroll_run_iduuidread onlyPayroll run id
posted_attimestamp with time zoneread onlyPosted at
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 Pay 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.