Former Employee Income

These endpoints let you manage former employee income features in the system. It allows you to retrieve former employee income configurations, calculate related contributions, and manage former employee income records.

Get Former Employee Income Employee

get

Search Query

Supported Keys	Supported Operators	Notes
paymentDate	: > <	Equal operator Greater than or equal to operator Less than or equal to equal operator
paid	:	Equal 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/former-employee-income-employees

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/former-employee-income-employees" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
      "formerEmployeeIncome": {
        "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
        "itemName": "Bonus",
        "itemType": "EDITABLE",
        "referenceDate": "2020-01-01",
        "pph21Method": "GROSS",
        "minimumLastWorkingDate": "2020-01-01",
        "proportionalMethod": "BY_MONTH",
        "proportionalDays": 28,
        "formula": ""
      },
      "employee": {
        "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
        "identificationNumber": "id-01",
        "name": "Employee Name"
      },
      "amount": 700000,
      "lastWorkingDate": "2020-01-01",
      "paymentDate": "2020-01-01",
      "paymentMethod": "TRANSFER",
      "totalThp": 600000,
      "originalTax": 100000,
      "penaltyTax": 0,
      "taxAllowance": 0
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 1,
  "totalElements": 1,
  "last": true,
  "sort": [],
  "first": true,
  "empty": true
}

Get Former Employee Incomes

get

Search Query

Supported Keys	Supported Operators	Notes
itemName	:	Like operator
itemType	:	Equal operator
referenceDate	: > <	Equal operator Greater than or equal to operator Less than or equal to equal operator
pph21Method	:	Equal operator
minimumLastWorkingDate	: > <	Equal operator Greater than or equal to operator Less than or equal to equal operator
proportionalMethod	:	Equal 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/former-employee-incomes

cURLPython SDK

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

{
  "content": [
    {
      "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
      "itemName": "Bonus",
      "itemType": "EDITABLE",
      "referenceDate": "2020-01-01",
      "pph21Method": "GROSS",
      "minimumLastWorkingDate": "2020-01-01",
      "proportionalMethod": "BY_MONTH",
      "proportionalDays": 28,
      "formula": ""
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 1,
  "totalElements": 1,
  "last": true,
  "sort": [],
  "first": true,
  "empty": true
}

Get Former Employee Income Employee By Former Employee Income Id

get

Search Query

Supported Keys	Supported Operators	Notes
paymentDate	: > <	Equal operator Greater than or equal to operator Less than or equal to equal operator
paid	:	Equal operator

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

formerEmployeeIncomeIdstringRequiredExample: d4e5f6a7-b8c9-0123-def0-12345678901c

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/former-employee-incomes/{formerEmployeeIncomeId}/former-employee-income-employees

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/former-employee-incomes/d4e5f6a7-b8c9-0123-def0-12345678901c/former-employee-income-employees" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
      "formerEmployeeIncome": {
        "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
        "itemName": "Bonus",
        "itemType": "EDITABLE",
        "referenceDate": "2020-01-01",
        "pph21Method": "GROSS",
        "minimumLastWorkingDate": "2020-01-01",
        "proportionalMethod": "BY_MONTH",
        "proportionalDays": 28,
        "formula": ""
      },
      "employee": {
        "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
        "identificationNumber": "id-01",
        "name": "Employee Name"
      },
      "amount": 700000,
      "lastWorkingDate": "2020-01-01",
      "paymentDate": "2020-01-01",
      "paymentMethod": "TRANSFER",
      "totalThp": 600000,
      "originalTax": 100000,
      "penaltyTax": 0,
      "taxAllowance": 0
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 1,
  "totalElements": 1,
  "last": true,
  "sort": [],
  "first": true,
  "empty": true
}

Update Former Employee Income Employee By Former Employee Income Id

put

Update the former employee income employee amounts by former employee income id.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

formerEmployeeIncomeIdstringRequiredExample: d4e5f6a7-b8c9-0123-def0-12345678901c

Bodyobject[]

application/json

idstringRequired

Employee income ID

amountnumberRequired

Updated amount

Responses

200

OK

application/json

anyOptional

400

Bad Request

put

/core/v1/former-employee-incomes/{formerEmployeeIncomeId}/former-employee-income-employees/amounts

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/former-employee-incomes/d4e5f6a7-b8c9-0123-def0-12345678901c/former-employee-income-employees/amounts" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
    "amount": 9000000
  },
  {
    "id": "90f537af-83b2-4a8b-851c-5d14ec046554",
    "amount": 1000000
  }
]'

{}

Get Former Employee Income by Id

get

Return the former employee income 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

idstringOptional

Former employee income ID

itemNamestringOptional

Income item name

itemTypestringOptional

Income item type

referenceDatestring · dateOptional

Reference date

pph21MethodstringOptional

PPH21 calculation method

minimumLastWorkingDatestring · dateOptional

Minimum last working date

proportionalMethodstringOptional

Proportional calculation method

proportionalDaysintegerOptional

Number of proportional days

formulastringOptional

Calculation formula

400

Bad Request

get

/core/v1/former-employee-incomes/{id}

cURLPython SDK

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

{
  "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
  "itemName": "Bonus",
  "itemType": "EDITABLE",
  "referenceDate": "2020-01-01",
  "pph21Method": "GROSS",
  "minimumLastWorkingDate": "2020-01-01",
  "proportionalMethod": "BY_MONTH",
  "proportionalDays": 28,
  "formula": ""
}