Salary Template

These endpoints let you manage salary templates in the system. It allows you to retrieve, create, update, and delete salary template records.

Get Salary Item Add On

get

Return the salary item add-on.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

employeeIdentificationNumberstringRequiredExample: EMP-2024-001

datestringRequiredExample: 2024-01-01

salaryItemCodestringRequiredExample: BASIC_SALARY

Responses

200

OK

application/json

amountnumberOptional

datestringOptional

salaryCalculationProcessedbooleanOptional

400

Bad Request

get

/core/v1/salary-item-add-on

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/salary-item-add-on?employeeIdentificationNumber=EMP-2024-001&date=2024-01-01&salaryItemCode=BASIC_SALARY" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "amount": 0,
  "date": "string",
  "employee": {
    "identificationNumber": "string",
    "name": "string"
  },
  "salaryCalculationProcessed": true,
  "salaryItem": {
    "code": "string",
    "name": "string"
  }
}

Update Salary Item Add On

put

Update the salary item add-on.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

amountnumberRequired

datestringRequired

Responses

200

OK

application/json

amountnumberOptional

datestringOptional

salaryCalculationProcessedbooleanOptional

400

Bad Request

put

/core/v1/salary-item-add-on

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/salary-item-add-on" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 0,
  "date": "string",
  "employee": {
    "identificationNumber": "string"
  },
  "salaryItem": {
    "code": "string"
  }
}'

{
  "amount": 0,
  "date": "string",
  "employee": {
    "identificationNumber": "string",
    "name": "string"
  },
  "salaryCalculationProcessed": true,
  "salaryItem": {
    "code": "string",
    "name": "string"
  }
}

Delete Salary Item Add On

delete

Delete the salary item add-on.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

employeeIdentificationNumberstringRequiredExample: EMP-2024-001

datestringRequiredExample: 2024-01-01

salaryItemCodestringRequiredExample: BASIC_SALARY

Responses

200

OK

application/json

anyOptional

400

Bad Request

delete

/core/v1/salary-item-add-on

cURLPython SDK

curl -X DELETE \
  "https://api.catapa.com/core/v1/salary-item-add-on?employeeIdentificationNumber=EMP-2024-001&date=2024-01-01&salaryItemCode=BASIC_SALARY" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{}

Add Salary Item Add On

put

Add a salary item add-on.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

amountnumberRequired

datestringRequired

Responses

200

OK

application/json

amountnumberOptional

datestringOptional

salaryCalculationProcessedbooleanOptional

400

Bad Request

put

/core/v1/salary-item-add-on/add

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/salary-item-add-on/add" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 0,
  "date": "string",
  "employee": {
    "identificationNumber": "string"
  },
  "salaryItem": {
    "code": "string"
  }
}'

{
  "amount": 0,
  "date": "string",
  "employee": {
    "identificationNumber": "string",
    "name": "string"
  },
  "salaryCalculationProcessed": true,
  "salaryItem": {
    "code": "string",
    "name": "string"
  }
}

Subtract Salary Item Add On

put

Subtract a salary item add-on.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

amountnumberRequired

datestringRequired

Responses

200

OK

application/json

anyOptional

400

Bad Request

put

/core/v1/salary-item-add-on/subtract

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/salary-item-add-on/subtract" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 0,
  "date": "string",
  "employee": {
    "identificationNumber": "string"
  },
  "salaryItem": {
    "code": "string"
  }
}'

{}

Get Salary Templates

get

Search Query

Supported Keys	Supported Operators	Notes
code	:	Like operator
name	:	Like operator

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/salary-templates

cURLPython SDK

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

{
  "content": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "code": "string",
      "name": "string",
      "salaryTemplateDetails": [
        {
          "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
          "salaryItem": {
            "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c9",
            "code": "string",
            "name": "string"
          }
        }
      ]
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}

Get Salary Template by Id

get

Return the salary template by Id.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

Responses

200

OK

application/json

idstring · uuidOptional

codestringOptional

namestringOptional

400

Bad Request

get

/core/v1/salary-templates/{id}

cURLPython SDK

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "code": "string",
  "name": "string",
  "salaryTemplateDetails": [
    {
      "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "salaryItem": {
        "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c9",
        "code": "string",
        "name": "string"
      }
    }
  ]
}