Employee Salary Template

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

Get Latest Employee Salary Template

get

Return the latest employee salary templates.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

Responses

200

OK

application/json

idstringOptional

effectiveDatestringOptional

proportionalbooleanOptional

retroactivebooleanOptional

salaryDecreeNumberstringOptional

salaryTemplateIdstringOptional

400

Bad Request

get

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

cURLPython SDK

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

{
  "id": "find-public-employee-salary-template",
  "effectiveDate": "2019-06-01",
  "employeeSalaries": [
    {
      "salaryItemId": "find-public-employee-salary-template",
      "salaryItemCode": "INDI5",
      "amount": 4000000,
      "recurringConfiguration": {
        "monthInterval": 1,
        "recurringEndType": "NEVER",
        "recurringPeriodEnd": {
          "year": 0,
          "month": 0
        },
        "maxRecurringTimes": 0
      }
    }
  ],
  "proportional": false,
  "retroactive": false,
  "salaryDecreeNumber": "SK/DIR/2/SIEA",
  "salaryTemplateId": "find-public-employee-salary-template"
}

Create or Update Employee Salary Template

patch

Create or update the employee salary template.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

<employee.id> or identificationNumber=<employee.identificationNumber>

Example: {"summary":"Using <employee.id>","value":"c2424497-9c63-46d1-88e4-6b4ebe399866"}

Body

application/json

effectiveDatestringRequired

proportionalbooleanRequired

retroactivebooleanRequired

salaryDecreeNumberstringRequired

salaryTemplateIdstringRequired

Responses

200

OK

application/json

employeeIdstringOptional

400

Bad Request

patch

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

cURLPython SDK

curl -X PATCH \
  "https://api.catapa.com/core/v1/employees/c2424497-9c63-46d1-88e4-6b4ebe399866/employee-salary-templates" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "effectiveDate": "string",
  "employeeSalaries": [
    {
      "amount": 0,
      "formula": "string",
      "recurringConfiguration": {
        "maxRecurringTimes": 0,
        "periodInterval": 1,
        "recurringEndType": "NEVER",
        "recurringPeriodEnd": {
          "month": 1,
          "year": 1970
        }
      },
      "salaryItemId": "string"
    }
  ],
  "proportional": true,
  "retroactive": true,
  "salaryDecreeNumber": "string",
  "salaryTemplateId": "string"
}'

{
  "employeeId": "public-employee-salary-template"
}

Get Effective Employee Salary Template

get

Return the effective employee salary template.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

Query parameters

yearnumberOptionalExample: 2024

monthnumberOptionalExample: 1

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/employees/{id}/employee-salary-templates/effective

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employees/f47ac10b-58cc-4372-a567-0e02b2c3d479/employee-salary-templates/effective?year=2024&month=1" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "find-public-employee-salary-template",
      "effectiveDate": "2019-06-01",
      "employeeSalaries": [
        {
          "salaryItemId": "find-public-employee-salary-template",
          "salaryItemCode": "INDI5",
          "amount": 4000000,
          "recurringConfiguration": {
            "monthInterval": 1,
            "recurringEndType": "NEVER",
            "recurringPeriodEnd": {
              "year": 0,
              "month": 0
            },
            "maxRecurringTimes": 0
          }
        }
      ],
      "proportional": false,
      "retroactive": false,
      "salaryDecreeNumber": "SK/DIR/2/SIEA",
      "salaryTemplateId": "find-public-employee-salary-template"
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}