Paygroup

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

Get Paygroups

get

Search Query

Supported Keys	Supported Operators	Notes
code	:	Equal
defaultPaygroup	:	boolean

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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/paygroups

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/paygroups" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "cutoffType": "MONTHLY",
      "cutoffDayOfWeek": "NONE",
      "id": "812a74bc-7fa4-4c6f-8d3d-25d3a3f17845",
      "code": "findedPaygroup",
      "dailyCutoffDate": 25,
      "dailyCutoffBase": "CURRENT_MONTH",
      "defaultPaygroup": false,
      "name": "findedPaygroup",
      "monthlyCutoffDate": 25
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 1,
  "totalElements": 1,
  "last": true,
  "sort": [],
  "first": true,
  "empty": true
}