Payment Item Group Sequence

These endpoints let you manage payment item group sequences for employees. It allows you to retrieve sequences related to payment item groups (or payroll processes). This is useful for payroll processing and ensuring accurate payment calculations. It is created after a payroll process is completed, and it is used to track the sequence of payment item groups for each employee.

Get Last Payment Item Group Sequence

get

Return the last payment item group sequence.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Responses

200

OK

application/json

employeeIdstringOptional

lastSequenceintegerOptional

400

Bad Request

get

/core/v1/employees/{employeeId}/payment-item-groups/last-sequence

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/payment-item-groups/last-sequence" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "employeeId": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
  "lastSequence": 10
}

Get Payment Item Group Sequences

get

Return the payment item group sequences.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

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
id	:	Equal operator
employee.id	:	Equal operator
paymentItemGroup.paymentType	:	Equal operator (REGULAR_SALARY / SEVERANCE / RETROACTIVE / ADDITIONAL_INCOME)
payrollSequenceNumber	:	Equal operator

Example: {"summary":"Search by Payment Item Group ID","value":"id:e18f5618-bc6c-11e6-80f5-76304dec7eb1"}

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/employees/{employeeId}/payment-item-groups/sequences

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/payment-item-groups/sequences?page=0&size=10&query=id%3Ae18f5618-bc6c-11e6-80f5-76304dec7eb1" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "employeeId": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
      "paymentItemGroupId": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
      "sequence": 10,
      "previousSequence": 2
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}