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
chevron-right
200

OK

application/json
string · binaryOptional
post
/core/v1/employees/{id}/payslip

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
chevron-right
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)

get
/core/v1/payslip-layouts

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
chevron-right
200

OK

application/json
idstringOptional
htmlstringOptional
sectionstringOptional
effectiveDatestringOptional
put
/core/v1/payslip-layouts

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
chevron-right
200

OK

application/json
idstringOptional
htmlstringOptional
sectionstringOptional
effectiveDatestringOptional
get
/core/v1/payslip-layouts/{id}

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
chevron-right
200

OK

application/json
anyOptional
delete
/core/v1/payslip-layouts/{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
chevron-right
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)

get
/core/v1/payslip-additional-notes

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
chevron-right
200

OK

application/json
idstringOptional
paymentDatestringOptional
notestringOptional
post
/core/v1/payslip-additional-notes

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
chevron-right
200

OK

application/json
idstringOptional
paymentDatestringOptional
notestringOptional
put
/core/v1/payslip-additional-notes/{id}

Last updated