Introduction
The Talenox API is organized around REST. The APIs are predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
Talenox API token
You can obtain the Talenox API token via the website https://app.talenox.com. Head over to the top right nav bar -> API setting.
Difference of V2 from V1
V1 authenticates requests by checking for API token in URL, V2 moved the token into Authorization request header.
Aside from authentication mechanism, V2 is functionally identical to V1. They are using the same underlying implementation.
OAuth 2.0
Introduction
Talenox supports using OAuth 2.0 to grant third-party systems to access Talenox resources. With OAuth 2.0 application, users are able to define their own permission for accessing the resources.
Where to find and create
Follow these steps to create OAuth 2.0 application for your company:
Log into Talenox https://app.talenox.com
At the top right nav > API Settings, there is a link to the OAuth 2.0 developer page
Create the OAuth 2.0 application by providing Application Name, Redirect URI, Origin URI (Optional) and Scopes
Usage
Direct the user to
https://app.talenox.com/oauth/authorize?client_id=<client ID>&redirect_uri=<redirect URI>&scope=<scope>&response_type=codeAfter the user login and authorize the access, it will be redirect back to the Redirect URI with the code
To obtain the Access Token, with the code from the previous step, make a POST request to
https://app.talenox.com/oauth/token?grant_type=authorization_code&code=<code>&client_id=<client ID>&client_secret=<client secret>&redirect_uri=<redirect URI>The Access Token is valid for 30 minutes. To refresh the Access Token, make a POST to
https://app.talenox.com/oauth/token?grant_type=refresh_token&code=<access code>&refresh_token=<refresh token>&client_id=<client ID>&client_secret=<client secret>&redirect_uri=<redirect URI>
Branches
Create Branch
Request
Endpoint
POST https://api.talenox.com/api/v2/branches
Accept: application/json
Content-Type: application/json
Authorization: Bearer 527804e11f5fd4d9c62813cf95235927485b3b35
POST https://api.talenox.com/api/v2/branches
Parameters
{
"branch": {
"name": "Sample Branch",
"address": "42048 Minh Plains",
"postcode": "55624-1280",
"head_id": 504,
"employee_ids": [
510,
511,
504,
505
]
}
}
| Name | Description |
|---|---|
| name required | Name of Branch |
| address | Address |
| postcode | Postcode |
| head_id | Branch Head (Should be an Employee ID) |
| employee_ids | Employee IDs (If specified, will override the existing employees in the branch). |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 553,
"name": "Sample Branch",
"employee_ids": [
510,
511,
504,
505
],
"no_of_employees": 4,
"address": "42048 Minh Plains",
"postcode": "55624-1280",
"head_id": 504
}
Delete Branch
Request
Endpoint
DELETE https://api.talenox.com/api/v2/branches/598
Accept: application/json
Content-Type: application/json
Authorization: Bearer b024af8db4337b1465771778b343726f6dbb1900
DELETE https://api.talenox.com/api/v2/branches/:id
Parameters
| Name | Description |
|---|---|
| id required | Branch ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted branch 598"
}
List Branches
Request
Endpoint
GET https://api.talenox.com/api/v2/branches
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6e21426a725441b67ce30d1abf1b0fe173fef318
GET https://api.talenox.com/api/v2/branches
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 523,
"name": "Default",
"employee_ids": [],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 524,
"name": "South Lynn",
"employee_ids": [
491
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 525,
"name": "Malisastad",
"employee_ids": [
492
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 526,
"name": "Port Ian",
"employee_ids": [
493
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 527,
"name": "South Moriahhaven",
"employee_ids": [
494
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 528,
"name": "Altonfurt",
"employee_ids": [
495
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 529,
"name": "North Bryannashire",
"employee_ids": [
496
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 530,
"name": "West Shavondaburgh",
"employee_ids": [
497
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 531,
"name": "South Julesshire",
"employee_ids": [
498
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 532,
"name": "Port Patricia",
"employee_ids": [
499
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 533,
"name": "Kuhlmanland",
"employee_ids": [
500
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 534,
"name": "Marcelinoton",
"employee_ids": [
501
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 537,
"name": "2688 Walter Skyway",
"employee_ids": [
502,
503
],
"no_of_employees": 2,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 535,
"name": "West Archie",
"employee_ids": [],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 536,
"name": "Considineville",
"employee_ids": [],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
}
]
Show Branch
Request
Endpoint
GET https://api.talenox.com/api/v2/branches/568
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0b3b78bba2cf34cdb4660536480058eb3588f1e6
GET https://api.talenox.com/api/v2/branches/:id
Parameters
| Name | Description |
|---|---|
| id required | Branch ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 568,
"name": "610 Kiehn Ferry",
"employee_ids": [
528,
529
],
"no_of_employees": 2,
"address": null,
"postcode": null,
"head_id": null
}
Update Branch
Request
Endpoint
PUT https://api.talenox.com/api/v2/branches/583
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5fe90d1bd79b24fdb2f86c2e807edfebffecf4a9
PUT https://api.talenox.com/api/v2/branches/:id
Parameters
{
"branch": {
"name": "New Branch Name",
"employee_ids": [
536,
537,
530,
531
]
}
}
| Name | Description |
|---|---|
| id required | Branch ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 583,
"name": "New Branch Name",
"employee_ids": [
536,
537,
530,
531
],
"no_of_employees": 4,
"address": null,
"postcode": null,
"head_id": null
}
Company Holidays
Manage holidays in a company, including calendar holidays and custom created ones.
Create Company Custom Holiday
Request
Endpoint
POST https://api.talenox.com/api/v2/company_holidays
Accept: application/json
Content-Type: application/json
Authorization: Bearer d64d1c55dc3d59f162234364d01ec1421b9b119d
POST https://api.talenox.com/api/v2/company_holidays
Parameters
{
"custom_holiday": {
"name": "Test Holiday",
"start_at": "2024-12-31 23:59:59 +0800",
"end_at": "2024-12-31 23:59:59 +0800",
"custom_holiday_duration_attributes": {
"start_date_type": "all_day_start",
"end_date_type": "all_day_end"
}
}
}
| Name | Description |
|---|---|
| name required | Holiday name |
| start_at required | Start at |
| end_at required | End at |
| custom_holiday_duration_attributes[start_date_type] required | Start date type (["all_day_start", "first_part_of_the_day_start", "second_part_of_the_day_start"]) |
| custom_holiday_duration_attributes[end_date_type] required | End date type (["all_day_end", "first_part_of_the_day_end", "second_part_of_the_day_end"]) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1,
"company_id": 119,
"calendar_holiday_id": null,
"name": "Test Holiday",
"start_at": "2024-12-31",
"end_at": "2024-12-31",
"hide": false,
"created_at": "2024-12-16T06:15:44.872Z",
"updated_at": "2024-12-16T06:15:44.872Z"
}
Delete Company Calendar Holiday
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/8
Accept: application/json
Content-Type: application/json
Authorization: Bearer b4e5ea5b9ea0f38e648b8328724d6ad51ff0d571
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/:id
Parameters
{
"calendar_holiday": {
"hide": true
}
}
| Name | Description |
|---|---|
| hide required | Set to true to hide the calendar holiday for company, false otherwise |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully hidden calendar holiday for company"
}
Delete Company Custom Holiday
Request
Endpoint
DELETE https://api.talenox.com/api/v2/company_holidays/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer b5b371698ce6be2a95ae5c40f953efce25ca2e40
DELETE https://api.talenox.com/api/v2/company_holidays/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Deleted holiday Office Closure"
}
Get Company Custom Holiday
Request
Endpoint
GET https://api.talenox.com/api/v2/company_holidays/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer f78ff292256063848763efe07d7d61a75fa3098b
GET https://api.talenox.com/api/v2/company_holidays/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"company_id": 121,
"calendar_holiday_id": null,
"name": "Office Closure",
"start_at": "2024-12-30",
"end_at": "2024-12-31",
"hide": false,
"created_at": "2024-12-16T06:15:52.217Z",
"updated_at": "2024-12-16T06:15:52.217Z"
}
List Company Holidays including Custom and Calendar Holidays
Request
Endpoint
GET https://api.talenox.com/api/v2/company_holidays
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6e3ba0f4ba09ab4af236f53f3c0557e1f1c69401
GET https://api.talenox.com/api/v2/company_holidays
Parameters
| Name | Description |
|---|---|
| year | Year for filtering, defaults to current year |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"country_id": 2,
"name": "Calendar Holiday",
"created_at": "2024-12-16T06:15:44.981Z",
"updated_at": "2024-12-16T06:15:44.981Z",
"start_at": "2024-01-01",
"end_at": "2024-01-02",
"state_id": null,
"hk_holiday_type": null,
"type": "CalendarHoliday",
"calendar_holiday_id": 4
},
{
"id": 2,
"company_id": 120,
"calendar_holiday_id": null,
"name": "Office Closure",
"start_at": "2024-12-30",
"end_at": "2024-12-31",
"created_at": "2024-12-16T06:15:48.396Z",
"updated_at": "2024-12-16T06:15:48.396Z",
"type": "CustomHoliday",
"custom_holiday_duration": null
}
]
List Hidden Company Calendar Holidays
Request
Endpoint
GET https://api.talenox.com/api/v2/company_holidays/deleted_calendar_holidays
Accept: application/json
Content-Type: application/json
Authorization: Bearer 38f7410cc3d481557e7acb91b4648e975ce2a901
GET https://api.talenox.com/api/v2/company_holidays/deleted_calendar_holidays
Parameters
| Name | Description |
|---|---|
| year | Year for filtering, defaults to current year |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 12,
"country_id": 2,
"name": "Calendar Holiday",
"created_at": "2024-12-16T06:16:14.594Z",
"updated_at": "2024-12-16T06:16:14.594Z",
"start_at": "2024-01-01",
"end_at": "2024-01-02",
"state_id": null,
"hk_holiday_type": null
}
]
Retore Company Calendar Holiday
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/9
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4744dd2090ed7c7e9c2d56d9a000805ee4752e98
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/:id
Parameters
{
"calendar_holiday": {
"hide": false
}
}
| Name | Description |
|---|---|
| hide required | Set to true to hide the calendar holiday for company, false otherwise |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully restored calendar holiday for company"
}
Update Company Custom Holiday
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_holidays/4
Accept: application/json
Content-Type: application/json
Authorization: Bearer ff554295e21359e3d84f032e35fcdced682c70c5
PUT https://api.talenox.com/api/v2/company_holidays/:id
Parameters
{
"custom_holiday": {
"name": "Change name"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"company_id": 122,
"name": "Change name",
"id": 4,
"calendar_holiday_id": null,
"start_at": "2024-12-30",
"end_at": "2024-12-31",
"hide": false,
"created_at": "2024-12-16T06:15:56.165Z",
"updated_at": "2024-12-16T06:15:56.338Z"
}
Company Settings
List Company Settings
Request
Endpoint
GET https://api.talenox.com/api/v2/company_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer e227bf1dd47ba84190ad96e17ae9eebb6958bf63
GET https://api.talenox.com/api/v2/company_settings
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"api_allows_employee_multiple_cost_centres": false
}
Update Company Settings
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5795aa86e12322be898cc04030a764327aeab285
PUT https://api.talenox.com/api/v2/company_settings
Parameters
{
"company_settings": {
"api_allows_employee_multiple_cost_centres": true
}
}
| Name | Description |
|---|---|
| api_allows_employee_multiple_cost_centres | Set this to true for cost centres endpoint to accept multiple cost centres for any employee. (This is to avoid breaking previous API implementation) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"api_allows_employee_multiple_cost_centres": true
}
Cost Centres
Create Cost Centre
Request
Endpoint
POST https://api.talenox.com/api/v2/cost_centres
Accept: application/json
Content-Type: application/json
Authorization: Bearer 72e164974cdfdc957670f605cc2fcc6380fc1a2e
POST https://api.talenox.com/api/v2/cost_centres
Parameters
{
"cost_centre": {
"name": "Business",
"employee_ids": [
"x8ad9vkeo3",
"b785ijdsp4",
"zyeg83iq8z",
"0vfl4pt6az"
],
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456789"
}
}
| Name | Description |
|---|---|
| name required | Name of Cost Centre |
| enable_custom_cpf_csn | Enable custom CPF Submission |
| custom_cpf_scn | Custom CPF Number |
| employee_ids | Employee IDs (If specified, will override the existing employees in the cost centre). Set api_allows_employee_multiple_cost_centres of Company Settings to true to allow placement the same employee in multiple cost centres. |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"name": "Business",
"employee_ids": [
622,
623,
624,
625
],
"no_of_employees": 4,
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456789"
}
Delete Cost Centre
Request
Endpoint
DELETE https://api.talenox.com/api/v2/cost_centres/11
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6a9f8e1583f2dfa310f6a7a25144331ac01cabff
DELETE https://api.talenox.com/api/v2/cost_centres/:id
Parameters
| Name | Description |
|---|---|
| id required | Cost Centre ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted cost centre Ivan Mountain"
}
List Cost Centre
Request
Endpoint
GET https://api.talenox.com/api/v2/cost_centres
Accept: application/json
Content-Type: application/json
Authorization: Bearer 629622838522601ea65d8adf5daa669043c400b9
GET https://api.talenox.com/api/v2/cost_centres
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 1,
"name": "Eufemia Prairie",
"employee_ids": [],
"no_of_employees": 0,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null
}
]
Update Cost Centre
Request
Endpoint
PUT https://api.talenox.com/api/v2/cost_centres/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4a5000a23405edacc5ebc632bdf08fafd4f1a77e
PUT https://api.talenox.com/api/v2/cost_centres/:id
Parameters
{
"cost_centre": {
"name": "Engineer",
"employee_ids": [
"5dsqr0hq7p",
"wtppu0dqsc",
"zrd9w0zbap",
"q8tdbjduu9"
],
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456788"
}
}
| Name | Description |
|---|---|
| id required | Cost Centre ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 10,
"name": "Engineer",
"employee_ids": [
664,
665,
666,
659
],
"no_of_employees": 4,
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456788"
}
Custom Pay Items
Create Custom Pay Item
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/custom_pay_items
Accept: application/json
Content-Type: application/json
Authorization: Bearer 019ef73a3624e40010061d7864e5b0102227b8e7
POST https://api.talenox.com/api/v2/payroll/custom_pay_items
Parameters
{
"custom_pay_item": {
"proration_enabled": false,
"category": "Recurring",
"item_type": "Salary/Wages",
"gross_net_settings": "gross",
"tax": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"overtime_rate": 1.5,
"additional_sg_info_attributes": {
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info_attributes": {
"mpf": true,
"adw": true
},
"additional_my_info_attributes": {
"epf": true,
"socso": true,
"eis": true,
"hrdf": true
},
"additional_id_info_attributes": {
"bpjs": true,
"thr": true
}
}
}
| Name | Description |
|---|---|
| proration_enabled | Proration Enabled |
| categoary | Category (["Recurring", "Adhoc", "Attendance"]) |
| item_type | Item Type |
| gross_net_settings | Gross/Net settings |
| tax | Tax |
| payslip_display_settings | Payslip Display Settings (["Item Name", "Remarks", "Period", "Calculation"]) |
| overtime_rate | Overtime rate (for Attendance category only) |
| additional_sg_info_attributes | SG pay item related fields |
| cpf | CPF |
| sdl | SDL |
| shg | SHG |
| cpf_owage_awage | OWAGE/AWAGE |
| additional_hk_info_attributes | HK pay item related fields |
| mpf | MPF |
| adw | ADW |
| additional_my_info_attributes | MY pay item related fields |
| epf | EPF |
| socso | SOCSO |
| eis | EIS |
| hrdf | HRDF |
| additional_id_info_attributes | ID pay item related fields |
| bpjs | BPJS |
| thr | THR |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 30456,
"item_type": "Salary/Wages",
"name": null,
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d1d2f15c-9375-45f7-bef8-2905787e47f5",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29154,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": {
"id": 428,
"mpf": true,
"adw": true
},
"additional_my_info": {
"id": 449,
"epf": true,
"socso": true,
"eis": true,
"hrdf": true
},
"additional_id_info": {
"id": 421,
"bpjs": true,
"thr": true
}
}
Delete Custom Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/custom_pay_items/30794
Accept: application/json
Content-Type: application/json
Authorization: Bearer 091fbe567436440384f306df012afd4c6aa038ef
DELETE https://api.talenox.com/api/v2/payroll/custom_pay_items/:id
Parameters
| Name | Description |
|---|---|
| id required | Custom Pay Item ID |
Response
Content-Type: text/plain; charset=utf-8
200 OK
Get Custom Pay Item
Request
Endpoint
GET https://api.talenox.com/api/v2/payroll/custom_pay_items/30541
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4469eabb0610ef7b1880929a462d7b8836036048
GET https://api.talenox.com/api/v2/payroll/custom_pay_items/:id
Parameters
| Name | Description |
|---|---|
| id required | Custom Pay Item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 30541,
"item_type": "Salary/Wages",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "f48ad876-4636-40f1-8eea-8b35d9e2d760",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Period"
],
"pay_code": null,
"additional_sg_info": {
"id": 29239,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
}
List all Custom Pay Items
Request
Endpoint
GET https://api.talenox.com/api/v2/payroll/custom_pay_items
Accept: application/json
Content-Type: application/json
Authorization: Bearer 267ad82cd91b0226c6c6e875b80338bd11b0e404
GET https://api.talenox.com/api/v2/payroll/custom_pay_items
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 30457,
"item_type": "Salary/Wages",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "69cbbd11-f694-4d8a-92d1-3d2ffa852d24",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Period"
],
"pay_code": null,
"additional_sg_info": {
"id": 29155,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30458,
"item_type": "Salary/Wages",
"name": "Basic Pay(without proration)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "9e9102f5-cdc0-4d1b-b669-9603831e556d",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29156,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30459,
"item_type": "Allowance",
"name": "Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "87168580-38df-4491-8dbf-88da2217df91",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29157,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30460,
"item_type": "Allowance",
"name": "Allowance(without proration)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "81d64636-342f-414b-96e6-e81d8da97f8f",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29158,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30461,
"item_type": "Deduction",
"name": "Deduction",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "9a2b08a7-4afa-42e7-a052-dc30edb417ed",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29159,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30462,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "ea35a1ae-84b6-41f5-b14b-f9dbf78ff0a9",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29160,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30463,
"item_type": "IR21 Tax Withholding",
"name": "IR21 Tax Withholding",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "5ab557f6-cba9-42c1-ada2-5f14f250b75f",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29161,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30464,
"item_type": "Commission",
"name": "Commission (Daily/Weekly/Monthly)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "88db3078-277e-4ac4-a4e5-d838cf831b95",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29162,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30465,
"item_type": "Extra Duty Allowance",
"name": "Extra Duty Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "200fbee6-b075-46bd-9aed-374c22e1e6c3",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29163,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30466,
"item_type": "Housing/Rental Allowance",
"name": "Housing/ Rental Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8c7d7414-68c6-4a45-94e9-4ff86daf23cd",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29164,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30467,
"item_type": "Incentive Allowance",
"name": "Incentive Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8bfba47f-6002-41ce-a55b-a3094cc90c69",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29165,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30468,
"item_type": "Meal Allowance",
"name": "Meal Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "035280cb-eac5-4fd8-8839-645b285971bf",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29166,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30469,
"item_type": "Per Diem Allowance",
"name": "Per Diem Allowance",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f204c836-9e00-4753-ac09-6c4eea1b2cd0",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29167,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30470,
"item_type": "Transport Allowance",
"name": "Transport Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "bbe353d8-7d78-4119-abcd-cc75e7dd4a9e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29168,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30471,
"item_type": "Tips",
"name": "Tips",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "008c55f8-2508-445f-8809-07b9517f655e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29169,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30472,
"item_type": "Director fees",
"name": "Director fees",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "fe34b24d-13fc-40cf-8932-1a728841eca1",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29170,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30473,
"item_type": "Bonus",
"name": "Bonus",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "289b54b9-0abb-4c57-9421-a96a6d773507",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29171,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30474,
"item_type": "Others",
"name": "Others",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "9ec8ff5a-dc58-47c7-bf71-4e390a92a2e2",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29172,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30475,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)(no SHG contribution)",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "5aca87a4-7a08-4282-933c-82fffd47d9e7",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29173,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30476,
"item_type": "Commission",
"name": "Commission (AW)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "6e39116a-71de-42dd-8fb9-e9989a03a122",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29174,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30477,
"item_type": "Medisave",
"name": "Medisave",
"category": "Recurring",
"tax": true,
"gross_net_settings": "na",
"proration_enabled": false,
"slug": "d47f0576-39aa-4ea7-a4a5-1bd685495fc6",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29175,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30478,
"item_type": "Deduction Community Chest",
"name": "Deduction Community Chest",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "5412f62a-d964-4a43-802e-bc9641c771ad",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29176,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30479,
"item_type": "Reimbursements",
"name": "Reimbursements",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "cddcf746-4dec-45a1-b326-3eafcad96674",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29177,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30480,
"item_type": "Advance Pay",
"name": "Advance Pay",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "0de11ca0-32fe-497d-b451-81dac0ab5d4a",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29178,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30481,
"item_type": "Allowance",
"name": "Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "85979ba4-00ea-4cc5-b2fd-5aca1341233d",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29179,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30482,
"item_type": "Deduction",
"name": "Deduction",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a300b7f4-8e62-479f-835d-d129efa9dc34",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29180,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30483,
"item_type": "Commission",
"name": "Commission (Irregular)",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "24679648-a285-4637-a1d6-8dae0f5f7cca",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29181,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30484,
"item_type": "Extra Duty Allowance",
"name": "Extra Duty Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a96f6bf2-bf82-41d3-a8eb-8e75af0b0b78",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29182,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30485,
"item_type": "Festive Allowance",
"name": "Festive Allowance",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "64822caf-c56e-4adb-8266-c0e9b4abc86e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29183,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30486,
"item_type": "Housing/Rental Allowance",
"name": "Housing/ Rental Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "973855b9-2da6-4437-aecf-6f6cb32c1d46",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29184,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30487,
"item_type": "Incentive",
"name": "Incentive",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ec741f70-14dc-485f-b12f-fee105c9c97a",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29185,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30488,
"item_type": "Incentive Allowance",
"name": "Incentive Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "11b0166b-a4f3-46a5-a01b-ad406a867de9",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29186,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30489,
"item_type": "IR21 Tax Withholding",
"name": "IR21 Tax Withholding",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "5209de9c-be70-4371-8349-20dad29420ac",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29187,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30490,
"item_type": "Meal Allowance",
"name": "Meal Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "c03d88f9-2c94-469f-9a3d-da35ca02d076",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29188,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30491,
"item_type": "Per Diem Allowance",
"name": "Per Diem Allowance",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8848d72f-cf36-4e91-b617-fe7414a41f46",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29189,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30492,
"item_type": "Reimbursements",
"name": "Per Diem Reimbursement",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "342ac5e4-8d4f-44d1-80c9-b2110edfacde",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29190,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30493,
"item_type": "Transport Allowance",
"name": "Transport Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f3835ce0-47dc-4854-8ab8-fa871fa7e130",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29191,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30494,
"item_type": "Referral of Employees Fees",
"name": "Referral of Employees Fees",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "6c690abb-110b-47fd-a6cc-5f012371babe",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29192,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30495,
"item_type": "Benefits in Kind",
"name": "Benefits in Kind",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "4f8882b5-c102-4266-8879-cde19fe7f81c",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29193,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30496,
"item_type": "Benefits in Kind",
"name": "Gifts in Kind",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "b750a735-8e51-4b78-a183-313a9fcb0efd",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29194,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30497,
"item_type": "Stock Option Sale",
"name": "Share Option Sale",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "4338a6b1-8ee1-4877-86dc-190e9864a014",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29195,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30498,
"item_type": "Termination Benefits",
"name": "Termination Benefits",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "ca32b76f-2e21-4d63-9295-9a830a58244b",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29196,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30499,
"item_type": "Tips",
"name": "Tips",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "0e6a357a-b735-4e08-8d51-83f54fdcd775",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29197,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30500,
"item_type": "Annual Wage Supplement",
"name": "Annual Wage Supplement",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "6c63e2ce-2d1a-4680-8fb0-96c9eed10ddd",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29198,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30501,
"item_type": "Bonus",
"name": "Bonus",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "c14cc89d-edd0-461f-b42a-2dec93dd7da6",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29199,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30502,
"item_type": "Bonus",
"name": "Prior Year Bonus",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "6ee6c4c2-41ff-4e5f-9a50-716e9e7954cf",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29200,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30503,
"item_type": "Annual Wage Supplement",
"name": "Prior Year AWS",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "85b4c3d8-9c43-4ac0-a4d1-2b48109dac22",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29201,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30504,
"item_type": "Leave Pay",
"name": "Leave Pay",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1db10801-7dac-4724-88ea-f5d52ea6e5ed",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Calculation"
],
"pay_code": null,
"additional_sg_info": {
"id": 29202,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30505,
"item_type": "Director fees",
"name": "Director fees",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "0b5360ba-56f0-4dd1-bf20-6d2a31db2990",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29203,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30506,
"item_type": "Backdated Salary",
"name": "Backdated Salary Increment",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f299d7d1-8c4c-4118-a83d-543bcffe3900",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29204,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30507,
"item_type": "Backdated Salary",
"name": "Backdated Salary",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b4ada8af-c9db-483b-843a-7c6e3ccf7bcb",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29205,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30508,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "67efcc60-676d-4ec9-9ea2-23c0dfb96978",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29206,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30509,
"item_type": "Others",
"name": "Others",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a40cbc51-0795-476b-a26d-519cd58b3b3e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29207,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30510,
"item_type": "Others",
"name": "Others(no gross)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "c94a14d0-b4b9-4d0a-b67d-9c6b3cf20653",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29208,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30511,
"item_type": "Salary in Lieu",
"name": "Salary in lieu",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "23456624-57a5-45d0-ae3a-e84f7553ad7e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29209,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30512,
"item_type": "Incentive",
"name": "Onboarding incentive",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d2e7cf34-dee4-4aa2-8a00-34fa87c0aa1b",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29210,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30513,
"item_type": "Gratuity",
"name": "Gratuity paid for years of service",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "e4005a69-242f-4e16-900d-32afbc12ea45",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29211,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30514,
"item_type": "Compensation for loss of employment",
"name": "Compensation for loss of employment",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "fd7da114-cf62-450a-9644-de30e6e93148",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29212,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30515,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)(no SHG contribution)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "fde96a62-3475-40e5-b5f7-04ca21fee1c1",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29213,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30516,
"item_type": "Deduction",
"name": "NS Leave Claims Deduction",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "4cb86089-8f4d-45d1-b0b3-766ee1952462",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29214,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30517,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Personal Insurance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b2321300-0097-4c83-95a5-f48ad8940ac4",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29215,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30518,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Optical Expenses",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f61445b3-5fea-43fd-a1bc-dd382d42697b",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29216,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30519,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Health Screening & Vaccinations",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ef65a116-2653-4848-b782-442a93e65a49",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29217,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30520,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Childcare / Eldercare Fees For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "16b9ac10-b66e-4a53-8bf2-1e656d2c9fdd",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29218,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30521,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Medical Expenses For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ef031db4-2b28-42eb-b960-9bafbb7be760",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29219,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30522,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Dental Expenses For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "54e7e189-1a85-45a7-9539-e63e08b41e88",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29220,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30523,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Gym Membership",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "877fdefa-d6c8-44a8-9d2d-73038e0c56d1",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29221,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30524,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Holiday Expenses",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a6e58c12-0ee3-45ff-8de1-df97a7fa49f0",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29222,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30525,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit TCM / CHIRO/ PHYSIO",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a3943945-6407-40ec-937b-b53e6efca17c",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29223,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30526,
"item_type": "Gratuity",
"name": "Gratuity",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1d76d5e7-a4af-469c-b288-518a3e491e37",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29224,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30527,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Work From Home",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f420f57c-511e-487c-812a-0967e1d9ec4c",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29225,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30528,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Mental Health Awareness",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "6e3047a6-a637-40b5-89c9-f5a5be6f7e9b",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29226,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30529,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Personal Planning & Enrichment",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ec5c8d5c-d0db-4a3e-9f2c-2c5b9f8e0d56",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29227,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30530,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Home Affairs Support",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d48194e9-cabc-4321-88ca-8e544ecba821",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29228,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30531,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Home Family Bonding Facilitation",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "2d30a43c-a136-4888-a3f9-89ca5ccba143",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29229,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30532,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Professional Subscription",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "98b68bec-efe9-42f7-a55c-8aa34c37ae64",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29230,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30533,
"item_type": "Regular Hours",
"name": "Regular Hours",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "921ed541-b6ea-4c6d-a7cf-6cf8f025091e",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29231,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30534,
"item_type": "Overtime Hours",
"name": "Overtime Hours",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "7d0535ea-6f44-4581-9fb2-04e1c79cb753",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29232,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30535,
"item_type": "Regular Days",
"name": "Regular Days",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "e3bb01a2-0d70-4f10-a0d0-78e7f77ba73c",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29233,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30536,
"item_type": "Overtime Days",
"name": "Overtime Days",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ecbcd3af-5b45-48e4-bffc-62ff4e5dfe11",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29234,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30537,
"item_type": "Public Holiday Pay",
"name": "Public Holiday Pay",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "15bca10c-bb7f-44a5-a798-c3554699011d",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29235,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30538,
"item_type": "Rest Day Pay",
"name": "Rest Day Pay",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "654b1ee0-ff11-43a4-b7de-a9e8108f9f0f",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29236,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30539,
"item_type": "Deputy",
"name": "Deputy Awage",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "e72106da-f456-4f8d-8066-030f87409421",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29237,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 30540,
"item_type": "Deputy",
"name": "Deputy",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "227f659b-b6cf-43af-883a-7da6b19fbf7c",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 29238,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
}
]
Update Custom Pay Item
Request
Endpoint
PATCH https://api.talenox.com/api/v2/payroll/custom_pay_items/30625
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6d764eed510038c875c534fe99c36ae9de57d499
PATCH https://api.talenox.com/api/v2/payroll/custom_pay_items/:id
Parameters
{
"custom_pay_item": {
"proration_enabled": false,
"category": "Recurring",
"item_type": "Allowance",
"gross_net_settings": "gross",
"tax": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"overtime_rate": 1.5,
"additional_sg_info_attributes": {
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info_attributes": {
"mpf": true,
"adw": true
},
"additional_my_info_attributes": {
"epf": true,
"socso": true,
"eis": true,
"hrdf": true
},
"additional_id_info_attributes": {
"bpjs": true,
"thr": true
}
}
}
| Name | Description |
|---|---|
| id required | Custom Pay Item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 30625,
"item_type": "Allowance",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "961e2afc-9963-4c1d-b13a-188ee270f52f",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Period"
],
"pay_code": null,
"additional_sg_info": {
"id": 29407,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": {
"id": 429,
"mpf": true,
"adw": true
},
"additional_my_info": {
"id": 450,
"epf": true,
"socso": true,
"eis": true,
"hrdf": true
},
"additional_id_info": {
"id": 422,
"bpjs": true,
"thr": true
}
}
Employee Roles
Create Role
Request
Endpoint
POST https://api.talenox.com/api/v2/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer 50ada46e52c15bcd2c1f20b0b343ad54dec8dc8f
POST https://api.talenox.com/api/v2/roles
Parameters
{
"role": {
"name": "Manager",
"employee_ids": [
1108,
1109,
1110,
1111
]
}
}
| Name | Description |
|---|---|
| name required | Role name |
| employee_ids | Employee IDs (If specified, will override the existing employees for the role). |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1106,
"name": "Manager",
"employee_ids": [
1108,
1109,
1110,
1111
],
"no_of_employees": 4
}
Delete Role
Request
Endpoint
DELETE https://api.talenox.com/api/v2/roles/1148
Accept: application/json
Content-Type: application/json
Authorization: Bearer fc3509b9b527a0aa49f457b5ae0c4a038f1cf9e5
DELETE https://api.talenox.com/api/v2/roles/:id
Parameters
| Name | Description |
|---|---|
| id required | Role ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted role 1148"
}
List Roles
Request
Endpoint
GET https://api.talenox.com/api/v2/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8d05cc58d551d7a257053b40315af448f80d9450
GET https://api.talenox.com/api/v2/roles
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 1087,
"name": "lecturer",
"employee_ids": [
1104
],
"no_of_employees": 1
},
{
"id": 1088,
"name": "optician",
"employee_ids": [
1105
],
"no_of_employees": 1
},
{
"id": 1089,
"name": "geixrgaewrniirpgkupjjzjhpqdtjufd",
"employee_ids": [],
"no_of_employees": 0
},
{
"id": 1090,
"name": "dojmlforvnptzmbaitfhqkswsdjkodkq",
"employee_ids": [],
"no_of_employees": 0
},
{
"id": 1091,
"name": "Engineer",
"employee_ids": [
1106,
1107
],
"no_of_employees": 2
},
{
"id": 1078,
"name": "dental hygienist",
"employee_ids": [
1095
],
"no_of_employees": 1
},
{
"id": 1079,
"name": "butcher",
"employee_ids": [
1096
],
"no_of_employees": 1
},
{
"id": 1080,
"name": "translator",
"employee_ids": [
1097
],
"no_of_employees": 1
},
{
"id": 1081,
"name": "receptionist",
"employee_ids": [
1098
],
"no_of_employees": 1
},
{
"id": 1082,
"name": "bookkeeper",
"employee_ids": [
1099
],
"no_of_employees": 1
},
{
"id": 1083,
"name": "philosopher",
"employee_ids": [
1100
],
"no_of_employees": 1
},
{
"id": 1084,
"name": "actor",
"employee_ids": [
1101
],
"no_of_employees": 1
},
{
"id": 1085,
"name": "firefighter",
"employee_ids": [
1102
],
"no_of_employees": 1
},
{
"id": 1086,
"name": "bartender",
"employee_ids": [
1103
],
"no_of_employees": 1
}
]
Show Role
Request
Endpoint
GET https://api.talenox.com/api/v2/roles/1120
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2df30b3ca4bc6f5eb948e0b9ad5b0f73652752f5
GET https://api.talenox.com/api/v2/roles/:id
Parameters
| Name | Description |
|---|---|
| id required | Role ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1120,
"name": "Engineer",
"employee_ids": [
1132,
1133
],
"no_of_employees": 2
}
Update Role
Request
Endpoint
PUT https://api.talenox.com/api/v2/roles/1134
Accept: application/json
Content-Type: application/json
Authorization: Bearer afcf3633b438ada263e8448e1a2b8ff062d2f8e5
PUT https://api.talenox.com/api/v2/roles/:id
Parameters
{
"role": {
"name": "New Role Name",
"employee_ids": [
1144,
1145,
1146,
1134
]
}
}
| Name | Description |
|---|---|
| id required | Role ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1134,
"name": "New Role Name",
"employee_ids": [
1145,
1146,
1144,
1134
],
"no_of_employees": 4
}
Employees
Create HK Employee
Request
Endpoint
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer a604b8eb0b8dd6d52e5c76916cce47da2e28294c
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "Hong Kong Permanent Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": "",
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"basic_pay_item_attributes": {
"rate_of_pay": "Monthly",
"currency": "SGD",
"amount": 4000
}
},
"bank_account_attributes": {
"bank_type": "DBS",
"bank_code": 1,
"account_name": "Hafsah Haigh",
"number": 131231231231231231,
"branch_code": 1,
"branch_name": "",
"swift_code": "",
"payment_code": 1,
"dbs_company_id": ""
},
"additional_hk_employee_info_attributes": {
"voluntary_employee_contribution": 100,
"voluntary_employer_contribution": 200,
"mpf_scheme": 0,
"mpf_member_account_number": 123123123,
"mpf_enrolled_date": "01/01/2015"
},
"location_attributes": {
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": 12345,
"state": null,
"country_name": "Singapore"
}
}
}
| Name | Description |
|---|---|
| invite_user | If true will create a talenox user for the employee and invite them |
| employee_id | Employee ID |
| first_name required | First name |
| last_name | Last name |
| chinese_name | Chinese name |
| nickname | Nickname |
| identification_full_name | Identification full name |
| email required | Email address |
| hired_date | Hired date |
| confirmation_date | Confirmation date |
| resign_date | Resign date |
| contact_number | Contact number |
| office_did | Office Direct Inward Dialing (DID) Number |
| ssn required | Identification number |
| ssn_should_validate | Should valdate identification number |
| citizenship required | Immigration status |
| nationality | Nationality |
| gender | Gender |
| race | Race |
| religion | Religion |
| marital_status | Marital status |
| birthdate | Birth date |
| passport_number | Passport number |
| passport_date_of_issue | Passport issue date |
| passport_date_of_expiry | Passport expiry date |
| passport_place_of_issue | Passport place of issue |
| vaccination_status | Vaccination status |
| vaccine_brand | Vaccine brand |
| date_of_first_dose | Date of first dose |
| date_of_second_dose | Date of second dose |
| vaccine_booster_brand | Vaccine booster brand |
| date_of_booster_dose | Date of second dose |
| vaccination_remarks | Vaccination remarks |
| payment_method required | Payment type |
| cost_centre_id | Default Cost centre ID (Same as default_cost_centre_id) |
| default_cost_centre_id | Default Cost centre ID (Set the company setting api_allows_employee_multiple_cost_centres to true to avoid resetting employee cost centres when changing default_cost_centre_id value) |
| cost_centre_ids | Cost centre IDs (to assign employee to multiple cost centres) |
| blood_group | Blood group |
| leaving_country | Leaving country |
| employee_attachment_access | Employee attachment access |
| accounting_split | Accounting split |
| employee_can_update_custom_fields | Employee can update custom fields |
| employee_attachment_access | Employee attachment access |
| reason_for_cessation | Reason for cessation |
| other_reason_for_cessation | Other reason for cessation |
| custom_fields | Custom fields |
| current_job_parameters | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| current_job_parameters[basic_pay_item_parameters] | Below are Basic Pay Item related fields |
| current_job_parameters[rate_of_pay] | Rate of pay |
| current_job_parameters[currency] | Currency |
| current_job_parameters[amount] | Basic pay amount |
| bank_account_parameters | Below are Employee's Bank Account related fields |
| bank_type | Bank name |
| bank_code | Bank code |
| account_name | Bank account name |
| number | Bank account number |
| branch_code | Branch code |
| branch_name | Branch name |
| swift_code | Bank swift code |
| payment_code | Payment code (Hang Seng and HSBC only) |
| dbs_company_id | DBS company ID (DBS only) |
| employee_using_cheque | Employee using cheque |
| location_parameters | Below are Employee's Address related fields |
| line_1 | Address line 1 |
| line_2 | Address line 2 |
| postal_code | Postal code |
| state | State |
| country_name | Country name |
| additional_hk_employee_info_parameters | Below are HK Employee's related fields |
| voluntary_employee_contribution_type | MPF Voluntary Employee Additional Contribution Type (["Percentage", "Fixed Amount"]) |
| voluntary_employee_contribution | MPF Voluntary Employee Additional amount (If percentage is chosen, must be one of ["5%", "6%", "7%", "8%", "9%", "10%", "11%", "12%", "13%", "14%", "15%"]) |
| voluntary_employee_contribution_setting | MPF Voluntary Employee Deduction Setting (["Gross Salary", "Net Salary"]) |
| voluntary_employer_contribution_type | MPF Voluntary Employer Additional Contribution Type (["Percentage", "Fixed Amount"]) |
| voluntary_employer_contribution | MPF Voluntary Employer Additional amount (If percentage is chosen, must be one of ["5%", "6%", "7%", "8%", "9%", "10%", "11%", "12%", "13%", "14%", "15%"]) |
| voluntary_employer_contribution_setting | MPF Voluntary Employer Deduction Setting (["Gross Salary", "Net Salary"]) |
| mpf_scheme required | MPF Scheme. 0 => Master trust scheme, 2 => Not contributing MPF |
| mpf_employee_type | MPF employee type (["regular", "casual"]) |
| mpf_member_account_number | MPF account number |
| mpf_enrolled_date | MPF enrolled date |
| identification_expiry_date | Identification expiry date. When you use the API to update this field, we will map to the immigration expiry field. E.g. for IANG, we will map to iang_expiry_date. |
| identification_issue_date | Identification issue date. When you use the API to update this field, we will map to the immigration issue field. E.g. for IANG, we will map to iang_issue_date. |
| non_pr_issue_date | Non PR Issue Date |
| non_pr_expiry_date | Non PR Expiry Date |
| foreigner_issue_date | Foreigner Issue Date |
| foreigner_expiry_date | Foreigner Expiry Date |
| iang_issue_date | IANG Issue Date |
| iang_expiry_date | IANG Expiry Date |
| student_issue_date | Student Issue Date |
| student_expiry_date | Student Expiry Date |
| dependants_issue_date | Dependants Issue Date |
| dependants_expiry_date | Dependants Expiry Date |
| gep_issue_date | GEP Issue Date |
| gep_expiry_date | GEP Expiry Date |
| qmas_issue_date | QMAS Issue Date |
| qmas_expiry_date | QMAS Expiry Date |
| ttps_issue_date | TTPS Issue Date |
| ttps_expiry_date | TTPS Expiry Date |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 792,
"employee_id": "1",
"first_name": "Hafsah",
"middle_name": null,
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "2015-01-01",
"resign_date": null,
"confirmation_date": "2019-01-01",
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": "123456789",
"office_did": null,
"ssn": "S1111111D",
"ssn_should_validate": true,
"citizenship": "Hong Kong Permanent Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "2017-01-01",
"passport_date_of_expiry": "2022-12-01",
"passport_place_of_issue": "Singapore",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "2015-01-01",
"slug": "hafsah-haigh-47968a43",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "2021-01-01",
"date_of_second_dose": "2021-11-01",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "2021-12-01",
"vaccination_remarks": "",
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"cost_centres": [],
"default_cost_centre": null,
"current_job": {
"id": 48,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 48,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [],
"bank_account": {
"id": 925,
"bank_type": "DBS",
"bank_code": "1",
"branch_code": "1",
"branch_name": null,
"number": "131231231231231231",
"dbs_company_id": "",
"swift_code": "DHBKHKHH",
"account_name": "Hafsah Haigh",
"payment_code": "1",
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1058,
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": "12345",
"state": null,
"country_name": "Singapore",
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": {
"voluntary_employee_contribution": "100.0",
"voluntary_employer_contribution": "200.0",
"mpf_scheme": "master_trust_scheme",
"mpf_employee_type": "regular",
"mpf_member_account_number": "123123123",
"mpf_enrolled_date": "2015-01-01",
"non_pr_issue_date": null,
"non_pr_expiry_date": null,
"foreigner_issue_date": null,
"foreigner_expiry_date": null,
"iang_issue_date": null,
"iang_expiry_date": null,
"student_issue_date": null,
"student_expiry_date": null,
"dependants_issue_date": null,
"dependants_expiry_date": null,
"voluntary_employer_contribution_type": "Fixed Amount",
"voluntary_employer_contribution_rate": null,
"voluntary_employee_contribution_type": "Fixed Amount",
"voluntary_employee_contribution_rate": null,
"gep_expiry_date": null,
"gep_issue_date": null,
"qmas_issue_date": null,
"qmas_expiry_date": null,
"ttps_issue_date": null,
"ttps_expiry_date": null,
"asmtp_issue_date": null,
"asmtp_expiry_date": null,
"voluntary_employer_contribution_setting": "Gross Salary",
"voluntary_employee_contribution_setting": "Gross Salary"
},
"additional_sg_employee_info": null,
"additional_my_employee_info": null,
"additional_id_employee_info": null
}
Create ID Employee
Request
Endpoint
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer d9519ac00de05055b73350ad68e5ad1f869c0602
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "KTP (Residential Identity Card)",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": "",
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"basic_pay_item_attributes": {
"rate_of_pay": "Monthly",
"currency": "SGD",
"amount": 4000
}
},
"bank_account_attributes": {
"bank_type": "Standard Chartered",
"bank_code": 1,
"account_name": "Hafsah Haigh",
"number": 131231231231231231,
"branch_code": 1,
"branch_name": "",
"swift_code": "",
"payment_code": 1,
"dbs_company_id": ""
},
"additional_id_employee_info_attributes": {
"tax_processing_date": "01/01/2015",
"ptkp": "TK/0",
"npwp": "1234567891234567",
"tax_scheme": "gross",
"previous_past_net": 100,
"previous_past_tax": 100,
"previous_past_net_tax_effective_date": "01/01/2015",
"bpjs_tk_process_date": "01/01/2015",
"bpjs_tk_number": "1234567891234567",
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": "01/01/2015",
"bpjs_kesehatan_number": "1234567891234567",
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": 1,
"bpjs_kesehatan_borne_by_employer": true,
"bpjs_tk_jht_borne_by_employer": true,
"bpjs_jp_borne_by_employer": true,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered"
},
"location_attributes": {
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": 12345,
"state": null,
"country_name": "Singapore"
}
}
}
| Name | Description |
|---|---|
| invite_user | If true will create a talenox user for the employee and invite them |
| employee_id | Employee ID |
| first_name required | First name |
| last_name | Last name |
| chinese_name | Chinese name |
| nickname | Nickname |
| identification_full_name | Identification full name |
| email required | Email address |
| hired_date | Hired date |
| confirmation_date | Confirmation date |
| resign_date | Resign date |
| contact_number | Contact number |
| office_did | Office Direct Inward Dialing (DID) Number |
| ssn required | Identification number |
| ssn_should_validate | Should valdate identification number |
| citizenship required | Immigration status |
| nationality | Nationality |
| gender | Gender |
| race | Race |
| religion | Religion |
| marital_status | Marital status |
| birthdate | Birth date |
| passport_number | Passport number |
| passport_date_of_issue | Passport issue date |
| passport_date_of_expiry | Passport expiry date |
| passport_place_of_issue | Passport place of issue |
| vaccination_status | Vaccination status |
| vaccine_brand | Vaccine brand |
| date_of_first_dose | Date of first dose |
| date_of_second_dose | Date of second dose |
| vaccine_booster_brand | Vaccine booster brand |
| date_of_booster_dose | Date of second dose |
| vaccination_remarks | Vaccination remarks |
| payment_method required | Payment type |
| cost_centre_id | Default Cost centre ID (Same as default_cost_centre_id) |
| default_cost_centre_id | Default Cost centre ID (Set the company setting api_allows_employee_multiple_cost_centres to true to avoid resetting employee cost centres when changing default_cost_centre_id value) |
| cost_centre_ids | Cost centre IDs (to assign employee to multiple cost centres) |
| blood_group | Blood group |
| leaving_country | Leaving country |
| employee_attachment_access | Employee attachment access |
| accounting_split | Accounting split |
| employee_can_update_custom_fields | Employee can update custom fields |
| employee_attachment_access | Employee attachment access |
| reason_for_cessation | Reason for cessation |
| other_reason_for_cessation | Other reason for cessation |
| custom_fields | Custom fields |
| current_job_parameters | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| current_job_parameters[basic_pay_item_parameters] | Below are Basic Pay Item related fields |
| current_job_parameters[rate_of_pay] | Rate of pay |
| current_job_parameters[currency] | Currency |
| current_job_parameters[amount] | Basic pay amount |
| bank_account_parameters | Below are Employee's Bank Account related fields |
| bank_type | Bank name |
| bank_code | Bank code |
| account_name | Bank account name |
| number | Bank account number |
| branch_code | Branch code |
| branch_name | Branch name |
| swift_code | Bank swift code |
| payment_code | Payment code (Hang Seng and HSBC only) |
| dbs_company_id | DBS company ID (DBS only) |
| employee_using_cheque | Employee using cheque |
| location_parameters | Below are Employee's Address related fields |
| line_1 | Address line 1 |
| line_2 | Address line 2 |
| postal_code | Postal code |
| state | State |
| country_name | Country name |
| additional_id_employee_info_parameters | Below are ID Employee's related fields |
| tax_processing_date required | Tax Processing Date |
| ptkp required | PTKP / Tax Deductions Category |
| npwp | NPWP / Tax Identification Number |
| tax_scheme required | Tax Scheme |
| previous_past_net | Previous Past Net |
| previous_past_tax | Previous Past Tax |
| previous_past_net_tax_effective_date | Previous Past Net & Tax Effective Date |
| bpjs_tk_process_date | BPJS TK Process Date |
| bpjs_tk_number | BPJS TK Number |
| bpjs_tk_policy required | BPJS JKK Policy |
| bpjs_tk_jht_borne_by_employer required | BPJS JHT borne by employer |
| bpjs_jp_policy required | BPJS JP Policy |
| bpjs_jp_borne_by_employer required | BPJS JP borne by employer |
| work_accident_insurance_contribution_rate | BPJS JKK Contribution Rate (Required if BPJS JKK Policy is registered) |
| bpjs_jkm_policy required | BPJS JKM Policy |
| bpjs_tk_jht_policy required | BPJS JHT Policy |
| bpjs_kesehatan_process_date | BPJS Kesehatan Process Date |
| bpjs_kesehatan_number | BPJS Kesehatan Number |
| bpjs_kesehatan_policy required | BPJS Kesehatan Policy |
| no_of_bpjs_kesehatan_dependents | BPJS Kesehatan Additional Dependants |
| bpjs_kesehatan_borne_by_employer required | BPJS Kesehatan borne by employer |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 794,
"employee_id": "1",
"first_name": "Hafsah",
"middle_name": null,
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "2015-01-01",
"resign_date": null,
"confirmation_date": "2019-01-01",
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": "123456789",
"office_did": null,
"ssn": "S1111111D",
"ssn_should_validate": true,
"citizenship": "KTP (Residential Identity Card)",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "2017-01-01",
"passport_date_of_expiry": "2022-12-01",
"passport_place_of_issue": "Singapore",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "2015-01-01",
"slug": "hafsah-haigh-490c7438",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "2021-01-01",
"date_of_second_dose": "2021-11-01",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "2021-12-01",
"vaccination_remarks": "",
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"cost_centres": [],
"default_cost_centre": null,
"current_job": {
"id": 50,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 50,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [],
"bank_account": {
"id": 935,
"bank_type": "Standard Chartered",
"bank_code": "1",
"branch_code": "1",
"branch_name": null,
"number": "131231231231231231",
"dbs_company_id": "",
"swift_code": "SCBLIDJXXXX",
"account_name": "Hafsah Haigh",
"payment_code": "1",
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1076,
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": "12345",
"state": null,
"country_name": "Singapore",
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": null,
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2015-01-01",
"ptkp": "TK/0",
"npwp": "1234567891234567",
"tax_scheme": "gross",
"previous_past_net": "100.0",
"previous_past_tax": "100.0",
"bpjs_tk_process_date": "2015-01-01",
"bpjs_tk_number": "1234567891234567",
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": "2015-01-01",
"bpjs_kesehatan_number": "1234567891234567",
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": 1,
"bpjs_kesehatan_borne_by_employer": true,
"bpjs_tk_jht_borne_by_employer": true,
"bpjs_jp_borne_by_employer": true,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": "2015-01-01"
}
}
Create MY Employee
Request
Endpoint
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer 84e42eaeb2e5ab9259ad704c077f72d920f70f3b
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Married and Spouse Not Working",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": "",
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"basic_pay_item_attributes": {
"rate_of_pay": "Monthly",
"currency": "SGD",
"amount": 4000
}
},
"bank_account_attributes": {
"bank_type": "DBS",
"bank_code": 1,
"account_name": "Hafsah Haigh",
"number": 131231231231231231,
"branch_code": 1,
"branch_name": "",
"swift_code": "",
"payment_code": 1,
"dbs_company_id": ""
},
"additional_my_employee_info_attributes": {
"is_contributing_epf": true,
"epf_number": 123456789,
"employee_epf_setting": "Statutory Default",
"employer_epf_setting": "12%",
"pcb_number": 12312312,
"socso_setting": "Employment Injury Scheme and Invalidity Scheme",
"socso_number": 123123124,
"disabled_individual": false,
"disabled_spouse": false,
"has_eis": true,
"zakat_number": 123123123,
"zakat_amount": 1000,
"accumulated_remuneration_bik_vola": 50.2,
"accumulated_deductions_epf_and_other_funds": 100.9,
"accumulated_deductions_mtd": 700.22,
"accumulated_deductions_zakat_paid": 500.4,
"accumulated_year": 2018,
"accumulated_deductions_medical_treatment_special_needs_or_carer": 50.4,
"accumulated_deductions_father_relief": 2000.9,
"accumulated_deductions_mother_relief": 3020,
"accumulated_deductions_basic_supporting_equipment": 2400,
"accumulated_deductions_higher_education_fees_self": 5090,
"accumulated_deductions_medical_expenses_on_serious_diseases": 1900,
"accumulated_deductions_complete_medical_examination": 990,
"accumulated_deductions_net_deposit_in_sspn": 13123,
"accumulated_deductions_payment_of_alimony_to_former_wife": 500.12,
"accumulated_deductions_contribution_to_private_retirement_schem": 1000.2,
"accumulated_deductions_education_and_medical_insurance": 2000.59,
"accumulated_deductions_interest_on_housing_loan": 290.1,
"accumulated_deductions_tax_deduction_for_lifestyle": 900.5,
"accumulated_deductions_tax_deduction_for_purchase_of_breastfeed": 200,
"accumulated_deductions_tax_deduction_for_fees_paid_to_child_car": 1300,
"noc_under_18_full": 1,
"noc_under_18_half": 2,
"noc_18_above_studying_degree_in_malaysia_full": 3,
"noc_18_above_studying_degree_in_malaysia_half": 4,
"noc_18_above_studying_diploma_in_malaysia_full": 5,
"noc_18_above_studying_diploma_in_malaysia_half": 6,
"noc_18_above_studying_at_least_degree_outside_malaysia_full": 7,
"noc_18_above_studying_at_least_degree_outside_malaysia_half": 8,
"noc_disabled_full": 9,
"noc_disabled_half": 1,
"noc_disabled_studying_at_least_diploma_full": 2,
"noc_disabled_studying_at_least_diploma_half": 2,
"accumulated_month": "September",
"accumulated_month_year": "01/10/2018"
},
"location_attributes": {
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": 12345,
"state": null,
"country_name": "Singapore"
}
}
}
| Name | Description |
|---|---|
| invite_user | If true will create a talenox user for the employee and invite them |
| employee_id | Employee ID |
| first_name required | First name |
| last_name | Last name |
| chinese_name | Chinese name |
| nickname | Nickname |
| identification_full_name | Identification full name |
| email required | Email address |
| hired_date | Hired date |
| confirmation_date | Confirmation date |
| resign_date | Resign date |
| contact_number | Contact number |
| office_did | Office Direct Inward Dialing (DID) Number |
| ssn required | Identification number |
| ssn_should_validate | Should valdate identification number |
| citizenship required | Immigration status |
| nationality | Nationality |
| gender | Gender |
| race | Race |
| religion | Religion |
| marital_status | Marital status |
| birthdate | Birth date |
| passport_number | Passport number |
| passport_date_of_issue | Passport issue date |
| passport_date_of_expiry | Passport expiry date |
| passport_place_of_issue | Passport place of issue |
| vaccination_status | Vaccination status |
| vaccine_brand | Vaccine brand |
| date_of_first_dose | Date of first dose |
| date_of_second_dose | Date of second dose |
| vaccine_booster_brand | Vaccine booster brand |
| date_of_booster_dose | Date of second dose |
| vaccination_remarks | Vaccination remarks |
| payment_method required | Payment type |
| cost_centre_id | Default Cost centre ID (Same as default_cost_centre_id) |
| default_cost_centre_id | Default Cost centre ID (Set the company setting api_allows_employee_multiple_cost_centres to true to avoid resetting employee cost centres when changing default_cost_centre_id value) |
| cost_centre_ids | Cost centre IDs (to assign employee to multiple cost centres) |
| blood_group | Blood group |
| leaving_country | Leaving country |
| employee_attachment_access | Employee attachment access |
| accounting_split | Accounting split |
| employee_can_update_custom_fields | Employee can update custom fields |
| employee_attachment_access | Employee attachment access |
| reason_for_cessation | Reason for cessation |
| other_reason_for_cessation | Other reason for cessation |
| custom_fields | Custom fields |
| current_job_parameters | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| current_job_parameters[basic_pay_item_parameters] | Below are Basic Pay Item related fields |
| current_job_parameters[rate_of_pay] | Rate of pay |
| current_job_parameters[currency] | Currency |
| current_job_parameters[amount] | Basic pay amount |
| bank_account_parameters | Below are Employee's Bank Account related fields |
| bank_type | Bank name |
| bank_code | Bank code |
| account_name | Bank account name |
| number | Bank account number |
| branch_code | Branch code |
| branch_name | Branch name |
| swift_code | Bank swift code |
| payment_code | Payment code (Hang Seng and HSBC only) |
| dbs_company_id | DBS company ID (DBS only) |
| employee_using_cheque | Employee using cheque |
| location_parameters | Below are Employee's Address related fields |
| line_1 | Address line 1 |
| line_2 | Address line 2 |
| postal_code | Postal code |
| state | State |
| country_name | Country name |
| additional_my_employee_info_parameters | Below are MY Employee's related fields |
| is_contributing_epf | Is employee contributing to EPF (For Malaysia employee) |
| epf_number | EPF number |
| employee_epf_setting | Employee EPF setting |
| employer_epf_setting | Employer EPF setting |
| pcb_number | PCB number |
| socso_setting | SOCSO setting |
| socso_number | SOCSO number |
| disabled_individual | Is Disabled individual |
| disabled_spouse | Is Disabled spouse |
| pcb_borne_by_employer | Pcb borne by employer |
| has_eis | Has EIS |
| zakat_number | Zakat Number |
| zakat_amount | Zakat Amount |
| is_contributing_hrdf | Contribute HRDF? (For Malaysia employee) |
| accumulated_remuneration_bik_vola | Accumulated remuneration/Benefit-In-Kind (BIK)/Value Of Living Accomodation (VOLA) |
| accumulated_deductions_epf_and_other_funds | Accumulated EPF and Other Approved Funds [do not include life premium insurance] |
| accumulated_deductions_mtd | Accumulated MTD paid (including MTD on additional remuneration) |
| accumulated_deductions_zakat_paid | Accumulated Zakat paid |
| accumulated_deductions_medical_treatment_special_needs_or_carer | Accumulated Medical expenses for own parents, special need and parent care |
| accumulated_deductions_father_relief | Accumulated Father Relief |
| accumulated_deductions_mother_relief | Accumulated Mother Relief |
| accumulated_deductions_basic_supporting_equipment | Accumulated Basic supporting equipment for disabled self, spouse, child or parent |
| accumulated_deductions_higher_education_fees_self | Accumulated Education fees |
| accumulated_deductions_medical_expenses_on_serious_diseases | Accumulated Medical expenses on serious diseases for self, spouse or child |
| accumulated_deductions_complete_medical_examination | Accumulated Complete medical examination for self, spouse or child |
| accumulated_deductions_net_deposit_in_sspn | Accumulated Net deposit in Skim Simpanan Pendidikan Nasional (SSPN) |
| accumulated_deductions_payment_of_alimony_to_former_wife | Accumulated Payment of alimony to former wife |
| accumulated_deductions_contribution_to_private_retirement_schem | Accumulated Deferred annuity premium or contribution to Private Retriement Scheme |
| accumulated_deductions_education_and_medical_insurance | Accumulated Education and medical insurance premium |
| accumulated_deductions_interest_on_housing_loan | Accumulated Interest on Housing Loan |
| accumulated_deductions_tax_deduction_for_lifestyle | Accumulated Purchase of readings, computer, smartphone, tablet, sport equipment, gymnasium membership and subscription of broadband internet |
| accumulated_deductions_tax_deduction_for_purchase_of_breastfeed | Accumulated Purchase of Breastfeeding Equipment(deduction is allowed once every 2 years for women tax payer only) |
| accumulated_deductions_tax_deduction_for_fees_paid_to_child_car | Accumulated Fees paid to Child Care Centre and Kindergartens |
| accumulated_deductions_socso_payment | Accumulated SOCSO Contribution |
| accumulated_deductions_life_insurance_for_retired_civil_servant | Accumulated life insurance for retired civil servant |
| accumulated_deductions_life_insurance_for_other_than_retired_ci | Accumulated life insurance for other than retired civil servant |
| accumulated_deductions_sports_equipment_rental_registration_fee | Accumulated sports equipment for sports activities |
| accumulated_deductions_purchase_of_personal_computer_smartphone | Accumulated purchase of personal computer, smartphone or tablet |
| accumulated_deductions_fee_at_registered_premises_and_tourist_a | Accumulated accommodation fee at the accommodation premises registered |
| accumulated_deductions_expenses_on_electric_vehicle_charging_fa | Accumulated expenses on Electric Vehicle Charging Facilities and equipment |
| noc_under_18_full | Eligible children full deduction(RM2000 each) |
| noc_under_18_half | Eligible children half deduction(RM2000 each) |
| noc_18_above_studying_degree_in_malaysia_full | Above 18 years and studying full time in Degree level onwards (inside Malaysia) (Full deduction) |
| noc_18_above_studying_degree_in_malaysia_half | Above 18 years and studying full time in Degree level onwards (inside Malaysia) (Half deduction) |
| noc_18_above_studying_diploma_in_malaysia_full | Above 18 years and studying full time in diploma level onwards (inside Malaysia) (Full deduction) |
| noc_18_above_studying_diploma_in_malaysia_half | Above 18 years and studying full time in diploma level onwards (inside Malaysia) (Half deduction) |
| noc_18_above_studying_at_least_degree_outside_malaysia_full | Above 18 years and studying full time in Degree level onwards (outside Malaysia) (Full deduction) |
| noc_18_above_studying_at_least_degree_outside_malaysia_half | Above 18 years and studying full time in Degree level onwards (outside Malaysia) (Half deduction) |
| noc_disabled_full | Disabled children (Full deduction) |
| noc_disabled_half | Disabled children (Half deduction) |
| noc_disabled_studying_at_least_diploma_full | Disabled child studying in diploma or higher level (in Malaysia)/degree or its equivalent (outside Malaysia) |
| noc_disabled_studying_at_least_diploma_half | Disabled child studying in diploma or higher level (in Malaysia)/degree or its equivalent (outside Malaysia) |
| accumulated_month | Accumulated month |
| accumulated_year | Accumulated year |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 793,
"employee_id": "1",
"first_name": "Hafsah",
"middle_name": null,
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "2015-01-01",
"resign_date": null,
"confirmation_date": "2019-01-01",
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": "123456789",
"office_did": null,
"ssn": "S1111111D",
"ssn_should_validate": true,
"citizenship": "Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Married and Spouse Not Working",
"passport_number": "MA123456",
"passport_date_of_issue": "2017-01-01",
"passport_date_of_expiry": "2022-12-01",
"passport_place_of_issue": "Singapore",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "2015-01-01",
"slug": "hafsah-haigh-68ae23a8",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "2021-01-01",
"date_of_second_dose": "2021-11-01",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "2021-12-01",
"vaccination_remarks": "",
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"cost_centres": [],
"default_cost_centre": null,
"current_job": {
"id": 49,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 49,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [],
"bank_account": {
"id": 930,
"bank_type": "DBS",
"bank_code": "1",
"branch_code": "1",
"branch_name": null,
"number": "131231231231231231",
"dbs_company_id": "",
"swift_code": "DBSSMY2A",
"account_name": "Hafsah Haigh",
"payment_code": "1",
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1067,
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": "12345",
"state": null,
"country_name": "Singapore",
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": null,
"additional_my_employee_info": {
"is_contributing_epf": true,
"epf_number": "123456789",
"employee_epf_setting": "Statutory Default",
"employer_epf_setting": "12%",
"pcb_number": "12312312",
"socso_setting": "Employment Injury Scheme and Invalidity Scheme",
"socso_number": "123123124",
"citizenship": "Resident",
"disabled_individual": false,
"disabled_spouse": false,
"pcb_borne_by_employer": false,
"has_eis": true,
"zakat_number": "123123123",
"is_contributing_hrdf": true,
"zakat_amount": "1000.0",
"accumulated_remuneration_bik_vola": "50.2",
"accumulated_deductions_epf_and_other_funds": "100.9",
"accumulated_deductions_mtd": "700.22",
"accumulated_deductions_zakat_paid": "500.4",
"accumulated_year": "2018",
"accumulated_deductions_socso_payment": "0.0",
"accumulated_deductions_medical_treatment_special_needs_or_carer": "50.4",
"accumulated_deductions_father_relief": "2000.9",
"accumulated_deductions_mother_relief": "3020.0",
"accumulated_deductions_basic_supporting_equipment": "2400.0",
"accumulated_deductions_higher_education_fees_self": "5090.0",
"accumulated_deductions_medical_expenses_on_serious_diseases": "1900.0",
"accumulated_deductions_complete_medical_examination": "990.0",
"accumulated_deductions_net_deposit_in_sspn": "13123.0",
"accumulated_deductions_payment_of_alimony_to_former_wife": "500.12",
"accumulated_deductions_contribution_to_private_retirement_schem": "1000.2",
"accumulated_deductions_education_and_medical_insurance": "2000.59",
"accumulated_deductions_interest_on_housing_loan": "290.1",
"accumulated_deductions_tax_deduction_for_lifestyle": "900.5",
"accumulated_deductions_tax_deduction_for_purchase_of_breastfeed": "200.0",
"accumulated_deductions_tax_deduction_for_fees_paid_to_child_car": "1300.0",
"accumulated_deductions_skills_improvement_self_improvement_cour": "0.0",
"accumulated_deductions_vaccination_expenses": "0.0",
"accumulated_deductions_sports_equipment_rental_registration_fee": "0.0",
"accumulated_deductions_purchase_of_personal_computer_smartphone": "0.0",
"accumulated_deductions_fee_at_registered_premises_and_tourist_a": "0.0",
"accumulated_deductions_expenses_on_electric_vehicle_charging_fa": "0.0",
"noc_under_18_full": 1,
"noc_under_18_half": 2,
"noc_18_above_studying_degree_in_malaysia_full": 3,
"noc_18_above_studying_degree_in_malaysia_half": 4,
"noc_18_above_studying_diploma_in_malaysia_full": 5,
"noc_18_above_studying_diploma_in_malaysia_half": 6,
"noc_18_above_studying_at_least_degree_outside_malaysia_full": 7,
"noc_18_above_studying_at_least_degree_outside_malaysia_half": 8,
"noc_disabled_full": 9,
"noc_disabled_half": 1,
"noc_disabled_studying_at_least_diploma_full": 2,
"noc_disabled_studying_at_least_diploma_half": 2,
"accumulated_month": "September",
"accumulated_month_year": "2018-09-01",
"accumulated_deductions_life_insurance_for_retired_civil_servant": "0.0",
"accumulated_deductions_life_insurance_for_other_than_retired_ci": "0.0",
"socso_first_contribution_month_year": null
},
"additional_id_employee_info": null
}
Create SG Employee
Request
Endpoint
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4dfacbdc469063d90999a2a4b696f15d62e01f4c
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "S Pass",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": 12,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"basic_pay_item_attributes": {
"rate_of_pay": "Monthly",
"currency": "SGD",
"amount": 4000
}
},
"bank_account_attributes": {
"bank_type": "DBS",
"bank_code": 1,
"account_name": "Hafsah Haigh",
"number": 131231231231231231,
"branch_code": 1,
"branch_name": "",
"swift_code": "",
"payment_code": 1,
"dbs_company_id": ""
},
"additional_sg_employee_info_attributes": {
"cpf_donation_type": "N/A",
"cpf_additional_donation_type": "N/A",
"identification_issue_date": "",
"identification_expiry_date": "",
"spass_expiry_date": "01/01/2022",
"spass_issue_date": "01/01/2015",
"spass_dcs": "",
"epass_expiry_date": "",
"epass_issue_date": "",
"pr_status": "",
"pr_effective_date": "",
"pr_expiry_date": "",
"pepass_issue_date": "",
"pepass_expiry_date": "",
"wp_issue_date": "",
"wp_expiry_date": "",
"wp_worker_category": "",
"wp_dcs": "",
"wp_number": "",
"shg_override_amount": 0,
"letter_of_consent_issue_date": "",
"letter_of_consent_expiry_date": "",
"halal_certification_issue_date": "",
"halal_certification_expiry_date": "",
"hygiene_certification_issue_date": "",
"hygiene_certification_expiry_date": ""
},
"location_attributes": {
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": 12345,
"state": null,
"country_name": "Singapore"
},
"cost_centre_ids": [
12,
13
]
}
}
| Name | Description |
|---|---|
| invite_user | If true will create a talenox user for the employee and invite them |
| employee_id | Employee ID |
| first_name required | First name |
| last_name | Last name |
| chinese_name | Chinese name |
| nickname | Nickname |
| identification_full_name | Identification full name |
| email required | Email address |
| hired_date | Hired date |
| confirmation_date | Confirmation date |
| resign_date | Resign date |
| contact_number | Contact number |
| office_did | Office Direct Inward Dialing (DID) Number |
| ssn required | Identification number |
| ssn_should_validate | Should valdate identification number |
| citizenship required | Immigration status |
| nationality | Nationality |
| gender | Gender |
| race | Race |
| religion | Religion |
| marital_status | Marital status |
| birthdate | Birth date |
| passport_number | Passport number |
| passport_date_of_issue | Passport issue date |
| passport_date_of_expiry | Passport expiry date |
| passport_place_of_issue | Passport place of issue |
| vaccination_status | Vaccination status |
| vaccine_brand | Vaccine brand |
| date_of_first_dose | Date of first dose |
| date_of_second_dose | Date of second dose |
| vaccine_booster_brand | Vaccine booster brand |
| date_of_booster_dose | Date of second dose |
| vaccination_remarks | Vaccination remarks |
| payment_method required | Payment type |
| cost_centre_id | Default Cost centre ID (Same as default_cost_centre_id) |
| default_cost_centre_id | Default Cost centre ID (Set the company setting api_allows_employee_multiple_cost_centres to true to avoid resetting employee cost centres when changing default_cost_centre_id value) |
| cost_centre_ids | Cost centre IDs (to assign employee to multiple cost centres) |
| blood_group | Blood group |
| leaving_country | Leaving country |
| employee_attachment_access | Employee attachment access |
| accounting_split | Accounting split |
| employee_can_update_custom_fields | Employee can update custom fields |
| employee_attachment_access | Employee attachment access |
| reason_for_cessation | Reason for cessation |
| other_reason_for_cessation | Other reason for cessation |
| custom_fields | Custom fields |
| current_job_parameters | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| current_job_parameters[basic_pay_item_parameters] | Below are Basic Pay Item related fields |
| current_job_parameters[rate_of_pay] | Rate of pay |
| current_job_parameters[currency] | Currency |
| current_job_parameters[amount] | Basic pay amount |
| bank_account_parameters | Below are Employee's Bank Account related fields |
| bank_type | Bank name |
| bank_code | Bank code |
| account_name | Bank account name |
| number | Bank account number |
| branch_code | Branch code |
| branch_name | Branch name |
| swift_code | Bank swift code |
| payment_code | Payment code (Hang Seng and HSBC only) |
| dbs_company_id | DBS company ID (DBS only) |
| employee_using_cheque | Employee using cheque |
| location_parameters | Below are Employee's Address related fields |
| line_1 | Address line 1 |
| line_2 | Address line 2 |
| postal_code | Postal code |
| state | State |
| country_name | Country name |
| additional_sg_employee_info_parameters | Below are SG Employee's related fields |
| cpf_donation_type | SHG donation type |
| cpf_additional_donation_type | Additional SHG donation type |
| identification_expiry_date | Identification expiry date. When you use the API to update this field, we will map to the immigration expiry field. E.g. for Spass holders, we will map to spass_expiry_date. |
| identification_issue_date | Identification issue date. When you use the API to update this field, we will map to the immigration issue field. E.g. for Spass holders, we will map to spass_issue_date. |
| spass_expiry_date | S Pass expiry date |
| spass_issue_date | S Pass issue date |
| spass_dcs | S Pass Dependency Ceiling |
| epass_number | E Pass Number |
| epass_expiry_date | E Pass expiry date |
| epass_issue_date | E Pass issue date |
| pr_status | PR status |
| pr_effective_date | PR effective date |
| pr_expiry_date | PR expiry date |
| pepass_issue_date | PE Pass issue date |
| pepass_expiry_date | PE Pass expiry date |
| wp_expiry_date | Work Pass expiry date |
| wp_issue_date | Work Pass issue date |
| techpass_expiry_date | Tech Pass expiry date |
| techpass_issue_date | Tech Pass issue date |
| onepass_expiry_date | ONE Pass expiry date |
| onepass_issue_date | ONE Pass issue date |
| wp_worker_category | Work Pass worker category |
| wp_dcs | Work Pass dependency ceiling |
| wp_number | Work Pass Number |
| shg_automation_enabled | Infer SHG contribution fields from ["citizenship", "race", "religion"]. If passed true, you can omit both cpf_donation_type and cpf_additional_donation_type fields. If unable to determine, object will fail to save |
| shg_contribution_amount_option | SHG contribution amount option (["statutory_default", "custom_shg_amount"]) |
| shg_override_amount | Special cases where SHG needs to be overriden with CPF approval (For MBMF, use this field for auto splitting, or override Mosque Building and Mendaki amounts using the following two fields) |
| shg_mbmf_mbf_override_amount | Special cases where Mosque Building portion needs to be overriden with CPF approval (For MBMF custom amount only) |
| shg_mbmf_mendaki_override_amount | Special cases where Mendaki Portion needs to be overriden with CPF approval (For MBMF custom amount only) |
| letter_of_consent_expiry_date | Letter of consent expiry date |
| letter_of_consent_issue_date | Letter of consent issue date |
| halal_certification_issue_date | Halal certification issue date |
| halal_certification_expiry_date | Halal certification expiry date |
| hygiene_certification_issue_date | Hygiene certification issue date |
| hygiene_certification_expiry_date | Hygiene certification expiry date |
| additional_shg_contribution_amount_option | Additional SHG contribution amount option (["statutory_default", "custom_shg_amount"]) |
| additional_shg_override_amount | Additional SHG override amount |
| additional_shg_mbmf_mbf_override_amount | Additional SHG override - Mosque Building amount |
| additional_shg_mbmf_mendaki_override_amount | Additional SHG override - Mendaki amount |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 791,
"employee_id": "1",
"first_name": "Hafsah",
"middle_name": null,
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "2015-01-01",
"resign_date": null,
"confirmation_date": "2019-01-01",
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": "123456789",
"office_did": null,
"ssn": "S1111111D",
"ssn_should_validate": true,
"citizenship": "S Pass",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "2017-01-01",
"passport_date_of_expiry": "2022-12-01",
"passport_place_of_issue": "Singapore",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "2015-01-01",
"slug": "hafsah-haigh-56e62329",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "2021-01-01",
"date_of_second_dose": "2021-11-01",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "2021-12-01",
"vaccination_remarks": "",
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"cost_centres": [
{
"id": 12,
"name": "Maren Locks",
"employee_ids": [
791
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null
},
{
"id": 13,
"name": "Tierra Pass",
"employee_ids": [
791
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null
}
],
"default_cost_centre": {
"id": 12,
"name": "Maren Locks",
"employee_ids": [
791
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null
},
"current_job": {
"id": 47,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 47,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [],
"bank_account": {
"id": 920,
"bank_type": "DBS",
"bank_code": "1",
"branch_code": "1",
"branch_name": null,
"number": "131231231231231231",
"dbs_company_id": "",
"swift_code": "DBSSSGSGXXX",
"account_name": "Hafsah Haigh",
"payment_code": "1",
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1049,
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": "12345",
"state": null,
"country_name": "Singapore",
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "N/A",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": "2022-01-01",
"identification_issue_date": "2015-01-01",
"spass_expiry_date": "2022-01-01",
"spass_issue_date": "2015-01-01",
"spass_dcs": "",
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "",
"pr_effective_date": null,
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": "",
"wp_dcs": "",
"wp_number": "",
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null,
"techpass_issue_date": null,
"techpass_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": null
}
Delete Employee
Request
Endpoint
DELETE https://api.talenox.com/api/v2/employees/806
Accept: application/json
Content-Type: application/json
Authorization: Bearer e831d8888600f19d96bfe6c3ff0fee8d4aa8cdfe
DELETE https://api.talenox.com/api/v2/employees/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted employee 00001"
}
Get Employee
Request
Endpoint
GET https://api.talenox.com/api/v2/employees/801
Accept: application/json
Content-Type: application/json
Authorization: Bearer 01485bf27ceb1db80770a625cae5b5dcf097570b
GET https://api.talenox.com/api/v2/employees/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 801,
"employee_id": "00001",
"first_name": "Granville",
"middle_name": null,
"last_name": "Fadel",
"identification_full_name": null,
"email": "lonna@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2022-12-02",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "Male",
"marital_status": null,
"passport_number": null,
"passport_date_of_issue": null,
"passport_date_of_expiry": null,
"passport_place_of_issue": null,
"chinese_name": null,
"nickname": null,
"birthdate": "2001-12-16",
"slug": "granville-fadel-6a6b5081",
"vaccination_status": null,
"vaccine_brand": null,
"date_of_first_dose": null,
"date_of_second_dose": null,
"vaccine_booster_brand": null,
"date_of_booster_dose": null,
"vaccination_remarks": null,
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {},
"cost_centres": [],
"default_cost_centre": null,
"current_job": null,
"jobs": [],
"next_of_kins": [],
"bank_account": {
"id": 952,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Granville Fadel",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1103,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-12-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null,
"techpass_issue_date": null,
"techpass_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2022-12-02",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
}
List All Employees
Request
Endpoint
GET https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer 19762f14ff5d8e14058baab64d11f99f85bb8fa8
GET https://api.talenox.com/api/v2/employees
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 795,
"employee_id": "00001",
"first_name": "Shalon",
"middle_name": null,
"last_name": "Miller",
"identification_full_name": null,
"email": "alissa@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2024-05-19",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "Female",
"marital_status": null,
"passport_number": null,
"passport_date_of_issue": null,
"passport_date_of_expiry": null,
"passport_place_of_issue": null,
"chinese_name": null,
"nickname": null,
"birthdate": "1991-12-16",
"slug": "shalon-miller-bb98de58",
"vaccination_status": null,
"vaccine_brand": null,
"date_of_first_dose": null,
"date_of_second_dose": null,
"vaccine_booster_brand": null,
"date_of_booster_dose": null,
"vaccination_remarks": null,
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {},
"cost_centres": [],
"default_cost_centre": null,
"current_job": {
"id": 51,
"title": "Title1",
"department": null,
"start_date": "19/05/2024",
"end_date": null,
"remarks": null,
"amount": "8063.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 51,
"title": "Title1",
"department": null,
"start_date": "19/05/2024",
"end_date": null,
"remarks": null,
"amount": "8063.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [],
"bank_account": {
"id": 938,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Shalon Miller",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1081,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-12-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null,
"techpass_issue_date": null,
"techpass_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2024-05-19",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
},
{
"id": 796,
"employee_id": "00002",
"first_name": "Keren",
"middle_name": null,
"last_name": "Russel",
"identification_full_name": null,
"email": "norman.mante@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2023-09-04",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "Female",
"marital_status": null,
"passport_number": null,
"passport_date_of_issue": null,
"passport_date_of_expiry": null,
"passport_place_of_issue": null,
"chinese_name": null,
"nickname": null,
"birthdate": "1996-12-16",
"slug": "keren-russel-0190a576",
"vaccination_status": null,
"vaccine_brand": null,
"date_of_first_dose": null,
"date_of_second_dose": null,
"vaccine_booster_brand": null,
"date_of_booster_dose": null,
"vaccination_remarks": null,
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {},
"cost_centres": [],
"default_cost_centre": null,
"current_job": null,
"jobs": [],
"next_of_kins": [],
"bank_account": {
"id": 940,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Keren Russel",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1084,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-12-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null,
"techpass_issue_date": null,
"techpass_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2023-09-04",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
},
{
"id": 797,
"employee_id": "00003",
"first_name": "Teddy",
"middle_name": null,
"last_name": "Brakus",
"identification_full_name": null,
"email": "sally.hayes@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2024-05-22",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "Female",
"marital_status": null,
"passport_number": null,
"passport_date_of_issue": null,
"passport_date_of_expiry": null,
"passport_place_of_issue": null,
"chinese_name": null,
"nickname": null,
"birthdate": "1987-12-16",
"slug": "teddy-brakus-4449d7dc",
"vaccination_status": null,
"vaccine_brand": null,
"date_of_first_dose": null,
"date_of_second_dose": null,
"vaccine_booster_brand": null,
"date_of_booster_dose": null,
"vaccination_remarks": null,
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {},
"cost_centres": [],
"default_cost_centre": null,
"current_job": null,
"jobs": [],
"next_of_kins": [],
"bank_account": {
"id": 942,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Teddy Brakus",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1087,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-12-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null,
"techpass_issue_date": null,
"techpass_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2024-05-22",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
}
]
Update Employee
Request
Endpoint
PUT https://api.talenox.com/api/v2/employees/803
Accept: application/json
Content-Type: application/json
Authorization: Bearer d580903f9bddec550de63d94e268f68941032e21
PUT https://api.talenox.com/api/v2/employees/:id
Parameters
{
"employee": {
"first_name": "Mary",
"last_name": "Lan"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 803,
"employee_id": "00001",
"first_name": "Mary",
"middle_name": null,
"last_name": "Lan",
"identification_full_name": null,
"email": "jarrod@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2024-02-27",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "Female",
"marital_status": null,
"passport_number": null,
"passport_date_of_issue": null,
"passport_date_of_expiry": null,
"passport_place_of_issue": null,
"chinese_name": null,
"nickname": null,
"birthdate": "2002-12-16",
"slug": "mary-lan-95f77aba",
"vaccination_status": null,
"vaccine_brand": null,
"date_of_first_dose": null,
"date_of_second_dose": null,
"vaccine_booster_brand": null,
"date_of_booster_dose": null,
"vaccination_remarks": null,
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {},
"cost_centres": [],
"default_cost_centre": null,
"current_job": null,
"jobs": [],
"next_of_kins": [],
"bank_account": {
"id": 958,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Gladis Stamm",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1113,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-12-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null,
"techpass_issue_date": null,
"techpass_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2024-02-27",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
}
Jobs
Create Job
Request
Endpoint
POST https://api.talenox.com/api/v2/jobs
Accept: application/json
Content-Type: application/json
Authorization: Bearer a5c82c0edab1ea3e49470b7b2e0b73c77ad91bf8
POST https://api.talenox.com/api/v2/jobs
Parameters
{
"title": "",
"employee_id": 839,
"job": {
"title": "Testing job",
"department": "Testing Department",
"start_date": "03/05/2019",
"end_date": "31/05/2020",
"currency": "SGD",
"amount": 1000,
"rate_of_pay": "Monthly",
"remarks": "Testing remark"
}
}
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| title | Job Title |
| department | Job Department |
| start_date required | Job Start Date |
| end_date required | Job End Date |
| rate_of_pay | Rate of pay |
| amount | Basic pay amount |
| currency | Currency |
| remarks | Job Remarks |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 60,
"title": "Testing job",
"department": "Testing Department",
"start_date": "03/05/2019",
"end_date": "31/05/2020",
"remarks": "Testing remark",
"amount": "1000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
Delete Job
Request
Endpoint
DELETE https://api.talenox.com/api/v2/jobs/66
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9a53fc0e596cfcd2d152ac010593295a930de30d
DELETE https://api.talenox.com/api/v2/jobs/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted job 66"
}
Get Job
Request
Endpoint
GET https://api.talenox.com/api/v2/jobs/63
Accept: application/json
Content-Type: application/json
Authorization: Bearer 34a1cfe8692a7564c4032329e3c95d6a8c9bb6b1
GET https://api.talenox.com/api/v2/jobs/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 63,
"title": "Title1",
"department": null,
"start_date": "16/12/2024",
"end_date": null,
"remarks": null,
"amount": "3038.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
Update Job
Request
Endpoint
PUT https://api.talenox.com/api/v2/jobs/64
Accept: application/json
Content-Type: application/json
Authorization: Bearer 90f849271b9e9a04abc91b2a71759bd2acc749cd
PUT https://api.talenox.com/api/v2/jobs/:id
Parameters
{
"job": {
"title": "Updated job",
"department": "Updated Department",
"currency": "HKD",
"start_date": "01/01/2017",
"end_date": "03/01/2019",
"amount": 2000,
"rate_of_pay": "Daily"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 64,
"title": "Updated job",
"department": "Updated Department",
"start_date": "01/01/2017",
"end_date": "03/01/2019",
"remarks": null,
"amount": "2000.0",
"rate_of_pay": "Daily",
"currency": "HKD"
}
Leave
List All Leave Applications
Request
Endpoint
GET https://api.talenox.com/api/v2/leave??employee_ids[]=1016
Accept: application/json
Content-Type: application/json
Authorization: Bearer a27958a52b7a55fce322c5209d10c229b8fd89fd
GET https://api.talenox.com/api/v2/leave?
Parameters
?employee_ids: ["1016"]
| Name | Description |
|---|---|
| employee_ids required | Employee IDs |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 61,
"leave_type": "Annual Leave",
"company_id": 359,
"employee_id": 1016,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2024-12-16",
"start_date_which_half": "AM",
"end_at": "2024-12-16",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2024-12-16",
"leave_duration_type": "All Day",
"derived_duration_qty": 1
}
],
"number_of_levels": 1,
"approvers": [],
"admin_approver": null
},
{
"id": 62,
"leave_type": "Annual Leave",
"company_id": 359,
"employee_id": 1016,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2024-12-16",
"start_date_which_half": "AM",
"end_at": "2024-12-16",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2024-12-16",
"leave_duration_type": "All Day",
"derived_duration_qty": 1
}
],
"number_of_levels": 1,
"approvers": [],
"admin_approver": null
},
{
"id": 63,
"leave_type": "Annual Leave",
"company_id": 359,
"employee_id": 1016,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2024-12-16",
"start_date_which_half": "AM",
"end_at": "2024-12-16",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2024-12-16",
"leave_duration_type": "All Day",
"derived_duration_qty": 1
}
],
"number_of_levels": 1,
"approvers": [],
"admin_approver": null
}
]
Leave Applications (BETA)
Approve leave
This approves a pending leave application
Request
Endpoint
PATCH https://api.talenox.com/api/v2/leave_beta/applications/approve/21
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
PATCH https://api.talenox.com/api/v2/leave_beta/applications/approve/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 21,
"timestamp": "2024-12-16T14:20:51.806+08:00"
}
Create leave application
Request
Endpoint
POST https://api.talenox.com/api/v2/leave_beta/applications
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
POST https://api.talenox.com/api/v2/leave_beta/applications
Parameters
{
"employee_id": 923,
"category_id": 51,
"category": "type",
"start_date": "2024-12-02",
"end_date": "2024-12-02",
"remarks": "test",
"working_days": [
{
"date": "2024-12-02",
"type": "full_day"
}
],
"applied_durations": [
{
"date": "2024-12-02",
"type": "full_day"
}
],
"approvers": [
{
"approver_id": 933,
"level": 1
}
]
}
| Name | Description |
|---|---|
| approver_id required | Employee ID |
| category required | 'type' or 'oil' |
| employee_id required | Employee ID |
| applied_durations | json array of duration json object with date (YYYY-MM-DD) and type as attributes. type must be 'full_day', 'first_half' or 'second_half'. See Leave Application flow for details |
| working_days | json array of working_day json object with date (YYYY-MM-DD) and type as attributes. type must be 'full_day', 'first_half', 'second_half', 'holiday' or 'not_working' |
| category_id | Leave Type ID for 'type' category, Off In Lieu ID for 'oil' category |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"leave_application_id": 20
}
Delete leave application
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/applications/15
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
DELETE https://api.talenox.com/api/v2/leave_beta/applications/:id
Parameters
| Name | Description |
|---|---|
| id required | Leave Application ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 15,
"status": "success",
"timestamp": "2024-12-16T14:20:38.024+08:00"
}
Delete leave attachments
Deletes up to 10 attachment ids
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/attachments?ids=4,2
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
DELETE https://api.talenox.com/api/v2/leave_beta/attachments
Parameters
ids: 4,2
| Name | Description |
|---|---|
| ids required | comma separated Attachment IDs |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Attachments deleted successfully",
"errors": {
"2": "no attachment found"
},
"timestamp": "2024-12-16T14:21:28.885+08:00"
}
Get leave application by id
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications/14
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
GET https://api.talenox.com/api/v2/leave_beta/applications/:id
Parameters
| Name | Description |
|---|---|
| overlap_from required | Date in YYYY-MM-DD |
| overlap_to required | Date in YYYY-MM-DD |
| employee_id | Employee ID |
| approver_id | Employee ID of leave approver |
| category | 'type' or 'oil' |
| category_id | Leave Type ID for 'type' category, Off In Lieu ID for 'oil' category |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"amount": "1.0",
"approvers": null,
"attachments": [
{
"attachment_id": 2,
"filename": "dummy_image.png",
"file_size": 31798,
"file_url": "/uploads/attachment/219/923/2/dummy_image.png",
"file_preview_url": "/uploads/attachment/219/923/2/preview_dummy_image.png"
}
],
"category_class": "type",
"category_id": 74,
"created_at": "2024-12-16T06:20:33.997Z",
"employee_id": 923,
"end_date": "2024-12-16",
"end_time": "PM",
"id": 14,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-12-16",
"start_time": "AM",
"status": "pending",
"updated_at": "2024-12-16T06:20:33.997Z"
}
List all leave applications
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications?overlap_from=2024-12-16&overlap_to=2024-12-17
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
GET https://api.talenox.com/api/v2/leave_beta/applications
Parameters
overlap_from: 2024-12-16
overlap_to: 2024-12-17
| Name | Description |
|---|---|
| overlap_from required | Date in YYYY-MM-DD |
| overlap_to required | Date in YYYY-MM-DD |
| created_start | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| created_end | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| modified_start | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| modified_end | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| leave_application_status | leave application status - pending, approved or rejected |
| employee_id | Employee ID |
| approver_id | Employee ID |
| category | 'type' or 'oil' |
| category_id | Leave Type ID for 'type' category, Off In Lieu ID for 'oil' category |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 61,
"created_at": "2024-12-16T06:20:09.265Z",
"employee_id": 923,
"end_date": "2024-12-16",
"end_time": "PM",
"id": 1,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-12-16",
"start_time": "AM",
"status": "pending",
"updated_at": "2024-12-16T06:20:09.265Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 62,
"created_at": "2024-12-16T06:20:09.892Z",
"employee_id": 923,
"end_date": "2024-12-16",
"end_time": "PM",
"id": 2,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-12-16",
"start_time": "AM",
"status": "pending",
"updated_at": "2024-12-16T06:20:09.892Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 63,
"created_at": "2024-12-16T06:20:10.508Z",
"employee_id": 923,
"end_date": "2024-12-16",
"end_time": "PM",
"id": 3,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-12-16",
"start_time": "AM",
"status": "pending",
"updated_at": "2024-12-16T06:20:10.508Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": [
{
"attachment_id": 1,
"filename": "dummy_image.png",
"file_size": 31798,
"file_url": "/uploads/attachment/219/923/1/dummy_image.png",
"file_preview_url": "/uploads/attachment/219/923/1/preview_dummy_image.png"
}
],
"category_class": "type",
"category_id": 64,
"created_at": "2024-12-16T06:20:11.182Z",
"employee_id": 923,
"end_date": "2024-12-16",
"end_time": "PM",
"id": 4,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-12-16",
"start_time": "AM",
"status": "pending",
"updated_at": "2024-12-16T06:20:11.182Z"
}
]
List all leave applications by application status and created dates
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications?overlap_from=2024-12-16&overlap_to=2024-12-17&created_start=2024-12-16&created_end=2024-12-17&leave_application_status=pending
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
GET https://api.talenox.com/api/v2/leave_beta/applications
Parameters
overlap_from: 2024-12-16
overlap_to: 2024-12-17
created_start: 2024-12-16
created_end: 2024-12-17
leave_application_status: pending
| Name | Description |
|---|---|
| overlap_from required | Date in YYYY-MM-DD |
| overlap_to required | Date in YYYY-MM-DD |
| created_start | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| created_end | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| modified_start | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| modified_end | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| leave_application_status | leave application status - pending, approved or rejected |
| employee_id | Employee ID |
| approver_id | Employee ID |
| category | 'type' or 'oil' |
| category_id | Leave Type ID for 'type' category, Off In Lieu ID for 'oil' category |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 65,
"created_at": "2024-12-16T06:20:13.761Z",
"employee_id": 923,
"end_date": "2024-12-16",
"end_time": "PM",
"id": 5,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-12-16",
"start_time": "AM",
"status": "pending",
"updated_at": "2024-12-16T06:20:13.761Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 66,
"created_at": "2024-12-16T06:20:14.425Z",
"employee_id": 923,
"end_date": "2024-12-16",
"end_time": "PM",
"id": 6,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-12-16",
"start_time": "AM",
"status": "pending",
"updated_at": "2024-12-16T06:20:14.425Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 67,
"created_at": "2024-12-16T06:20:15.149Z",
"employee_id": 923,
"end_date": "2024-12-16",
"end_time": "PM",
"id": 7,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-12-16",
"start_time": "AM",
"status": "pending",
"updated_at": "2024-12-16T06:20:15.149Z"
}
]
Reject leave
This rejects a pending leave application
Request
Endpoint
PATCH https://api.talenox.com/api/v2/leave_beta/applications/reject/28
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
PATCH https://api.talenox.com/api/v2/leave_beta/applications/reject/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 28,
"timestamp": "2024-12-16T14:21:19.156+08:00"
}
Upload leave attachment
Upload a leave attachment with multipart/form-data. Required parameters are Leave application id, employee id and file
Request
Endpoint
POST https://api.talenox.com/api/v2/leave_beta/attachments/upload
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
POST https://api.talenox.com/api/v2/leave_beta/attachments/upload
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="leave_application_id"
30
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="employee_id"
923
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="file"; filename="dummy_image.png"
content-type: image/png
content-length: 31798
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
None known.
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"attachment_id": 3
}
delete multiple leave applications
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/applications?employee_id=923&leave_application_ids=11
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwJyZDuvAOQtCmEW-M_JbZ5SnjM3rZQxNWxgq18XDTc
DELETE https://api.talenox.com/api/v2/leave_beta/applications
Parameters
employee_id: 923
leave_application_ids: 11
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Leave application ids for input employee id 923 processed successfully",
"errors": {},
"timestamp": "2024-12-16T14:20:32.400+08:00"
}
Leave Approval Structure (BETA)
Add new levels to a leave approval structure
Request
Endpoint
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/123/levels
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/levels
Parameters
{
"approvers": [
{
"approver_ids": [
944
],
"level": 2
}
]
}
| Name | Description |
|---|---|
| approver_ids required | json array of approver_ids and approval level |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"approvers": [
{
"level": 1,
"approvers": [
952
]
},
{
"level": 2,
"approvers": [
944
]
}
],
"company_default": true,
"id": 123,
"levels": 2,
"name": "Structure uiqlzqqhkd",
"number_of_employees": 2
}
Assign approvers to an existing level of a leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/117/assign_approvers
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/assign_approvers
Parameters
{
"approvers": [
{
"approver_ids": [
944
],
"level": 1
}
]
}
| Name | Description |
|---|---|
| approver_ids required | json array of approver_ids and approval level |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"approvers": [
{
"level": 1,
"approvers": [
952,
944
]
}
],
"company_default": true,
"id": 117,
"levels": 1,
"name": "Structure uiktmmn0v9",
"number_of_employees": 2
}
Assign employees to a leave approval structure
This returns an array of employee ids of an leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/111/assign_employees?employee_ids=944,952
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/assign_employees
Parameters
employee_ids: 944,952
| Name | Description |
|---|---|
| employee_ids required | comma separated Employee IDs |
| last_employee_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"assigned_employee_ids": [
944,
952
]
}
List all leave approval structures for a company
returns an array of leave approval structures for an authorized user's company
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures?company_id=271
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures
Parameters
company_id: 271
| Name | Description |
|---|---|
| company_id required | Company ID |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"approvers": [
{
"level": 1,
"approvers": [
952
]
}
],
"company_default": true,
"id": 95,
"levels": 1,
"name": "Structure teii916r2r",
"number_of_employees": 2
}
]
List employees assigned to a leave approval structure
returns an array of employee ids of an leave approval structure
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/108/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/employees
Parameters
| Name | Description |
|---|---|
| company_id required | Company ID |
| last_employee_id | For pagination. Results returned will start from this employee id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
944,
953
]
Remove levels to a leave approval structure
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/126/levels
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/levels
Parameters
{
"levels": [
1
]
}
| Name | Description |
|---|---|
| approver_ids required | json array of approver_ids and approval level |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "levels removed successfully",
"errors": [],
"timestamp": "2024-12-16T14:22:51.827+08:00"
}
Unassign approvers to an existing level of a leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/120/unassign_approvers
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/unassign_approvers
Parameters
{
"approvers": [
{
"approver_ids": [
952
],
"level": 1
}
]
}
| Name | Description |
|---|---|
| approver_ids required | json array of approver_ids and approval level |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "approvers unassigned successfully",
"errors": [],
"timestamp": "2024-12-16T14:22:38.959+08:00"
}
Unassign employees of a leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/114/unassign_employees?employee_ids=944,952
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/unassign_employees
Parameters
employee_ids: 944,952
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "employees unassigned successfully",
"errors": [
{
"message": "employee not found in leave approval structure",
"employee_id": 952
}
],
"timestamp": "2024-12-16T14:22:26.860+08:00"
}
creates a leave approval structure
Request
Endpoint
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures
Parameters
{
"name": "new Test LAS ",
"company_id": 271,
"company_default": false,
"employee_ids": [
944,
952
]
}
| Name | Description |
|---|---|
| name required | Employee ID |
| company_id required | 'type' or 'oil' |
| company_default | COMPANY ID |
| employee_ids | json array of Employee ids. These employees will be assigned to the leave approval structure |
| approver_order | acceptable values: 'no_order', 'ascending_order', 'descending_order'. Sets the order of leave applications approval' emails. No order: Approval emails will be sent to all approvers at the same time. Ascending order: Approval emails will be send to 1st level then 2nd level. Descending order: approval emails be will sent to 2nd Level then 1st Level Approvers |
| flexible_approval_structure | false (Not Flexible), true (Flexible). Not flexible means all levels have to be assigned an approver during leave application. Flexible means some levels can not assigned for further flexibility during leave application |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"approvers": [],
"company_default": false,
"id": 94,
"levels": 0,
"name": "new Test LAS ",
"number_of_employees": 0
}
deletes a leave approval structure
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/107
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "leave approval structure deleted successfully",
"timestamp": "2024-12-16T14:22:08.280+08:00"
}
gets a leave approval structure by id
returns a single leave approval structure for the given id
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/98
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id
Parameters
| Name | Description |
|---|---|
| id required | Leave Approval Structure ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"approvers": [
{
"level": 1,
"approvers": [
952
]
}
],
"company_default": true,
"id": 98,
"levels": 1,
"name": "Structure m6d7b4hehl",
"number_of_employees": 2
}
updates a leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/101
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffc9KnXQqdwLKfPHsZ5LrhTyp8uWD62K08iv8IEFsTo
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id
Parameters
{
"name": "new Test LAS 2",
"company_id": 271,
"employee_ids": [
944,
952
]
}
| Name | Description |
|---|---|
| name required | Employee ID |
| company_id required | 'type' or 'oil' |
| company_default required | COMPANY ID |
| employee_ids | json array of Employee ids. These employees will be assigned to the leave approval structure |
| approver_order | acceptable values: 'no_order', 'ascending_order', 'descending_order'. Sets the order of leave applications approval' emails. No order: Approval emails will be sent to all approvers at the same time. Ascending order: Approval emails will be send to 1st level then 2nd level. Descending order: approval emails be will sent to 2nd Level then 1st Level Approvers |
| flexible_approval_structure | false (Not Flexible), true (Flexible). Not flexible means all levels have to be assigned an approver during leave application. Flexible means some levels can not assigned for further flexibility during leave application |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"approvers": [
{
"level": 1,
"approvers": [
952
]
}
],
"company_default": true,
"id": 101,
"levels": 1,
"name": "new Test LAS 2",
"number_of_employees": 2
}
Leave Approvers (BETA)
List a leave approver for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/approvers?employee_id=979&approver_id=38
Accept: application/json
Content-Type: application/json
Authorization: Bearer WYa3FhwhqCv2F9Zn0LodVJaf5R6cL-13FHe5z7PnrxE
GET https://api.talenox.com/api/v2/leave_beta/approvers
Parameters
employee_id: 979
approver_id: 38
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| approver_id | Employee ID for Approver |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"approver_ids": [
989
],
"level": 1,
"flexible": false
}
]
List all leave approvers for an employee
This returns an array of leave approval structures for an authorized user's company
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/approvers?employee_id=979
Accept: application/json
Content-Type: application/json
Authorization: Bearer WYa3FhwhqCv2F9Zn0LodVJaf5R6cL-13FHe5z7PnrxE
GET https://api.talenox.com/api/v2/leave_beta/approvers
Parameters
employee_id: 979
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| approver_id | Employee ID for Approver |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"approver_ids": [
989
],
"level": 1,
"flexible": false
}
]
Leave Off in Lieus (BETA)
Get off in lieu balance for all off in lieus of an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance?employee_id=1005&query_date=20241216&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer lVeVm52KbTSr4FhVFlMKVTQ7qTQCdXWZZEubfhyuMq4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance
Parameters
employee_id: 1005
query_date: 20241216
limit: 5
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| id | Off In Lieu ID |
| query_date required | Query Date in YYYY-MM-DD format |
| last_seen_id | Last seen Employee ID for pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"employee_id": 1005,
"query_date": "2024-12-16",
"timestamp": "2024-12-16T14:23:29.044+08:00",
"results": [
{
"balance": 1.0,
"errors": [],
"leave_type_id": 4
}
]
}
Get off in lieu balance for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance?employee_id=1005&query_date=20241216&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer lVeVm52KbTSr4FhVFlMKVTQ7qTQCdXWZZEubfhyuMq4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance
Parameters
employee_id: 1005
query_date: 20241216
limit: 5
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| id | Off In Lieu ID |
| query_date required | Query Date in YYYY-MM-DD format |
| last_seen_id | Last seen Employee ID for pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"employee_id": 1005,
"query_date": "2024-12-16",
"timestamp": "2024-12-16T14:23:29.410+08:00",
"results": [
{
"balance": 1.0,
"errors": [],
"leave_type_id": 5
}
]
}
Get off in lieu by id
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer lVeVm52KbTSr4FhVFlMKVTQ7qTQCdXWZZEubfhyuMq4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 3,
"name": "Off day",
"policy_end_date": "2025-01-16",
"policy_start_date": "2024-12-16",
"quantity_type": "day"
}
Get off in lieu entitlement for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/entitlement_period?employee_id=1005&id=6&query_date=20241216
Accept: application/json
Content-Type: application/json
Authorization: Bearer lVeVm52KbTSr4FhVFlMKVTQ7qTQCdXWZZEubfhyuMq4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/entitlement_period
Parameters
employee_id: 1005
id: 6
query_date: 20241216
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| id required | Off In Lieu ID |
| query_date required | Query Date in YYYY-MM-DD format |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"employee_id": 1005,
"leave_type_id": 6,
"query_date": "2024-12-16",
"timestamp": "2024-12-16T14:23:29.717+08:00",
"valid_periods": {
"end_date": "2025-01-16",
"errors": [],
"start_date": "2024-12-16"
}
}
List all off in lieus
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
Accept: application/json
Content-Type: application/json
Authorization: Bearer lVeVm52KbTSr4FhVFlMKVTQ7qTQCdXWZZEubfhyuMq4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
Parameters
| Name | Description |
|---|---|
| employee_id | Employee ID |
| id | Off in Lieu ID |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 1,
"name": "Off day",
"policy_end_date": "2025-01-16",
"policy_start_date": "2024-12-16",
"quantity_type": "day"
}
]
List off in lieus for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus?employee_id=1005&id=2
Accept: application/json
Content-Type: application/json
Authorization: Bearer lVeVm52KbTSr4FhVFlMKVTQ7qTQCdXWZZEubfhyuMq4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
Parameters
employee_id: 1005
id: 2
| Name | Description |
|---|---|
| employee_id | Employee ID |
| id | Off in Lieu ID |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 2,
"name": "Off day",
"policy_end_date": "2025-01-16",
"policy_start_date": "2024-12-16",
"quantity_type": "day"
}
]
Leave Types (BETA)
Get leave balance for a leave type of an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/balance?employee_id=995&id=140&query_date=20241216
Accept: application/json
Content-Type: application/json
Authorization: Bearer K7YTgc0HJBfRK9c5xM8sJoAbFEJCdBQVUV5F-QA-zXE
GET https://api.talenox.com/api/v2/leave_beta/types/balance
Parameters
employee_id: 995
id: 140
query_date: 20241216
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| id | Leave Type ID |
| query_date required | Query Date in YYYY-MM-DD format |
| last_seen_id | Last seen Employee ID for pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"employee_id": 995,
"query_date": "2024-12-16",
"timestamp": "2024-12-16T14:23:19.669+08:00",
"results": [
{
"balance": 7.0,
"errors": [],
"leave_type_id": 140
}
]
}
Get leave balance for all leave types of an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/balance?employee_id=995&query_date=20241216&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer K7YTgc0HJBfRK9c5xM8sJoAbFEJCdBQVUV5F-QA-zXE
GET https://api.talenox.com/api/v2/leave_beta/types/balance
Parameters
employee_id: 995
query_date: 20241216
limit: 5
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| id | Leave Type ID |
| query_date required | Query Date in YYYY-MM-DD format |
| last_seen_id | Last seen Employee ID for pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"employee_id": 995,
"query_date": "2024-12-16",
"timestamp": "2024-12-16T14:23:19.441+08:00",
"results": [
{
"balance": 7.0,
"errors": [],
"leave_type_id": 140
},
{
"balance": null,
"errors": [
"Employee has no registered children (requires date of birth and nationality).",
"Unverified next-of-kin, please contact your admin.",
"Required conditional date(s) not found."
],
"leave_type_id": 141
},
{
"balance": null,
"errors": [
"Employee has no registered children (requires date of birth and nationality).",
"Unverified next-of-kin, please contact your admin.",
"Required conditional date(s) not found."
],
"leave_type_id": 142
},
{
"balance": null,
"errors": [
"Employee has no registered children (requires date of birth and nationality).",
"Unverified next-of-kin, please contact your admin.",
"Required conditional date(s) not found."
],
"leave_type_id": 143
},
{
"balance": 365.0,
"errors": [],
"leave_type_id": 144
}
]
}
Get leave entitlement for an employee and leave type
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/entitlement_period?employee_id=995&id=140&query_date=20241216
Accept: application/json
Content-Type: application/json
Authorization: Bearer K7YTgc0HJBfRK9c5xM8sJoAbFEJCdBQVUV5F-QA-zXE
GET https://api.talenox.com/api/v2/leave_beta/types/entitlement_period
Parameters
employee_id: 995
id: 140
query_date: 20241216
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| id required | Leave Type ID |
| query_date required | Query Date in YYYY-MM-DD format |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"employee_id": 995,
"leave_type_id": 140,
"query_date": "2024-12-16",
"timestamp": "2024-12-16T14:23:19.849+08:00",
"valid_periods": [
{
"end_date": "2023-12-31",
"errors": [],
"start_date": "2023-12-16"
},
{
"end_date": "2024-12-31",
"errors": [],
"start_date": "2024-01-01"
}
]
}
Get leave type by id
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/140
Accept: application/json
Content-Type: application/json
Authorization: Bearer K7YTgc0HJBfRK9c5xM8sJoAbFEJCdBQVUV5F-QA-zXE
GET https://api.talenox.com/api/v2/leave_beta/types/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 140,
"name": "Annual Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
}
List all leave types
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types
Accept: application/json
Content-Type: application/json
Authorization: Bearer K7YTgc0HJBfRK9c5xM8sJoAbFEJCdBQVUV5F-QA-zXE
GET https://api.talenox.com/api/v2/leave_beta/types
Parameters
| Name | Description |
|---|---|
| employee_id | Employee ID |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 140,
"name": "Annual Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 141,
"name": "Child Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 142,
"name": "Extended Child Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 143,
"name": "Maternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 144,
"name": "No Pay Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 145,
"name": "Paternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 146,
"name": "Shared Parental Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 147,
"name": "Sick Leave - Outpatient",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 148,
"name": "Sick Leave - Hospitalisation",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 149,
"name": "Unpaid Infant Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
}
]
List all leave types for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types?employee_id=995&last_seen_id=141&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer K7YTgc0HJBfRK9c5xM8sJoAbFEJCdBQVUV5F-QA-zXE
GET https://api.talenox.com/api/v2/leave_beta/types
Parameters
employee_id: 995
last_seen_id: 141
limit: 5
| Name | Description |
|---|---|
| employee_id | Employee ID |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 142,
"name": "Extended Child Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 143,
"name": "Maternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 144,
"name": "No Pay Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 145,
"name": "Paternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 146,
"name": "Shared Parental Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
}
]
Metadata
To fetch all possible values for the given fields
Get Metadata Items
Request
Endpoint
POST https://api.talenox.com/api/v2/metadata/get_items
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4913914e7992536243871e02bdf78aaa3e644246
POST https://api.talenox.com/api/v2/metadata/get_items
Parameters
{
"fields": [
"company",
"marital_status",
"gender",
"payment_method",
"rate_of_pay",
"country_name",
"region",
"citizenship",
"nationality",
"race",
"religion",
"bank_type",
"currency",
"relationship",
"wp_worker_category",
"cpf_donation_type",
"wp_dcs",
"spass_dcs",
"voluntary_employer_contribution_type",
"voluntary_employee_contribution_type",
"voluntary_employer_contribution_rate",
"voluntary_employee_contribution_rate",
"socso_setting",
"employee_epf_setting",
"employer_epf_setting",
"period",
"pay_item_types"
]
}
| Name | Description |
|---|---|
| fields required | List of parameters |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"company": {
"id": 363,
"name": "Turner-King"
}
},
{
"marital_status": [
"Single",
"Widowed",
"Separated",
"Married",
"Divorced"
]
},
{
"gender": [
"Male",
"Female"
]
},
{
"payment_method": [
"Cheque",
"Cash",
"Bank Transfer",
"Forex Transfer"
]
},
{
"rate_of_pay": [
"Monthly",
"Daily",
"Hourly"
]
},
{
"country_name": [
"Åland Islands",
"Afghanistan",
"Albania",
"Algeria",
"American Samoa",
"Andorra",
"Angola",
"Anguilla",
"Antarctica",
"Antigua and Barbuda",
"Argentina",
"Armenia",
"Aruba",
"Australia",
"Austria",
"Azerbaijan",
"Bahamas",
"Bahrain",
"Bangladesh",
"Barbados",
"Belarus",
"Belgium",
"Belize",
"Benin",
"Bermuda",
"Bhutan",
"Bolivia",
"Bonaire, Sint Eustatius and Saba",
"Bosnia and Herzegovina",
"Botswana",
"Bouvet Island",
"Brazil",
"British Indian Ocean Territory",
"Brunei",
"Bulgaria",
"Burkina Faso",
"Burundi",
"Cambodia",
"Cameroon",
"Canada",
"Canary Islands",
"Cape Verde",
"Cayman Islands",
"Central African Republic",
"Chad",
"Channel Islands",
"Chile",
"China",
"Christmas Island",
"Cocos (Keeling Islands)",
"Colombia",
"Comoros",
"Cook Islands",
"Costa Rica",
"Cote D'Ivoire (Ivory Coast)",
"Croatia",
"Cuba",
"Curaco",
"Cyprus",
"Czech Republic",
"Democratic Republic of the Congo",
"Denmark",
"Djibouti",
"Dominica",
"Dominican Republic",
"East Timor",
"Ecuador",
"Egypt",
"El Salvador",
"Equatorial Guinea",
"Eritrea",
"Estonia",
"Ethiopia",
"Falkland Islands (Islas Malvinas)",
"Faroe Islands",
"Fiji",
"Finland",
"France",
"France, Metropolitan",
"French Guiana",
"French Polynesia",
"French Southern Territories",
"French West Indies",
"Gabon",
"Gambia",
"Georgia",
"Germany",
"Ghana",
"Gibraltar",
"Great Britain",
"Greece",
"Greenland",
"Grenada",
"Guadeloupe",
"Guam",
"Guatemala",
"Guernsey",
"Guinea",
"Guinea-Bissau",
"Guyana",
"Haiti",
"Hawaii",
"Heard and McDonald Islands",
"Honduras",
"Hong Kong",
"Hungary",
"Iceland",
"India",
"Indonesia",
"Iran",
"Iraq",
"Ireland",
"Isle of Man",
"Israel",
"Italy",
"Jamaica",
"Japan",
"Jersey",
"Jordan",
"Kazakhstan",
"Kenya",
"Kiribati",
"Korea North",
"Korea South",
"Kosovo",
"Kurdistan",
"Kuwait",
"Kyrgyzstan",
"Laos",
"Latvia",
"Lebanon",
"Lesotho",
"Liberia",
"Libya",
"Liechtenstein",
"Lithuania",
"Luxembourg",
"Macau",
"Macedonia",
"Madagascar",
"Malaysia",
"Malawi",
"Maldives",
"Mali",
"Malta",
"Marshall Islands",
"Martinique",
"Mauritania",
"Mauritius",
"Mayotte",
"Mexico",
"Micronesia",
"Midway Islands",
"Moldova",
"Monaco",
"Mongolia",
"Montenegro",
"Montserrat",
"Morocco",
"Mozambique",
"Myanmar",
"Namibia",
"Nauru",
"Nepal",
"Netherlands Antilles",
"Netherlands",
"Nevis",
"New Caledonia",
"New Zealand",
"Nicaragua",
"Niger",
"Nigeria",
"Niue",
"Norfolk Island",
"Northern Mariana Islands",
"Norway",
"Oman",
"Pakistan",
"Palau",
"Palestinian Territories",
"Panama",
"Papua New Guinea",
"Paraguay",
"Peru",
"Philippines",
"Pitcairn Islands",
"Poland",
"Portugal",
"Puerto Rico",
"Qatar",
"Republic of Serbia",
"Republic of the Congo",
"Reunion",
"Romania",
"Russia",
"Rwanda",
"Saint Barthelemy",
"Saint Helena",
"Saint Kitts and Nevis",
"Saint Lucia",
"Saint Martin (French part)",
"Sint Maarten (Dutch part)",
"Saint Pierre and Miquelon",
"Saint Vincent and the Grenadines",
"Saipan",
"Samoa",
"Samoa American",
"San Marino",
"Sao Tome and Principe",
"Saudi Arabia",
"Senegal",
"Serbia",
"Seychelles",
"Sierra Leone",
"Singapore",
"Slovakia",
"Slovenia",
"Solomon Islands",
"Somalia",
"South Africa",
"South Georgia and the South Sandwich Islands",
"South Sudan",
"Spain",
"Sri Lanka",
"Sudan",
"Suriname",
"Svalbard",
"Swaziland",
"Sweden",
"Switzerland",
"Syria",
"Tahiti",
"Taiwan",
"Tajikistan",
"Tanzania",
"Thailand",
"Togo",
"Tokelau",
"Tonga",
"Trinidad and Tobago",
"Tunisia",
"Turkey",
"Turkmenistan",
"Turks and Caicos Islands",
"Tuvalu",
"Uganda",
"Ukraine",
"United Arab Emirates",
"United Kingdom",
"United States",
"Uruguay",
"US Minor Outlying Islands",
"Uzbekistan",
"Vanuatu",
"Vatican City State",
"Venezuela",
"Vietnam",
"Virgin Islands (British)",
"Virgin Islands (US)",
"Wake Island",
"Wallis and Futuna Islands",
"Western Sahara",
"Yemen",
"Yugoslavia",
"Zaire",
"Zambia",
"Zimbabwe"
]
},
{
"region": []
},
{
"citizenship": [
"Singapore Citizen",
"Singapore PR",
"S Pass",
"E Pass",
"Personalised Employment Pass",
"Letter of Consent(Dependent Pass, Long term visit pass)",
"Work Permit",
"Student Visa (No CPF, No SDL)",
"Contract (No CPF, No SDL)",
"Contract With SDL (No CPF, W/SDL)",
"Work Holiday Pass(No CPF)",
"EntrePass",
"Intern",
"Passport (Oversea Director)",
"Tech Pass",
"Overseas Networks & Expertise Pass",
"Training Employment Pass",
"Training Work Permit"
]
},
{
"nationality": [
"Afghan",
"Albanian",
"Algerian",
"American",
"Andorran",
"Angolan",
"Anguillan",
"Antiguan",
"Argentine",
"Armenian",
"Arubian",
"Australian",
"Austrian",
"Azerbaijani",
"Bahamian",
"Bahraini",
"Bangladeshi",
"Barbadian",
"Barbudans",
"Batswana",
"Belarusian",
"Belgian",
"Belizean",
"Beninese",
"Bermudan",
"Bhutanese",
"Bolivian",
"Bosnian",
"Brazilian",
"British",
"British National (Overseas)",
"Bruneian",
"Bulgarian",
"Burkinabe",
"Burmese",
"Burundian",
"Cambodian",
"Cameroonian",
"Canadian",
"Cape Verdean",
"Caymanian",
"Central African",
"Chadian",
"Chilean",
"Chinese",
"Christmas Islander",
"Cocossian",
"Colombian",
"Cook Islander",
"Comoran",
"Congolese",
"Costa Rican",
"Croatian",
"Cuban",
"Cypriot",
"Czech",
"Danish",
"Djibouti",
"Dominican",
"Dutch",
"Ecuadorean",
"Egyptian",
"Emirian",
"Equatorial Guinean",
"Eritrean",
"Estonian",
"Ethiopian",
"Falkland Irishslander",
"Faroese",
"Fijian",
"Filipino",
"Finnish",
"French",
"French Guianese",
"French Polynesian",
"Gabonese",
"Gambian",
"Georgian",
"German",
"Ghanaian",
"Gibraltarian",
"Greek",
"Greenlander",
"Grenadian",
"Guadeloupean",
"Guamanian",
"Guatemalan",
"Guinea Bissauan",
"Guinean",
"Guyanese",
"Haitian",
"Herzegovinian",
"Honduran",
"Hong Kongers",
"Hong Kong Chinese",
"Hungarian",
"I-kiribati",
"Icelander",
"Indian",
"Indonesian",
"Iranian",
"Iraqi",
"Irish",
"Israeli",
"Italian",
"Ivorian",
"Jamaican",
"Japanese",
"Jordanian",
"Kazakhstani",
"Kenyan",
"Kittian And Nevisian",
"Kuwaiti",
"Kyrgyz",
"Laotian",
"Latvian",
"Lebanese",
"Liberian",
"Libyan",
"Liechtensteiner",
"Lithuanian",
"Luxembourger",
"Macau",
"Macedonian",
"Malagasy",
"Malawian",
"Malaysian",
"Maldivan",
"Malian",
"Maltese",
"Manx",
"Marshallese",
"Martinican",
"Mauritanian",
"Mauritian",
"Mexican",
"Micronesian",
"Moldovan",
"Monacan",
"Mongolian",
"Montenegrin",
"Montserratian",
"Moroccan",
"Mosotho",
"Motswana",
"Mozambican",
"Myanmarese",
"Namibian",
"Nauruan",
"Nepalese",
"Nevisian",
"New Caledonian",
"New Zealander",
"Ni Vanuatu",
"Nicaraguan",
"Nigerian",
"Nigerien",
"Niuean",
"Norfolk Islander",
"North Korean",
"Northern Irish",
"Norwegian",
"Omani",
"Pakistani",
"Palauan",
"Palestinian",
"Panamanian",
"Papua New Guinean",
"Paraguayan",
"Peruvian",
"Polish",
"Portuguese",
"Puerto Rican",
"Qatari",
"Romanian",
"Russian",
"Rwandan",
"Saint Lucian",
"Saint Vincentian",
"Salvadorean",
"Samoan",
"Sanmarinese",
"Sao Tomean",
"Saudi",
"Scottish",
"Senegalese",
"Serbian",
"Seychellois",
"Sierra Leonean",
"Singaporean",
"Slovakian",
"Slovenian",
"Solomon Islander",
"Somali",
"South African",
"South Korean",
"Spanish",
"Sri Lankan",
"Sudanese",
"Surinamer",
"Swazi",
"Swedish",
"Swiss",
"Syrian",
"Taiwanese",
"Tajik",
"Tanzanian",
"Thai",
"Timorese",
"Togolese",
"Tokelauan",
"Tongan",
"Trinidadian Or Tobagonian",
"Tunisian",
"Turkish",
"Turkmen",
"Tuvaluan",
"Ugandan",
"Ukrainian",
"Uruguayan",
"Uzbekistani",
"Venezuelan",
"Vietnamese",
"Welsh",
"Western Saharan",
"Yemenite",
"Zambian",
"Zimbabwean"
]
},
{
"race": [
"African",
"African-American",
"Bidayuh",
"Bumiputra",
"Caucasian",
"Chinese",
"Eurasian",
"Filipino",
"Iban",
"Indian",
"Japanese",
"Korean",
"Malay",
"Thai",
"Others"
]
},
{
"religion": [
"Taoism",
"Buddhism",
"Confucianism",
"Bahá'í Faith",
"Islam",
"Catholicism",
"Christianity",
"Hinduism",
"Sikhism",
"Judaism",
"Jainism",
"Others",
"No Religion",
"Free Thinker"
]
},
{
"bank_type": [
"DBS",
"HSBC",
"Standard Chartered",
"RHB",
"POSB",
"POSB Plus",
"OCBC",
"Maybank - Singapore Branch",
"CIMB",
"UOB",
"Citibank N.A Singapore Branch (CNAS)",
"Crédit Agricole",
"Commerzbank",
"Allahabad",
"ANZ",
"HSBC Corporate",
"Bank of China",
"India - HDFC Bank",
"ASB Bank Limited(New Zealand)",
"UBS AG",
"India - State Bank of India",
"India - The Federal Bank Ltd",
"India - Canara Bank",
"ICICI Bank",
"Sydbank",
"Sumitomo Mitsui Banking Corporation",
"Mizuho Corporate Bank, Ltd",
"AXIS Bank",
"DnB NOR Bank ASA",
"Shinhan",
"BNP Paribas",
"The Bank of Tokyo-Mitsubishi UFJ, Ltd",
"Citibank Singapore Limited (CSL)",
"Pakistan - Bank AlHabib",
"Pakistan - Habib Limited Bank",
"Industrial and Commercial Bank of China Limited",
"JP Morgan Chase Bank, N.A",
"Pakistan - Bank Alfalah Limited",
"Italy - Banca Prealpi SanBiagio",
"Commonwealth Bank of Australia",
"CA Indosuez",
"Pakistan - Meezan Bank",
"Vietnam - Asia Commercial Joint Stock Bank",
"State Bank of India",
"Pakistan - MCB Bank Limited",
"United Kingdom - Nationwide Building Society",
"Indonesia - BCA",
"Thailand - Bangkok Bank",
"Sri Lanka - Commercial Bank of Ceylon",
"Sri Lanka - Sampath Bank",
"Sri Lanka - National Development Bank",
"Bangkok Bank",
"Vietnam Techcombank",
"Indonesia - Mandiri Bank",
"Brazil - Banco Maxima Bank",
"United Kingdom - Monzo Bank Limited",
"United Kingdom - Barclays Bank",
"Thailand - Krungthai Bank",
"Indonesia - OCBC NISP",
"Bangkok Bank Public Company Limited",
"Malaysia - Maybank",
"Vietnam - Vietcombank",
"Indonesia - Bank Negara",
"Thailand - Kasikornbank",
"Indonesia - Permata Bank",
"Malaysia - UOB",
"Malaysia - RHB Bank",
"Thailand - Siam Commercial Bank",
"Australia - National Australia Bank",
"Malaysia - HSBC Amanah",
"Denmark - Lan and Spar Bank",
"United States - Bank of America",
"India - Indian Overseas Bank",
"Wise",
"Korea - KEB Hana Bank",
"Switzerland - Sygnum Bank",
"Malaysia - Public Bank",
"Airwallex",
"Maybank - Singapore Limited",
"Bank of America"
]
},
{
"currency": [
"SGD",
"HKD",
"MYR",
"USD",
"QAR",
"EUR",
"AUD",
"THB",
"PHP",
"IDR",
"INR",
"GBP",
"CAD",
"NZD",
"VND",
"BND",
"CNY",
"MMK",
"KRW",
"TWD",
"DKK",
"KHR",
"JPY",
"AED",
"PKR",
"SEK",
"ZAR",
"LKR",
"CHF",
"NPR",
"KES",
"RUB",
"RWF",
"KYD",
"MOP"
]
},
{
"relationship": [
"Wife",
"Husband",
"Daughter",
"Son",
"Mother",
"Father",
"Sister",
"Brother",
"Others"
]
},
{
"wp_worker_category": [
"Skilled",
"Unskilled"
]
},
{
"cpf_donation_type": [
"MBMF",
"CDAC",
"SINDA",
"ECF",
"N/A"
]
},
{
"wp_dcs": [
"Basic Tier / Tier 1: Up to 10% of the total workforce",
"Tier 2: Above 10% to 25% of the total workforce",
"Tier 3: Above 25% to 40% of the total workforce"
]
},
{
"spass_dcs": [
"Basic Tier / Tier 1: Up to 10% of the total workforce",
"Tier 2: Above 10% to 25% of the total workforce",
"Tier 3: Above 25% to 40% of the total workforce"
]
},
{
"voluntary_employer_contribution_type": [
"Percentage",
"Fixed Amount"
]
},
{
"voluntary_employee_contribution_type": [
"Percentage",
"Fixed Amount"
]
},
{
"voluntary_employer_contribution_rate": [
"5%",
"6%",
"7%",
"8%",
"9%",
"10%",
"11%",
"12%",
"13%",
"14%",
"15%"
]
},
{
"voluntary_employee_contribution_rate": [
"5%",
"6%",
"7%",
"8%",
"9%",
"10%",
"11%",
"12%",
"13%",
"14%",
"15%"
]
},
{
"socso_setting": [
"N/A",
"Automatic scheme selection based on age",
"Employment Injury Scheme and Invalidity Scheme",
"Employment Injury Scheme",
"Foreign Workers Social Security"
]
},
{
"employee_epf_setting": [
"Statutory Default",
"4%",
"5.5%",
"7%",
"8%",
"9%",
"10%",
"11%",
"12%",
"13%",
"14%",
"15%",
"16%",
"17%",
"18%",
"19%",
"20%",
"21%",
"22%",
"23%",
"24%",
"25%",
"26%",
"27%",
"28%",
"29%",
"30%",
"32%",
"46.6%"
]
},
{
"employer_epf_setting": [
"Statutory Default",
"N/A",
"6%",
"6.5%",
"12%",
"13%",
"14%",
"15%",
"16%",
"17%",
"18%",
"19%",
"20%",
"21%",
"22%",
"23%",
"24%",
"25%",
"26%",
"27%",
"28%",
"29%",
"30%",
"32%"
]
},
{
"period": [
"Whole Month",
"Whole Month (no monthly pay items)",
"1st Half of Month",
"2nd Half of Month"
]
},
{
"pay_item_types": {
"Recurring": [
"Basic Pay",
"Basic Pay(without proration)",
"Allowance",
"Allowance(without proration)",
"Deduction",
"Deduction (from Net Salary)",
"IR21 Tax Withholding",
"Commission (Daily/Weekly/Monthly)",
"Extra Duty Allowance",
"Housing/ Rental Allowance",
"Incentive Allowance",
"Meal Allowance",
"Per Diem Allowance",
"Transport Allowance",
"Tips",
"Director fees",
"Bonus",
"Others",
"Deduction (from Net Salary)(no SHG contribution)",
"Commission (AW)",
"Medisave",
"Deduction Community Chest"
],
"Adhoc": [
"Reimbursements",
"Advance Pay",
"Allowance",
"Deduction",
"Commission (Irregular)",
"Extra Duty Allowance",
"Festive Allowance",
"Housing/ Rental Allowance",
"Incentive",
"Incentive Allowance",
"IR21 Tax Withholding",
"Meal Allowance",
"Per Diem Allowance",
"Per Diem Reimbursement",
"Transport Allowance",
"Referral of Employees Fees",
"Benefits in Kind",
"Gifts in Kind",
"Share Option Sale",
"Termination Benefits",
"Tips",
"Annual Wage Supplement",
"Bonus",
"Prior Year Bonus",
"Prior Year AWS",
"Leave Pay",
"Director fees",
"Backdated Salary Increment",
"Backdated Salary",
"Deduction (from Net Salary)",
"Others",
"Others(no gross)",
"Salary in lieu",
"Onboarding incentive",
"Gratuity paid for years of service",
"Compensation for loss of employment",
"Deduction (from Net Salary)(no SHG contribution)",
"NS Leave Claims Deduction",
"Flexi-Benefit Personal Insurance",
"Flexi-Benefit Optical Expenses",
"Flexi-Benefit Health Screening & Vaccinations",
"Flexi-Benefit Childcare / Eldercare Fees For Dependants",
"Flexi-Benefit Medical Expenses For Dependants",
"Flexi-Benefit Dental Expenses For Dependants",
"Flexi-Benefit Gym Membership",
"Flexi-Benefit Holiday Expenses",
"Flexi-Benefit TCM / CHIRO/ PHYSIO",
"Gratuity",
"Flexi-Benefit Work From Home",
"Flexi-Benefit Mental Health Awareness",
"Flexi-Benefit Personal Planning & Enrichment",
"Flexi-Benefit Home Affairs Support",
"Flexi-Benefit Home Family Bonding Facilitation",
"Flexi-Benefit Professional Subscription"
],
"Attendance": [
"Regular Hours",
"Overtime Hours",
"Regular Days",
"Overtime Days",
"Public Holiday Pay",
"Rest Day Pay",
"Deputy Awage",
"Deputy"
]
}
}
]
Next of Kins
Create Next of Kin
Request
Endpoint
POST https://api.talenox.com/api/v2/next_of_kins
Accept: application/json
Content-Type: application/json
Authorization: Bearer d672af276f7f1c8c2e6514ef58eaacfa5e272268
POST https://api.talenox.com/api/v2/next_of_kins
Parameters
{
"employee_id": 1027,
"next_of_kin": {
"name": "NOK Name",
"birthdate": "01/01/2018",
"relationship": "Wife",
"gender": "Male",
"citizenship": "Singaporean",
"ssn": "12345678"
}
}
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| name required | Name |
| birthdate | Birth Date |
| relationship required | Relationship |
| gender | Gender |
| citizenship | Citizenship |
| ssn | Identification Number |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 2,
"employee_id": 1027,
"name": "NOK Name",
"relationship": "Wife",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2018-01-01",
"gender": "Male",
"marriage_date": null,
"ssn": "12345678",
"passport": null,
"citizenship": "Singaporean"
}
Delete Next of Kin
Request
Endpoint
DELETE https://api.talenox.com/api/v2/next_of_kins/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer 85a9d5f8351397b4d09e0dc31f76795f171ba457
DELETE https://api.talenox.com/api/v2/next_of_kins/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted next of kin Name"
}
Get Next of Kin
Request
Endpoint
GET https://api.talenox.com/api/v2/next_of_kins/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer f8f99b4ca09bb98513b54808e35d3f2541b34230
GET https://api.talenox.com/api/v2/next_of_kins/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1038,
"name": "Name",
"relationship": "Son",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2024-12-16",
"gender": null,
"marriage_date": null,
"ssn": null,
"passport": null,
"citizenship": "Singaporean"
}
Update Next of Kin
Request
Endpoint
PUT https://api.talenox.com/api/v2/next_of_kins/4
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3a29022ce52a284fb7b768a7191807ca5232afc5
PUT https://api.talenox.com/api/v2/next_of_kins/:id
Parameters
{
"next_of_kin": {
"name": "Change name"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 4,
"employee_id": 1049,
"name": "Change name",
"relationship": "Son",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2024-12-16",
"gender": null,
"marriage_date": null,
"ssn": null,
"passport": null,
"citizenship": "Singaporean"
}
Payroll
Create Adhoc Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/adhoc_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer d4a6063ef96078f6ac224c869419c4c8abd025c4
POST https://api.talenox.com/api/v2/payroll/adhoc_payment
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 18
},
"pay_items": [
{
"employee_id": "K00001",
"item_type": "Allowance",
"amount": 1000,
"remarks": ""
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| pay_items required | Below are pay items related fields |
| employee_id required | Employee ID |
| item_type required | Pay Item Type |
| remarks | Remarks |
| amount required | Amount |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 18,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"pay_items": [
{
"id": 4,
"employee_id": 1087,
"item_type": "Allowance",
"remarks": "",
"amount": "1000.0",
"rate_of_pay": "0.0",
"currency": "SGD"
}
]
}
Create Attendance Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/attendance_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3bf734499db942e36c520ac951b168dafe695a9c
POST https://api.talenox.com/api/v2/payroll/attendance_payment
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 19
},
"pay_items": [
{
"employee_id": "K00001",
"item_type": "Regular Hours",
"amount": 1000,
"rate_of_pay": 20,
"no_of_hours_slash_days": 8,
"remarks": null
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| pay_items required | Below are pay items related fields |
| employee_id required | Employee ID |
| item_type required | Pay Item Type |
| remarks | Remarks |
| amount required | Amount |
| no_of_hours_slash_days | Number of days or hours worked |
| rate_of_pay | Rate of pay |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 19,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"pay_items": [
{
"id": 4,
"employee_id": 1088,
"item_type": "Regular Hours",
"remarks": null,
"amount": "1000.0",
"rate_of_pay": "20.0",
"no_of_hours_slash_days": "8.0",
"currency": "SGD"
}
]
}
Create Leave Payment or Deduction
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction
Accept: application/json
Content-Type: application/json
Authorization: Bearer e0dec6f97ff4e3fba84045a9f816fca000f8cc83
POST https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 20
},
"pay_items": [
{
"employee_id": "K00001",
"item_type": "No Pay Leave(Unpaid Leave)",
"remarks": "1/9/2018",
"amount": 2000,
"override_working_days": 21
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| pay_items required | Below are pay items related fields |
| employee_id required | Employee ID |
| item_type required | Pay Item Type |
| remarks | Remarks |
| amount | If provided, the system will use this amount instead of the calculated value |
| override_working_days | If provided, will override the NPL calculation working days |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 20,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"pay_items": [
{
"id": 4,
"employee_id": 1089,
"item_type": "No Pay Leave(Unpaid Leave)",
"remarks": "01/09/2018",
"amount": "-2000.0",
"override_working_days": "21.0",
"currency": "SGD"
}
]
}
Create Payroll Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/payroll_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5dce92a868de432010d3027b771fa320d4cf70c0
POST https://api.talenox.com/api/v2/payroll/payroll_payment
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"with_pay_items": true
},
"employee_ids": [
"K00001"
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| month required | Month of payment |
| year required | Year of payment |
| period required | Period of payment |
| pay_group | Pay group of payment |
| with_pay_items | With Monthly pay items |
| employee_ids | Employee IDs to create payment for |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 4,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully created payment."
}
Create Recurring Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/recurring_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 524f037988effacd1f2678fbf597d968f96801f0
POST https://api.talenox.com/api/v2/payroll/recurring_payment
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 17
},
"pay_items": [
{
"employee_id": "K00001",
"item_type": "Basic Pay",
"amount": 1000,
"remarks": null,
"actual_no_of_working_days": 22,
"total_no_of_working_days": 30
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| pay_items required | Below are pay items related fields |
| employee_id required | Employee ID |
| item_type required | Pay Item Type |
| remarks | Remarks |
| amount required | Amount |
| actual_no_of_working_days | Actual number of working days (If provided, the default calculated value will be overridden) |
| total_no_of_working_days | Total number of working days (If provided, the default calculated value will be overridden) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 17,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"pay_items": [
{
"id": 6,
"employee_id": 1086,
"item_type": "Salary/Wages",
"remarks": null,
"amount": "1000.0",
"actual_no_of_working_days": 22,
"total_no_of_working_days": 30,
"rate_of_pay": "Monthly",
"currency": "SGD"
}
]
}
Delete Adhoc Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/adhoc_payment/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1390ca3b1e195eaa6f4d8388175b2213e25a7689
DELETE https://api.talenox.com/api/v2/payroll/adhoc_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1080,
"item_type": "Allowance",
"remarks": "",
"amount": "1000.0",
"rate_of_pay": "0.0",
"currency": "SGD"
}
Delete Attendance Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/attendance_payment/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer f5e5484669df15652f95eb43b219410d0449086d
DELETE https://api.talenox.com/api/v2/payroll/attendance_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1081,
"item_type": "Regular Hours",
"remarks": null,
"amount": "1000.0",
"rate_of_pay": "20.0",
"no_of_hours_slash_days": "8.0",
"currency": "SGD"
}
Delete Leave Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer 19ab9552077517603ac0be669917c53cec3d72c4
DELETE https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction/:id
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1082,
"item_type": "No Pay Leave(Unpaid Leave)",
"remarks": "1/9/2018",
"amount": "2000.0",
"override_working_days": "21.0",
"currency": null
}
Delete Payroll Payment
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/payroll_payment/7
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8c201539b46c33e5a1273df8fb88419200f92f58
DELETE https://api.talenox.com/api/v2/payroll/payroll_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Payment ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 7,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully deleted payment."
}
Delete Recurring Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/recurring_payment/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2889a4b3e961c480269b5fbe73616b408f76bf47
DELETE https://api.talenox.com/api/v2/payroll/recurring_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 5,
"employee_id": 1079,
"item_type": "Salary/Wages",
"remarks": null,
"amount": "1000.0",
"actual_no_of_working_days": 20.0,
"total_no_of_working_days": 20.0,
"rate_of_pay": "Monthly",
"currency": "SGD"
}
Export Payroll
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/export_payroll
Accept: application/json
Content-Type: application/json
Authorization: Bearer d0c58c0182c7374bcfa46e18f7cb51ca6733e423
POST https://api.talenox.com/api/v2/payroll/export_payroll
Parameters
{
"month": "September",
"year": 2018,
"period": "Whole Month"
}
| Name | Description |
|---|---|
| month required | Month of payment |
| year required | Year of payment |
| period required | Period of payment |
| pay_date | Pay date |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payslips": [
{
"ytd_gross_salary": "$1,000.00",
"ytd_bonus": "$0.00",
"ytd_net_payment": "$799.50",
"total_recurring_full": "$1,000.00",
"total_recurring_prorated": "$1,000.00",
"total_adhoc": "$0.00",
"total_attendance": "$0.00",
"total_gross": "$1,000.00",
"total_bonus": "$0.00",
"total_net_payment": "$799.50",
"total_deductions": "$0.00",
"ytd_cpf_employee": "$200.00",
"ytd_cpf_employer": "$170.00",
"total_sg_fwl": "$0.00",
"total_sg_cpf_owage": "$1,000.00",
"total_sg_cpf_awage": "$0.00",
"total_sg_cpf_employee": "$200.00",
"total_sg_cpf_employer": "$170.00",
"total_sg_cpf_donation": "$0.50",
"total_sg_additional_cpf_donation": "$0.00",
"total_sg_cpf_sdl": "$2.50",
"employee_final_cpf": "$200.50",
"sg_total_sdl_contributable": "$1,000.00",
"id": 1090,
"employee_id": "K00001",
"name": "Evangeline Ruecker",
"job_title": null,
"department": null,
"country_code": "SG",
"currency_unit": "$",
"attendance_pay_items": [],
"recurring_pay_items": [
{
"id": 7,
"employee_id": 1090,
"currency_value": "sgd",
"item_type": "Salary/Wages",
"amount": "1000.0",
"prorated_amount": "1000.0",
"remarks": null,
"preferences": {
"sg_cpf": true,
"sg_sdl": true,
"sg_shg": true,
"sg_tax": true
},
"working_days_setting": {
"total_no_of_working_days": 20.0,
"actual_no_of_working_days": 20.0
},
"custom_pay_item_id": 32725,
"is_statutory_prorated": false,
"statutory_prorated_amount": "1000.0",
"statutory_prorated_date": null
}
],
"adhoc_pay_items": [],
"overtime_pay": "0.0",
"payment_method": "Bank Transfer",
"published": false,
"payslip_pay_date": null,
"payslip_remarks": "",
"payslip_remarks_maximum_length": 500,
"total_leave_pay": "0.0",
"total_reimbursements": "0.0",
"total_basic_salary": "1000.0",
"total_allowances": "0.0",
"total_commissions": "0.0",
"total_directors_fees": "0.0",
"total_gross_full": "1000.0",
"total_leave_payments_or_deductions": "0.0",
"total_others": "0.0",
"total_employee_benefits": "0.0",
"total_other_pay_items_amount": "0.0",
"sg_cpf_donation_type": "CDAC",
"sg_additional_cpf_donation_type": "N/A",
"total_sg_cpf_donation_mbmf_mbf_amount": "0.0",
"total_sg_cpf_donation_mbmf_mendaki_amount": "0.0",
"total_sg_additional_cpf_donation_mbmf_mbf_amount": "0.0",
"total_sg_additional_cpf_donation_mbmf_mendaki_amount": "0.0",
"total_sums_owage_awage": {
"awage": "0.0",
"owage": "1000.0"
},
"sg_cpf_contribution_type": "Year2018::Citizen::Age50",
"total_sg_cpf_owage_subjected": "1000.0",
"total_sg_cpf_awage_subjected": "0.0",
"total_sg_cpf_employee_awage": "0.0",
"total_sg_cpf_employer_awage": "0.0",
"total_sg_cpf_employee_owage": "200.0",
"total_sg_cpf_employer_owage": "170.0",
"sg_total_shg_contributable": "1000.0",
"total_sg_mandatory_cpf_employee": "200.0",
"total_sg_mandatory_cpf_employer": "170.0",
"total_sg_voluntary_cpf_employee": "0.0",
"total_sg_voluntary_cpf_employer": "0.0",
"total_sg_voluntary_cpf_employee_rate": "0.0",
"total_sg_voluntary_cpf_employer_rate": "0.0",
"total_sg_cpf_employee_employer": "370.0",
"total_sg_voluntary_cpf_employer_medisave": "0.0",
"total_cpf_in_lieu_awage": "0.0",
"total_cpf_in_lieu_owage": "0.0",
"total_taxable": "1000.0",
"payment_reconciliation": "0.0",
"total_sg_cpf_withholding": "200.5",
"total_net_payment_converted": "799.5",
"total_recurring_full_converted": "1000.0",
"total_recurring_prorated_converted": "1000.0",
"total_adhoc_converted": "0.0",
"total_attendance_converted": "0.0",
"total_leave_payments_or_deductions_converted": "0.0",
"total_deductions_converted": "0.0",
"total_gross_converted": "1000.0",
"total_bonus_converted": "0.0",
"total_leave_pay_converted": "0.0",
"total_reimbursements_converted": "0.0",
"total_allowances_converted": "0.0",
"total_basic_salary_converted": "1000.0",
"total_commissions_converted": "0.0",
"total_directors_fees_converted": "0.0",
"total_taxable_converted": "1000.0",
"total_others_converted": "0.0",
"total_employee_benefits_converted": "0.0",
"total_sg_cpf_employee_owage_reverted": "200.0",
"total_sg_cpf_employee_awage_reverted": "0.0",
"total_sg_cpf_employee_reverted": "200.0",
"total_sg_mandatory_cpf_employee_reverted": "200.0",
"total_sg_mandatory_cpf_employer_reverted": "170.0",
"total_sg_voluntary_cpf_employee_reverted": "0.0",
"total_sg_voluntary_cpf_employer_reverted": "0.0",
"total_sg_voluntary_cpf_employer_medisave_reverted": "0.0",
"total_sg_cpf_employer_owage_reverted": "170.0",
"total_sg_cpf_employer_awage_reverted": "0.0",
"total_sg_cpf_employer_reverted": "170.0",
"total_sg_cpf_sdl_reverted": "2.5",
"total_sg_cpf_awage_reverted": "0.0",
"total_sg_cpf_owage_reverted": "1000.0",
"total_sg_cpf_donation_reverted": "0.5",
"payment_reconciliation_reverted": "0.0",
"total_sg_cpf_donation_mbmf_mbf_amount_reverted": "0.0",
"total_sg_cpf_donation_mbmf_mendaki_amount_reverted": "0.0",
"total_sg_additional_cpf_donation_mbmf_mbf_amount_reverted": "0.0",
"total_sg_additional_cpf_donation_mbmf_mendaki_amount_reverted": "0.0",
"total_sg_additional_cpf_donation_reverted": "0.0",
"total_sg_fwl_reverted": "0.0",
"total_sg_cpf_withholding_reverted": "200.5",
"employee_final_cpf_reverted": "200.5"
}
],
"total_gross_salary": "$1,000.00",
"total_ytd_gross_salary": "$1,000.00",
"total_ytd_bonus": "$0.00",
"total_ytd_net_payment": "$799.50",
"total_ytd_cpf_employee": "$200.00",
"total_ytd_cpf_employer": "$170.00",
"month": "September",
"year": "2018",
"company_payroll_setting": {
"id": 396,
"company_id": 396,
"employers_contribute_shg_on_behalf": "employers_do_not_contribute_shg_on_behalf",
"payslip_update_on_address_change": "need_to_update_payslips_for_address_change",
"payslip_update_on_image_change": "need_to_update_payslips_for_image_change",
"payslip_footer_message": "show",
"payslip_period_display": "show_to_from_dates",
"payslip_ytd_use_gross_salary": "show_ytd_gross_salary",
"payslip_ytd_display": "show_ytd",
"payslip_employee_id_display": "show_id",
"payslip_employee_address_display": "show_address",
"payslip_leave_balance": "show_leave_balance",
"hk_mpf_first_contribution": "first_contribution_default_payment",
"npl_rounding": "no_rounding",
"sick_leave_rounding": "no_rounding",
"maternity_leave_rounding": "no_rounding",
"paternity_leave_rounding": "no_rounding",
"annual_leave_rounding": "no_rounding",
"created_at": "2024-12-16T06:24:48.660Z",
"updated_at": "2024-12-16T06:24:48.753Z",
"payslip_job_display": "show_job",
"working_days_rounding": "no_rounding",
"overtime_contribute_to_adw": false,
"leave_encashment_settings": "disabled",
"payslip_employee_company_id_display": "hide_emp_company_id",
"currency_conversion_enabled": true,
"npl_decimal_precision": 2,
"sick_leave_decimal_precision": 2,
"maternity_leave_decimal_precision": 2,
"paternity_leave_decimal_precision": 2,
"annual_leave_decimal_precision": 2,
"payslip_payment_method_display": "show_payment_method",
"payslips_sort_settings": "employee_id",
"rate_of_pay_decimal_precision": 4,
"payslip_display_country_name": true,
"tax_ir21_filing_reminder_email_notification": "enable_notification",
"hk_statutory_holiday_pay_settings": "enabled",
"payslip_sdl_display": "hide_sdl",
"payslip_branch_display": "show_branch",
"idr_format_toggle": 0,
"payslip_withholding_display": "show_withholding",
"bank_file_holiday_setting": "follow_holiday_state",
"apex_enabled": true,
"my_2023_tax_settings": "new_rate",
"attendance_rop_follow_working_hours_days_calculation": false,
"memeco_payslip_enabled": null,
"payslip_password_encryption_settings": "birthdate",
"pay_code_enabled": false,
"payslip_field_header_display": false,
"payslip_base_salary_display": false,
"disable_reconciliation": false,
"hk_adw_setting": "employment_ordinance_2007",
"payslip_employee_name_display": "employee_name"
}
}
Get Payroll Payment
Request
Endpoint
GET https://api.talenox.com/api/v2/payroll/payroll_payment/6
Accept: application/json
Content-Type: application/json
Authorization: Bearer 74537dbdd701e74959a92cc7fc559b8e2ad7d452
GET https://api.talenox.com/api/v2/payroll/payroll_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Payment ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 6,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"created_by_webhook": true,
"bank_file_exported": false,
"bank_file_value_date": null,
"cheque_payment_exported": false,
"cheque_payment_value_date": null,
"recurring_pay_items": [
{
"id": 3,
"employee_id": 1075,
"item_type": "Salary/Wages",
"remarks": null,
"amount": "1000.0",
"actual_no_of_working_days": 20.0,
"total_no_of_working_days": 20.0,
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"adhoc_pay_items": [
{
"id": 1,
"employee_id": 1075,
"item_type": "Allowance",
"remarks": "",
"amount": "1000.0",
"rate_of_pay": "0.0",
"currency": "SGD"
}
],
"attendance_pay_items": [
{
"id": 1,
"employee_id": 1075,
"item_type": "Regular Hours",
"remarks": null,
"amount": "1000.0",
"rate_of_pay": "20.0",
"no_of_hours_slash_days": "8.0",
"currency": "SGD"
}
],
"leave_pay_items": [
{
"id": 1,
"employee_id": 1075,
"item_type": "No Pay Leave(Unpaid Leave)",
"remarks": "1/9/2018",
"amount": "2000.0",
"override_working_days": "21.0",
"currency": null
}
]
}
Get Payslips Data
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/get_payslips_data
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3cc9fb636c5df4b7926c238c2be8fdbf9b38f6f5
POST https://api.talenox.com/api/v2/payroll/get_payslips_data
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
"K00001"
]
}
| Name | Description |
|---|---|
| employee_ids | Employee IDs |
| month required | Month of payment |
| year required | Year of payment |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payslips": [
{
"ytd_gross_salary": "$1,000.00",
"ytd_bonus": "$0.00",
"ytd_net_payment": "$799.50",
"total_recurring_full": "$1,000.00",
"total_recurring_prorated": "$1,000.00",
"total_adhoc": "$0.00",
"total_attendance": "$0.00",
"total_gross": "$1,000.00",
"total_bonus": "$0.00",
"total_net_payment": "$799.50",
"total_deductions": "$0.00",
"ytd_cpf_employee": "$200.00",
"ytd_cpf_employer": "$170.00",
"total_sg_fwl": "$0.00",
"total_sg_cpf_owage": "$1,000.00",
"total_sg_cpf_awage": "$0.00",
"total_sg_cpf_employee": "$200.00",
"total_sg_cpf_employer": "$170.00",
"total_sg_cpf_donation": "$0.50",
"total_sg_additional_cpf_donation": "$0.00",
"total_sg_cpf_sdl": "$2.50",
"employee_final_cpf": "$200.50",
"sg_total_sdl_contributable": "$1,000.00",
"id": 1093,
"employee_id": "K00001",
"name": "Bebe Pouros",
"job_title": null,
"department": null,
"country_code": "SG",
"currency_unit": "$",
"attendance_pay_items": [],
"recurring_pay_items": [
{
"id": 10,
"employee_id": 1093,
"currency_value": "sgd",
"item_type": "Salary/Wages",
"amount": "1000.0",
"prorated_amount": "1000.0",
"remarks": null,
"preferences": {
"sg_cpf": true,
"sg_sdl": true,
"sg_shg": true,
"sg_tax": true
},
"working_days_setting": {
"total_no_of_working_days": 20.0,
"actual_no_of_working_days": 20.0
},
"custom_pay_item_id": 32977,
"is_statutory_prorated": false,
"statutory_prorated_amount": "1000.0",
"statutory_prorated_date": null
}
],
"adhoc_pay_items": [],
"overtime_pay": "0.0",
"payment_method": "Bank Transfer",
"published": false,
"payslip_pay_date": null,
"payslip_remarks": "",
"payslip_remarks_maximum_length": 500,
"total_leave_pay": "0.0",
"total_reimbursements": "0.0",
"total_basic_salary": "1000.0",
"total_allowances": "0.0",
"total_commissions": "0.0",
"total_directors_fees": "0.0",
"total_gross_full": "1000.0",
"total_leave_payments_or_deductions": "0.0",
"total_others": "0.0",
"total_employee_benefits": "0.0",
"total_other_pay_items_amount": "0.0",
"sg_cpf_donation_type": "CDAC",
"sg_additional_cpf_donation_type": "N/A",
"total_sg_cpf_donation_mbmf_mbf_amount": "0.0",
"total_sg_cpf_donation_mbmf_mendaki_amount": "0.0",
"total_sg_additional_cpf_donation_mbmf_mbf_amount": "0.0",
"total_sg_additional_cpf_donation_mbmf_mendaki_amount": "0.0",
"total_sums_owage_awage": {
"awage": "0.0",
"owage": "1000.0"
},
"sg_cpf_contribution_type": "Year2018::Citizen::Age50",
"total_sg_cpf_owage_subjected": "1000.0",
"total_sg_cpf_awage_subjected": "0.0",
"total_sg_cpf_employee_awage": "0.0",
"total_sg_cpf_employer_awage": "0.0",
"total_sg_cpf_employee_owage": "200.0",
"total_sg_cpf_employer_owage": "170.0",
"sg_total_shg_contributable": "1000.0",
"total_sg_mandatory_cpf_employee": "200.0",
"total_sg_mandatory_cpf_employer": "170.0",
"total_sg_voluntary_cpf_employee": "0.0",
"total_sg_voluntary_cpf_employer": "0.0",
"total_sg_voluntary_cpf_employee_rate": "0.0",
"total_sg_voluntary_cpf_employer_rate": "0.0",
"total_sg_cpf_employee_employer": "370.0",
"total_sg_voluntary_cpf_employer_medisave": "0.0",
"total_cpf_in_lieu_awage": "0.0",
"total_cpf_in_lieu_owage": "0.0",
"total_taxable": "1000.0",
"payment_reconciliation": "0.0",
"total_sg_cpf_withholding": "200.5",
"total_net_payment_converted": "799.5",
"total_recurring_full_converted": "1000.0",
"total_recurring_prorated_converted": "1000.0",
"total_adhoc_converted": "0.0",
"total_attendance_converted": "0.0",
"total_leave_payments_or_deductions_converted": "0.0",
"total_deductions_converted": "0.0",
"total_gross_converted": "1000.0",
"total_bonus_converted": "0.0",
"total_leave_pay_converted": "0.0",
"total_reimbursements_converted": "0.0",
"total_allowances_converted": "0.0",
"total_basic_salary_converted": "1000.0",
"total_commissions_converted": "0.0",
"total_directors_fees_converted": "0.0",
"total_taxable_converted": "1000.0",
"total_others_converted": "0.0",
"total_employee_benefits_converted": "0.0",
"total_sg_cpf_employee_owage_reverted": "200.0",
"total_sg_cpf_employee_awage_reverted": "0.0",
"total_sg_cpf_employee_reverted": "200.0",
"total_sg_mandatory_cpf_employee_reverted": "200.0",
"total_sg_mandatory_cpf_employer_reverted": "170.0",
"total_sg_voluntary_cpf_employee_reverted": "0.0",
"total_sg_voluntary_cpf_employer_reverted": "0.0",
"total_sg_voluntary_cpf_employer_medisave_reverted": "0.0",
"total_sg_cpf_employer_owage_reverted": "170.0",
"total_sg_cpf_employer_awage_reverted": "0.0",
"total_sg_cpf_employer_reverted": "170.0",
"total_sg_cpf_sdl_reverted": "2.5",
"total_sg_cpf_awage_reverted": "0.0",
"total_sg_cpf_owage_reverted": "1000.0",
"total_sg_cpf_donation_reverted": "0.5",
"payment_reconciliation_reverted": "0.0",
"total_sg_cpf_donation_mbmf_mbf_amount_reverted": "0.0",
"total_sg_cpf_donation_mbmf_mendaki_amount_reverted": "0.0",
"total_sg_additional_cpf_donation_mbmf_mbf_amount_reverted": "0.0",
"total_sg_additional_cpf_donation_mbmf_mendaki_amount_reverted": "0.0",
"total_sg_additional_cpf_donation_reverted": "0.0",
"total_sg_fwl_reverted": "0.0",
"total_sg_cpf_withholding_reverted": "200.5",
"employee_final_cpf_reverted": "200.5"
}
],
"total_gross_salary": "$1,000.00",
"total_ytd_gross_salary": "$1,000.00",
"total_ytd_bonus": "$0.00",
"total_ytd_net_payment": "$799.50",
"total_ytd_cpf_employee": "$200.00",
"total_ytd_cpf_employer": "$170.00",
"month": "September",
"year": "2018",
"company_payroll_setting": {
"id": 399,
"company_id": 399,
"employers_contribute_shg_on_behalf": "employers_do_not_contribute_shg_on_behalf",
"payslip_update_on_address_change": "need_to_update_payslips_for_address_change",
"payslip_update_on_image_change": "need_to_update_payslips_for_image_change",
"payslip_footer_message": "show",
"payslip_period_display": "show_to_from_dates",
"payslip_ytd_use_gross_salary": "show_ytd_gross_salary",
"payslip_ytd_display": "show_ytd",
"payslip_employee_id_display": "show_id",
"payslip_employee_address_display": "show_address",
"payslip_leave_balance": "show_leave_balance",
"hk_mpf_first_contribution": "first_contribution_default_payment",
"npl_rounding": "no_rounding",
"sick_leave_rounding": "no_rounding",
"maternity_leave_rounding": "no_rounding",
"paternity_leave_rounding": "no_rounding",
"annual_leave_rounding": "no_rounding",
"created_at": "2024-12-16T06:24:57.301Z",
"updated_at": "2024-12-16T06:24:57.388Z",
"payslip_job_display": "show_job",
"working_days_rounding": "no_rounding",
"overtime_contribute_to_adw": false,
"leave_encashment_settings": "disabled",
"payslip_employee_company_id_display": "hide_emp_company_id",
"currency_conversion_enabled": true,
"npl_decimal_precision": 2,
"sick_leave_decimal_precision": 2,
"maternity_leave_decimal_precision": 2,
"paternity_leave_decimal_precision": 2,
"annual_leave_decimal_precision": 2,
"payslip_payment_method_display": "show_payment_method",
"payslips_sort_settings": "employee_id",
"rate_of_pay_decimal_precision": 4,
"payslip_display_country_name": true,
"tax_ir21_filing_reminder_email_notification": "enable_notification",
"hk_statutory_holiday_pay_settings": "enabled",
"payslip_sdl_display": "hide_sdl",
"payslip_branch_display": "show_branch",
"idr_format_toggle": 0,
"payslip_withholding_display": "show_withholding",
"bank_file_holiday_setting": "follow_holiday_state",
"apex_enabled": true,
"my_2023_tax_settings": "new_rate",
"attendance_rop_follow_working_hours_days_calculation": false,
"memeco_payslip_enabled": null,
"payslip_password_encryption_settings": "birthdate",
"pay_code_enabled": false,
"payslip_field_header_display": false,
"payslip_base_salary_display": false,
"disable_reconciliation": false,
"hk_adw_setting": "employment_ordinance_2007",
"payslip_employee_name_display": "employee_name"
}
}
Get Payslips PDF
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/get_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer 90733e1c849c85423c1c2a97361c0b7bae938c7a
POST https://api.talenox.com/api/v2/payroll/get_payslips
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
1091
]
}
| Name | Description |
|---|---|
| employee_ids required | Employee IDs |
| month required | Month of payment |
| year required | Year of payment |
| include_employee_data | Returns employee data along with payslip URL |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"1091": null
}
]
Get Payslips PDF with Employee Details
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/get_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer dfa179a012ec909faddbcd2a16a9fc289109a90b
POST https://api.talenox.com/api/v2/payroll/get_payslips
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
1092
],
"include_employee_data": true
}
| Name | Description |
|---|---|
| employee_ids required | Employee IDs |
| month required | Month of payment |
| year required | Year of payment |
| include_employee_data | Returns employee data along with payslip URL |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"1092": {
"payslip_url": null,
"employee_id": null,
"employee_first_name": null,
"employee_last_name": null,
"employee_birthdate": null
}
}
]
List All Payroll Payments
Request
Endpoint
GET https://api.talenox.com/api/v2/payroll/payroll_payment?month=September&year=2018&created_by_webhook=true
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7d197bf253bded583b4a80b47bbb8b001f9c9cd4
GET https://api.talenox.com/api/v2/payroll/payroll_payment
Parameters
month: September
year: 2018
created_by_webhook: true
| Name | Description |
|---|---|
| month required | Month of payment |
| year required | Year of payment |
| created_by_webhook | Filter for querying only the payments created by webhook |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"payment_id": 5,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"created_by_webhook": true,
"bank_file_exported": false,
"bank_file_value_date": null,
"cheque_payment_exported": false,
"cheque_payment_value_date": null,
"recurring_pay_items": [],
"adhoc_pay_items": [],
"attendance_pay_items": [],
"leave_pay_items": []
}
]
Process Payroll Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/payroll_payment/8/process
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4473e2bdf535862666894f9ecd77ad27956d77cf
POST https://api.talenox.com/api/v2/payroll/payroll_payment/:id/process
Parameters
| Name | Description |
|---|---|
| id required | Payment ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 8,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Processed",
"message": "Successfully processed payment."
}
Publish Payslips
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/publish_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer 56327f2e5c7bbc8b0c979e1008e5880ef7b24a77
POST https://api.talenox.com/api/v2/payroll/publish_payslips
Parameters
{
"month": "September",
"year": "2018",
"payslip_pay_date": "30/09/2018",
"payslip_send_on_pd_setting": 0,
"attach_payslip_to_email": 0
}
| Name | Description |
|---|---|
| month required | Month of payment |
| year required | Year of payment |
| payslip_pay_date required | Payslip Pay Date |
| payslip_send_on_pd_setting required | payslip Send On Pay Date Setting |
| attach_payslip_to_email required | Attach Payslip To Email |
| employee_ids | Employee IDs |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Payslips published",
"published": true
}
Pull Leave Applications
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/pull_leave_applications
Accept: application/json
Content-Type: application/json
Authorization: Bearer b698d52967911f4f92d9d28ff6104b7433a343b2
POST https://api.talenox.com/api/v2/payroll/pull_leave_applications
Parameters
{
"payment": {
"month": "September",
"year": 2018,
"period": "Whole Month",
"pay_group": null
}
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Leave applications pulled successfully"
}
Set Payment to Draft
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/payroll_payment/9/draft
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0dc24f87e3e585d329d81f70275b82231a07b0dd
POST https://api.talenox.com/api/v2/payroll/payroll_payment/:id/draft
Parameters
| Name | Description |
|---|---|
| id required | Payment ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 9,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment."
}
Unpublish Payslips
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/unpublish_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer e31eb9bce7016c91b8c6a458acfb0a404ded740b
POST https://api.talenox.com/api/v2/payroll/unpublish_payslips
Parameters
{
"month": "September",
"year": "2018"
}
| Name | Description |
|---|---|
| month required | Month of payment |
| year required | Year of payment |
| employee_ids | Employee IDs |
Response
Content-Type: text/plain; charset=utf-8
200 OK
Update Payment Settings
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer 60d82bfb8276a4bde733715df2ff4defea42e009
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 14
},
"settings": [
{
"employee_id": "K00001",
"is_bank_payment": false,
"selected_cost_centre_id": 47,
"employees_payment_methods": "Bank Transfer"
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| settings required | Settings related fields |
| employee_id | Employee ID |
| employees_payment_methods | Indicate payment mode for employee: Bank/Cheque/Forex/Cash payment |
| selected_cost_centre_id | Cost centre ID to process the employee under (defaults to default cost centre) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 14,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"settings": [
{
"employee_id": 1083,
"selected_cost_centre_id": 47,
"employees_payment_methods": "Bank Transfer"
}
]
}
Update without payment methods - is_bank_payment set to false
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9f69f8ea8b242ce747c233f1a9c147dc9b4c1a45
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 16
},
"settings": [
{
"employee_id": "K00001",
"is_bank_payment": false,
"selected_cost_centre_id": 51
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| settings required | Settings related fields |
| employee_id | Employee ID |
| employees_payment_methods | Indicate payment mode for employee: Bank/Cheque/Forex/Cash payment |
| selected_cost_centre_id | Cost centre ID to process the employee under (defaults to default cost centre) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 16,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"settings": [
{
"employee_id": 1085,
"selected_cost_centre_id": 51,
"employees_payment_methods": "Cheque"
}
]
}
Update without payment methods - is_bank_payment set to true
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer e88eb4c31a07ddc56f7fa972d7056053674f2447
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 15
},
"settings": [
{
"employee_id": "K00001",
"is_bank_payment": true,
"selected_cost_centre_id": 49
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| settings required | Settings related fields |
| employee_id | Employee ID |
| employees_payment_methods | Indicate payment mode for employee: Bank/Cheque/Forex/Cash payment |
| selected_cost_centre_id | Cost centre ID to process the employee under (defaults to default cost centre) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 15,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"settings": [
{
"employee_id": 1084,
"selected_cost_centre_id": 49,
"employees_payment_methods": "Bank Transfer"
}
]
}
User Info (OAuth)
Get user info
Request
Endpoint
GET https://api.talenox.com/api/v2/user_info
Accept: application/json
Content-Type: application/json
Authorization: Bearer H3phIJ4v-3NVY4QlEVWWgnQfZLQj3gaLCptIo9hiR9A
GET https://api.talenox.com/api/v2/user_info
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"company": {
"id": 420
},
"employee": {
"id": 1215,
"employee_id": "gyb60dcf2u"
}
}
Working Days
Create Working Day
Request
Endpoint
POST https://api.talenox.com/api/v2/working_days
Accept: application/json
Content-Type: application/json
Authorization: Bearer 888855247a15466552f248385a942864d2608914
POST https://api.talenox.com/api/v2/working_days
Parameters
{
"working_day": {
"name": "New working day",
"company_default": false,
"week_schedule": [
"not_working",
"second_half",
"full_day",
"full_day",
"full_day",
"first_half",
"not_working"
],
"employee_ids": [
1338
]
}
}
| Name | Description |
|---|---|
| name required | Working Day Name |
| company_default | Company Default |
| week_schedule required | Week schedule (An array of 7 elements corresponding to each day in a week starting from Sunday, supported values are not_working, full_day, first_half, second_half, rest_day[only for SG]) |
| employee_ids | Employee IDs (This will override the working day's employee) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 174,
"name": "New working day",
"employee_ids": [
1338
],
"no_of_employees": 1,
"week_schedule": [
"not_working",
"second_half",
"full_day",
"full_day",
"full_day",
"first_half",
"not_working"
],
"company_default": false
}
Delete Working Day
Request
Endpoint
DELETE https://api.talenox.com/api/v2/working_days/186
Accept: application/json
Content-Type: application/json
Authorization: Bearer a93ef08954ca2d8c24cecf25de0198ecc0155b51
DELETE https://api.talenox.com/api/v2/working_days/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted working day 5"
}
Get Working Day
Request
Endpoint
GET https://api.talenox.com/api/v2/working_days/176
Accept: application/json
Content-Type: application/json
Authorization: Bearer bbd24bfef941c4fb51a5705d01589baf82017dc0
GET https://api.talenox.com/api/v2/working_days/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 176,
"name": "1",
"employee_ids": [],
"no_of_employees": 0,
"week_schedule": [
"not_working",
"full_day",
"full_day",
"full_day",
"full_day",
"full_day",
"not_working"
],
"company_default": false
}
List Working Days
Request
Endpoint
GET https://api.talenox.com/api/v2/working_days
Accept: application/json
Content-Type: application/json
Authorization: Bearer 749168b5cf4a69c7f4736e9189347b994af4832d
GET https://api.talenox.com/api/v2/working_days
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 171,
"name": "Test Working Day",
"employee_ids": [],
"no_of_employees": 0,
"week_schedule": [
"not_working",
"full_day",
"full_day",
"full_day",
"full_day",
"full_day",
"not_working"
],
"company_default": true
}
]
Update Working Day
Request
Endpoint
PUT https://api.talenox.com/api/v2/working_days/178
Accept: application/json
Content-Type: application/json
Authorization: Bearer d9b4f04202089e132b7fa1fb1f17d075497e0870
PUT https://api.talenox.com/api/v2/working_days/:id
Parameters
{
"working_day": {
"name": "Change name",
"week_schedule": [
"not_working",
"full_day",
"full_day",
"full_day",
"full_day",
"not_working",
"not_working"
]
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 178,
"name": "Change name",
"employee_ids": [],
"no_of_employees": 0,
"week_schedule": [
"not_working",
"full_day",
"full_day",
"full_day",
"full_day",
"not_working",
"not_working"
],
"company_default": false
}
Working Hours
Create Working Hour
Request
Endpoint
POST https://api.talenox.com/api/v2/working_hours
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1bae3f10f2127072b4be6db73c42c5000e15db38
POST https://api.talenox.com/api/v2/working_hours
Parameters
{
"working_hour": {
"name": "New Working Hour",
"company_default": false,
"hours_per_week": 44.0,
"employee_ids": [
1418
]
}
}
| Name | Description |
|---|---|
| name required | Working Hour Name |
| company_default | Company Default |
| hours_per_week required | Hours Per Week |
| hours_per_day required | Hours per day (For Part Time ADW Calculation) |
| employee_ids | Employee IDs (This will override the Working Hour's employee) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 177,
"name": "New Working Hour",
"employee_ids": [
1418
],
"no_of_employees": 1,
"hours_per_week": "44.0",
"company_default": false,
"hours_per_day": 8.0,
"timetracker_overtime_hours_limit_enabled": true,
"timetracker_salary_threshold_for_overtime_enabled": true
}
Delete Working Hour
Request
Endpoint
DELETE https://api.talenox.com/api/v2/working_hours/187
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9e2dd2fcdb492d2f03f48d1589f95f9e1a192570
DELETE https://api.talenox.com/api/v2/working_hours/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted working hour Default"
}
Get Working Hour
Request
Endpoint
GET https://api.talenox.com/api/v2/working_hours/179
Accept: application/json
Content-Type: application/json
Authorization: Bearer ac20d612a396579126316f57fd1020ce4c54db7d
GET https://api.talenox.com/api/v2/working_hours/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 179,
"name": "Default",
"employee_ids": [],
"no_of_employees": 0,
"hours_per_week": "44.0",
"company_default": false,
"hours_per_day": 8.0,
"timetracker_overtime_hours_limit_enabled": true,
"timetracker_salary_threshold_for_overtime_enabled": true
}
List Working Hours
Request
Endpoint
GET https://api.talenox.com/api/v2/working_hours
Accept: application/json
Content-Type: application/json
Authorization: Bearer b2a1d96469cf66ab96dac5fd3b079ade899e63b8
GET https://api.talenox.com/api/v2/working_hours
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 174,
"name": "Test Working Hour",
"employee_ids": [],
"no_of_employees": 0,
"hours_per_week": "44.0",
"company_default": true,
"hours_per_day": 8.0,
"timetracker_overtime_hours_limit_enabled": true,
"timetracker_salary_threshold_for_overtime_enabled": true
}
]
Update Working Hour
Request
Endpoint
PUT https://api.talenox.com/api/v2/working_hours/181
Accept: application/json
Content-Type: application/json
Authorization: Bearer b47bf59bbe36df631fc057a49a4089b30a6044d8
PUT https://api.talenox.com/api/v2/working_hours/:id
Parameters
{
"working_hour": {
"name": "Change name",
"hours_per_week": 40.0
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 181,
"name": "Change name",
"employee_ids": [],
"no_of_employees": 0,
"hours_per_week": "40.0",
"company_default": false,
"hours_per_day": 8.0,
"timetracker_overtime_hours_limit_enabled": true,
"timetracker_salary_threshold_for_overtime_enabled": true
}
Leave Application Flow (BETA)
To apply leave using the create leave application api, developers should have the following information ready to be submitted as payload. The create leave application endpoint checks and block if payload has issues, such as applied leave dates are overlapping with existing applications. However, the developer will still need to do necessary checks before they call the endpoint for a smoother api experience.
This guide suggests a flow developers can follow to call Talenox's APIs to get these information ready:
- Leave Employee ID
- Leave Approver Employee ID
- Leave Category ("type" for Leave Type and "oil" for Off in lieu)
- Leave Catgory ID (Leave Type or Off in lieu ID)
1. Get Leave Employee Information
Follow instructions on List All Employees
2. Get Leave Approver Information
With the employee id in step 1, query leave approvers
3. Get available leave types and off in lieus for leave employee
retrieve leave types and off in lieus for the employee with the following end points. - List available leave types for an employee - List off line lieus for an employee
4. Check that leave employee's leave type has leave balance and entitlement for the leave employee's leave type
Check that the selected leave type has sufficient leave balance and has a valid entitlement period in Talenox. If the leave type is off in lieu use the endpoints in Off in lieus section.
Leave types
- Get leave balance for a leave type of an employee
- Get leave entitlement period for a leave type of an employee
Off in lieus
- Get off in lieu balance for all off in lieus of an employee
- Get leave entitlement period for an off in lieu of an employee
5. Get leave applications for the leave employee to check if dates applied are overlapping
Supply the leave employee's id to the endpoint in Get leave applications for an employee
6. Apply leave with create leave application
Once you completed the previous steps, you can refer to Create leave application to apply leave with Talenox API.
Note that the category field should be "oil" for off in lieus and "type" for leave type.
Optional - Creating Leave Application with self-supplied leave durations and working days
// A sample payload for a single day leave application:
{
"employee_id": 272,
"category_id": 11,
"category": "type",
"start_date": "2023-03-09",
"end_date": "2023-03-09",
"remarks": "test",
"working_days": [
{
"date": "2023-03-09",
"type": "full_day" // or "first_half" or "second_half" or "holiday" or "not_working"
}
],
"applied_durations": [
{
"date": "2023-03-09",
"type": "full_day" // or "first_half" or "second_half
}
]
}
// A sample payload for multiple day leave application
{
"employee_id": 272,
"category_id": 11,
"category": "type",
"start_date": "2023-03-09",
"end_date": "2023-03-11",
"remarks": "test",
"working_days": [
{
"date": "2023-03-09",
"type": "full_day" // or "first_half" or "second_half" or "holiday" or "not_working"
},
{
"date": "2023-03-10",
"type": "full_day" // or "first_half" or "second_half" or "holiday" or "not_working"
},
{
"date": "2023-03-11",
"type": "full_day" // or "first_half" or "second_half" or "holiday" or "not_working"
}
],
"applied_durations": [
{
"date": "2023-03-09",
"type": "full_day" // or "second_half"
},
{
"date": "2023-03-11",
"type": "full_day" // or "first_half"
}
]
}
Developers can also supply their own applied leave durations and working days.
Notes on creating leave applications with self-supplied working days
Working_days should contain the number of instances as defined by start_date and end_date. Each working day instance "type" must be one of the values "full_day", "first_half", "second_half" , "holiday" or "not_working"
- e.g. if the start_date is 2023-03-09, and end_date is 2023-03-10, working_days should contain 2 instances to reflect this.
- Providing working days is optional, and depends on how your app is integrated with Talenox. If no working days is provided, it is assumed Talenox will be the source of truth for working days, and leave applications will be created based on working days defined by Talenox.
Notes on creating leave applications with self-supplied applied durations
For applied durations, type must be one of the values 'full_day', 'first_half' or 'second_half'.
- For single day leave applications, type must be one of the values 'full_day', 'first_half' or 'second_half'.
- For multiple day leave applications, developers only need to provide the start and end applied durations as Talenox treats this as a continuous block of days and generate the days in between. Specifically,
- the first day of your leave application, applied duration type can only be 'full_day' or 'second_half'
- the last day of your leave application, type can only be 'full_day' or 'first_half'
7. Approve leave application
After the leave application is created, track the leave application id returned. Use the leave application id as the input for the approve leave endpoint, and approve the leave as the leave approver. This means you submit with the oauth authorization, or use the leave approver api token as the Bearer token to process this request. - Approve leave as leave approver
Leave Attachments Flow (BETA)
Upload Attachment
Follow these steps to upload leave attachments:
- Create leave application by following the leave application flow
- Once leave application is created, upload attachment for your new leave application
Delete Attachment
Follow these steps to delete leave attachments:
- View attachment details of a leave application to get the attachment ids
- Supply attachment ids and delete leave attachment