Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Pay Codes

List Pay Codes

Lists pay codes available for a legal entity. Pay codes represent the allowed pay element types that can be submitted via POST /v1/pay-items/bulk.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage payroll runs (payroll)View pay items (pay_item:read)Manage pay items (pay_item:write)
get/v1/companies/{company_id}/legal-entities/{legal_entity_id}/pay-codes

Path parameters

company_idstring uuid required

Identifier of the employment being terminated.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Company ID

legal_entity_idstring uuid required

Identifier of the employment being terminated.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Legal entity ID

Query parameters

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "pay_codes": [
    {
      "category": "time_and_attendance",
      "code": "overtime",
      "description": "Hours worked beyond standard schedule",
      "external_import_code": null,
      "name": "Overtime",
      "slug": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "hours"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}