TRANXACT.AI Help

HRMS · Records

Comp cycle status

Read and maintain comp cycle status records (hr.comp_cycle_status).

Type REST6 operationsBase path /api/hrms/comp-cycle-statusPublished as /api/v1/comp-cycle-status

Download specification (OpenAPI 3.1)

Overview

PackageHRMS
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 HRMS › Comp cycle status 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.
Tablehr.comp_cycle_status · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/hrms/comp-cycle-statusList comp cycle status

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",
      "code": "COD-000001",
      "name": "Example",
      "cycle_type": "text",
      "plan_year": 10,
      "effective_date": "2026-10-30",
      "status": "draft",
      "budget_percent": "1250.00",
      "budget_amount": "1250.00",
      "eligible_pay_bill": "1250.00",
      "proposed": "1250.00",
      "approved": "1250.00",
      "remaining": "1250.00",
      "awards": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/comp-cycle-status?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/comp-cycle-status/{id}Read one comp cycle status

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "cycle_type": "text",
  "plan_year": 10,
  "effective_date": "2026-10-30",
  "status": "draft",
  "budget_percent": "1250.00",
  "budget_amount": "1250.00",
  "eligible_pay_bill": "1250.00",
  "proposed": "1250.00",
  "approved": "1250.00",
  "remaining": "1250.00",
  "awards": 10
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/comp-cycle-status/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/comp-cycle-statusPost comp cycle status

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

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 PUT "https://demo.tranxact.ai/api/hrms/comp-cycle-status/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/comp-cycle-status/{id}Delete comp cycle status

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 DELETE "https://demo.tranxact.ai/api/hrms/comp-cycle-status/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a comp cycle status, 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
codetextread onlyCode
nametextread onlyName
cycle_typetextread onlyCycle type
plan_yearintegerread onlyPlan year
effective_datedateread onlyEffective date
statustextread onlyStatus
budget_percentnumericread onlyBudget percent
budget_amountnumericread onlyBudget amount
eligible_pay_billnumericread onlyEligible pay bill
proposednumericread onlyProposed
approvednumericread onlyApproved
remainingnumericread onlyRemaining
awardsintegerread onlyAwards
above_guidelineintegerread onlyAbove guideline
standingtextread onlyStanding

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 HRMS › Comp cycle status 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.