Payslip

These endpoints let you manage payslip features in the system. It allows you to generate, retrieve, and manage payslip records for employees.

Download Payslip

post

Download the payslip.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Body

paymentDatestring · dateRequired

typestringRequired

Responses

200

application/json

string · binaryOptional

400

Bad Request

post

/core/v1/employees/{id}/payslip

curl -X POST \
  "https://api.catapa.com/core/v1/employees/f47ac10b-58cc-4372-a567-0e02b2c3d479/payslip" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "paymentDate": "2020-01-25",
  "type": "SALARY"
}'

binary

Get Payslip Layouts

get

Search Query

Supported Keys

Supported Operators

Notes

section

Equal operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/payslip-layouts

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

{
  "content": [
    {
      "id": "673d457f-1975-434c-81a4-067f79345554",
      "html": "<!DOCTYPE html><html lang=\"en\" xmlns:th=\"http://www.thymeleaf.org\"></html>",
      "section": "MASTER",
      "effectiveDate": "2020-01-01"
    }
  ],
  "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
}

Create or Update Payslip Layout

put

Create or update the payslip layout.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

htmlstringRequired

sectionstringRequired

effectiveDatestringRequired

Responses

200

application/json

idstringOptional

htmlstringOptional

sectionstringOptional

effectiveDatestringOptional

400

Bad Request

put

/core/v1/payslip-layouts

curl -X PUT \
  "https://api.catapa.com/core/v1/payslip-layouts" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "html": "<!DOCTYPE html><html lang=\"en\" xmlns:th=\"http://www.thymeleaf.org\"></html>",
  "section": "MASTER",
  "effectiveDate": "2020-01-01"
}'

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "html": "<!DOCTYPE html><html lang=\"en\" xmlns:th=\"http://www.thymeleaf.org\"></html>",
  "section": "MASTER",
  "effectiveDate": "2020-01-01"
}

Get Payslip Layout by Id

get

Return the payslip layout by Id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

application/json

idstringOptional

htmlstringOptional

sectionstringOptional

effectiveDatestringOptional

400

Bad Request

get

/core/v1/payslip-layouts/{id}

curl -X GET \
  "https://api.catapa.com/core/v1/payslip-layouts/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "html": "<!DOCTYPE html><html lang=\"en\" xmlns:th=\"http://www.thymeleaf.org\"></html>",
  "section": "MASTER",
  "effectiveDate": "2020-01-01"
}

Delete Payslip Layout by Id

delete

Delete the payslip layout by Id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

application/json

anyOptional

400

Bad Request

delete

/core/v1/payslip-layouts/{id}

curl -X DELETE \
  "https://api.catapa.com/core/v1/payslip-layouts/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{}

Get Payslip Additional Notes

get

Search Query

Supported Keys

Supported Operators

Notes

paymentDate

Equal operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/payslip-additional-notes

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

{
  "content": [
    {
      "id": "673d457f-1975-434c-81a4-067f79345554",
      "paymentDate": "2022-01-15",
      "note": "This is note"
    }
  ],
  "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
}

Create Payslip Additional Note

post

Create a payslip additional note.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

paymentDatestringRequired

notestring · max: 150Required

Max length 150

Responses

200

application/json

idstringOptional

paymentDatestringOptional

notestringOptional

400

Bad Request

post

/core/v1/payslip-additional-notes

curl -X POST \
  "https://api.catapa.com/core/v1/payslip-additional-notes" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "paymentDate": "2022-01-15",
  "note": "This is note"
}'

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "paymentDate": "2022-01-15",
  "note": "This is note"
}

Update Payslip Additional Note by Id

put

Update the payslip additional note by Id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Body

paymentDatestringRequired

notestring · max: 150Required

Max length 150

Responses

200

application/json

idstringOptional

paymentDatestringOptional

notestringOptional

400

Bad Request

put

/core/v1/payslip-additional-notes/{id}

curl -X PUT \
  "https://api.catapa.com/core/v1/payslip-additional-notes/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "paymentDate": "2022-01-15",
  "note": "This is note"
}'

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "paymentDate": "2022-01-15",
  "note": "This is note"
}

Last updated 17 days ago

hashtagDownload Payslip

hashtagGet Payslip Layouts

hashtagSearch Query

hashtagCreate or Update Payslip Layout

hashtagGet Payslip Layout by Id

hashtagDelete Payslip Layout by Id

hashtagGet Payslip Additional Notes

hashtagSearch Query

hashtagCreate Payslip Additional Note

hashtagUpdate Payslip Additional Note by Id

Download Payslip

Get Payslip Layouts

Search Query

Create or Update Payslip Layout

Get Payslip Layout by Id

Delete Payslip Layout by Id

Get Payslip Additional Notes

Search Query

Create Payslip Additional Note

Update Payslip Additional Note by Id