TRANXACT.AI Help

HRMS · Saudi Payroll

GOSI Rates

What GOSI takes, from whom and from when. A Saudi registered before 3 July 2024 pays 9.75% and the employer 11.75%; one registered since is on the new law’s rising annuity rate; for anybody else the employer pays 2% occupational hazards. On basic + housing, at least SAR 1,500 and at most SAR 45,000 a month.

Type REST6 operationsBase path /api/hrms/gosi-ratesPublished as /api/v1/gosi-rates

Download specification (OpenAPI 3.1) Screen: GOSI Rates

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 › GOSI Rates 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.gosi_rates · 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

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

GET/api/hrms/gosi-ratesList gosi rates

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",
      "rate_set": "saudi — Saudi registered before 3 July 2024",
      "effective_from": "2026-10-30",
      "annuity_employee_pct": "1250.00",
      "annuity_employer_pct": "1250.00",
      "saned_employee_pct": "1250.00",
      "saned_employer_pct": "1250.00",
      "hazards_employer_pct": "1250.00",
      "wage_floor": "1250.00",
      "wage_cap": "1250.00",
      "notes": "text",
      "is_active": true,
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "rate_set": "saudi — Saudi registered before 3 July 2024",
  "effective_from": "2026-10-30",
  "annuity_employee_pct": "1250.00",
  "annuity_employer_pct": "1250.00",
  "saned_employee_pct": "1250.00",
  "saned_employer_pct": "1250.00",
  "hazards_employer_pct": "1250.00",
  "wage_floor": "1250.00",
  "wage_cap": "1250.00",
  "notes": "text",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/gosi-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/gosi-ratesCreate a gosi rates

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
rate_settextYesWho it applies to
Allowed: saudi — Saudi registered before 3 July 2024 saudi_new — Saudi first registered on or after 3 July 2024 non_saudi — anybody else
effective_fromdateYesFrom
annuity_employee_pctnumericNoAnnuities, employee %
annuity_employer_pctnumericNoAnnuities, employer %
saned_employee_pctnumericNoSANED, employee %
saned_employer_pctnumericNoSANED, employer %
hazards_employer_pctnumericNoOccupational hazards, employer %
wage_floornumericNoLowest contributory wage (SAR a month)
wage_capnumericNoHighest contributory wage (SAR a month)
notestextNoNotes
is_activebooleanNoActive

Sample body

{
  "rate_set": "saudi — Saudi registered before 3 July 2024",
  "effective_from": "2026-10-30",
  "annuity_employee_pct": "1250.00",
  "annuity_employer_pct": "1250.00",
  "saned_employee_pct": "1250.00",
  "saned_employer_pct": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_set": "saudi — Saudi registered before 3 July 2024",
  "effective_from": "2026-10-30",
  "annuity_employee_pct": "1250.00",
  "annuity_employer_pct": "1250.00",
  "saned_employee_pct": "1250.00",
  "saned_employer_pct": "1250.00",
  "hazards_employer_pct": "1250.00",
  "wage_floor": "1250.00",
  "wage_cap": "1250.00",
  "notes": "text",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/gosi-rates" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rate_set":"saudi — Saudi registered before 3 July 2024","effective_from":"2026-10-30","annuity_employee_pct":"1250.00","annuity_employer_pct":"1250.00","saned_employee_pct":"1250.00","saned_employer_pct":"1250.00"}'
PUT/api/hrms/gosi-rates/{id}Change a gosi rates

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
rate_settextYesWho it applies to
Allowed: saudi — Saudi registered before 3 July 2024 saudi_new — Saudi first registered on or after 3 July 2024 non_saudi — anybody else
effective_fromdateYesFrom
annuity_employee_pctnumericNoAnnuities, employee %
annuity_employer_pctnumericNoAnnuities, employer %
saned_employee_pctnumericNoSANED, employee %
saned_employer_pctnumericNoSANED, employer %
hazards_employer_pctnumericNoOccupational hazards, employer %
wage_floornumericNoLowest contributory wage (SAR a month)
wage_capnumericNoHighest contributory wage (SAR a month)
notestextNoNotes
is_activebooleanNoActive

Sample body

{
  "rate_set": "saudi — Saudi registered before 3 July 2024",
  "effective_from": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_set": "saudi — Saudi registered before 3 July 2024",
  "effective_from": "2026-10-30",
  "annuity_employee_pct": "1250.00",
  "annuity_employer_pct": "1250.00",
  "saned_employee_pct": "1250.00",
  "saned_employer_pct": "1250.00",
  "hazards_employer_pct": "1250.00",
  "wage_floor": "1250.00",
  "wage_cap": "1250.00",
  "notes": "text",
  "is_active": true,
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/gosi-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rate_set":"saudi — Saudi registered before 3 July 2024","effective_from":"2026-10-30"}'
DELETE/api/hrms/gosi-rates/{id}Delete a gosi rates

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

Data model

Every field of a gosi rates, 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
rate_settextread, writeWho it applies to
Allowed: saudi — Saudi registered before 3 July 2024 saudi_new — Saudi first registered on or after 3 July 2024 non_saudi — anybody else
effective_fromdateread, writeFrom
annuity_employee_pctnumericread, writeAnnuities, employee %
annuity_employer_pctnumericread, writeAnnuities, employer %
saned_employee_pctnumericread, writeSANED, employee %
saned_employer_pctnumericread, writeSANED, employer %
hazards_employer_pctnumericread, writeOccupational hazards, employer %
wage_floornumericread, writeLowest contributory wage (SAR a month)
wage_capnumericread, writeHighest contributory wage (SAR a month)
notestextread, writeNotes
is_activebooleanread, writeActive
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 HRMS › GOSI Rates 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.