Employee Paygroup

These endpoints let you manage paygroups specific to employees in the system. It allows you to retrieve, create, update, and delete employee-specific paygroup records.

Get Employee Paygroups

get

Return the employee paygroups.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
employee.id	:	Equal operator with multiple values. Each value should separated with delimiters ;
effectiveDate	> < =	Equal operator Greater than or equal operator Less than or equal operator Use the YYYY-MM-DD format, e.g. effectiveDate>2023-09-20

Example: effectiveDate>2023-09-20

Responses

200

OK

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/employee-paygroups

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employee-paygroups?page=0&size=10&query=effectiveDate%3E2023-09-20" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "fb1fc36c-6714-490c-aadb-5869e27e7bfe",
      "updatedDate": 1718000000000,
      "employee": {
        "id": "ad988ae3-2aa9-456d-93e5-a3974b4ee2f1",
        "identificationNumber": "EMP123456",
        "name": "John Doe",
        "active": true
      },
      "paygroup": {
        "id": "061aa34e-3c3c-4b1d-a627-78e79bbf6ce8",
        "code": "PG01",
        "name": "Monthly Payroll"
      },
      "effectiveDate": "2024-06-10"
    }
  ],
  "totalPages": 11,
  "last": false,
  "totalElements": 11,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 1,
  "number": 0
}

Get Employee Paygroup by Id

get

Return the employee paygroup by Id.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: fb1fc36c-6714-490c-aadb-5869e27e7bfe

Responses

200

OK

application/json

idstringOptional

updatedDateinteger · timestamp in millisecondsOptional

effectiveDatestring · dateOptional

400

Bad Request

get

/core/v1/employee-paygroups/{id}

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employee-paygroups/fb1fc36c-6714-490c-aadb-5869e27e7bfe" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "fb1fc36c-6714-490c-aadb-5869e27e7bfe",
  "updatedDate": 1718000000000,
  "employee": {
    "id": "ad988ae3-2aa9-456d-93e5-a3974b4ee2f1",
    "identificationNumber": "EMP123456",
    "name": "John Doe",
    "active": true
  },
  "paygroup": {
    "id": "061aa34e-3c3c-4b1d-a627-78e79bbf6ce8",
    "code": "PG01",
    "name": "Monthly Payroll"
  },
  "effectiveDate": "2024-06-10"
}