Salary Calculation

These endpoints let you manage salary calculations in the system. It allows you to perform salary calculations based on various parameters and settings.

Get Salary Calculation

get

Search Query

Supported Keys	Supported Operators	Notes
id	:	Equal
month	:	Equal
year	:	Equal
salaryPaymentProcess	:	Equal

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-calculations

cURLPython SDK

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

{
  "content": [
    {
      "costCenterCode": "string",
      "dailyWorkdayEndDate": "2023-02-25",
      "dailyWorkdayStartDate": "2023-01-26",
      "employeeId": "string",
      "employeeIdentificationNumber": "string",
      "employeeName": "string",
      "employeeWorkday": 30,
      "id": "string",
      "locationGroupCode": "string",
      "normalWorkday": 30,
      "previousPeriodEmployeeWorkday": 30,
      "previousPeriodNormalWorkday": 30
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}

Get Salary Calculation Details

get

Search Query

Supported Keys	Supported Operators	Notes
salaryCalculationId	:	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-calculations/details

cURLPython SDK

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

{
  "content": [
    {
      "amount": 0,
      "id": "string",
      "salaryItemCategory": "INCOME",
      "salaryItemCode": "string",
      "salaryItemName": "string",
      "salaryItemType": "INDIVIDUAL",
      "thp": true
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}

Get Time Allowance Details By Salary Calculation Detail

get

Return the time allowance details for the salary calculation detail.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

Responses

200

OK

application/json

400

Bad Request

get

/core/v1/salary-calculations/details/{id}/time-allowance-details

cURLPython SDK

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

{
  "salaryCalculationDetail": {
    "id": "string"
  },
  "timeAllowanceDetails": [
    {
      "amount": 0,
      "date": "string"
    }
  ]
}