Payroll Process Snapshot

These endpoints let you manage payroll process snapshots in the system. It allows you to retrieve, create, update, and delete payroll process snapshot records.

Get Payroll Process Snapshots

get

Get all payroll process snapshots

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
effectiveDate	< >	Greater than or equal to Less than or equal to
process	:	Equal to
employeeId	:	Equal to

Example: process:PAYROLL

Responses

200

Page of PayrollProcessSnapshotResponse

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/payroll-process-snapshots

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/payroll-process-snapshots?page=0&size=10&query=process%3APAYROLL" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "size": 20,
  "number": 0,
  "content": [
    {
      "employeeId": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
      "effectiveDate": "2024-01-01",
      "terminationDate": "2027-01-01",
      "employmentStatus": {
        "effectiveDate": "2024-01-01",
        "position": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "organization": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "location": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "subLocation": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "jobTitle": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "jobLevel": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "employmentType": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "operationalGroup": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "costCenter": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "company": {
          "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
        },
        "contractStart": "2024-01-01",
        "contractEnd": "2027-01-01",
        "permanentDate": "2024-01-01"
      },
      "kpp": {
        "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
      },
      "paygroup": {
        "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7",
        "code": "PG-001",
        "name": "Monthly Paygroup"
      },
      "payrollSequenceNumber": 1,
      "previousPayrollSequenceNumber": 0,
      "paymentItemGroup": {
        "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
      },
      "bankAccountConfiguration": {
        "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
      },
      "workflowActivities": []
    }
  ]
}