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
POST https://api.talenox.com/api/v2/branches
Accept: application/json
Content-Type: application/json
Authorization: Bearer c75402425a8478571da3a7244c41f99da6e1af69
Parameters
{
"branch": {
"name": "Sample Branch",
"address": "71233 Ullrich Terrace",
"postcode": "39846-4319",
"head_id": 504,
"employee_ids": [
505,
506,
507,
508
]
}
}
| 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": [
505,
506,
507,
508
],
"no_of_employees": 4,
"address": "71233 Ullrich Terrace",
"postcode": "39846-4319",
"head_id": 504
}
Delete Branch
Request
Endpoint
DELETE https://api.talenox.com/api/v2/branches/:id
DELETE https://api.talenox.com/api/v2/branches/598
Accept: application/json
Content-Type: application/json
Authorization: Bearer c0b33f4fb008a55d86a277915def4fecb2843f6a
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
GET https://api.talenox.com/api/v2/branches
Accept: application/json
Content-Type: application/json
Authorization: Bearer eb891abfbb8cd089de1379f7d3ef0e09b913f3ee
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": "Tomikochester",
"employee_ids": [
491
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 525,
"name": "Thieltown",
"employee_ids": [
492
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 526,
"name": "South Edison",
"employee_ids": [
493
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 527,
"name": "Berniechester",
"employee_ids": [
494
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 528,
"name": "Port Kristinaborough",
"employee_ids": [
495
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 529,
"name": "Jamelview",
"employee_ids": [
496
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 530,
"name": "East Elna",
"employee_ids": [
497
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 531,
"name": "Stromanberg",
"employee_ids": [
498
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 532,
"name": "Marquardtmouth",
"employee_ids": [
499
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 533,
"name": "Tammimouth",
"employee_ids": [
500
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 534,
"name": "Pabloborough",
"employee_ids": [
501
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 535,
"name": "Lake Daniela",
"employee_ids": [],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 536,
"name": "New Jamaal",
"employee_ids": [],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 537,
"name": "83658 Malcom Mountains",
"employee_ids": [
502,
503
],
"no_of_employees": 2,
"address": null,
"postcode": null,
"head_id": null
}
]
Show Branch
Request
Endpoint
GET https://api.talenox.com/api/v2/branches/:id
GET https://api.talenox.com/api/v2/branches/568
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2cccca9a7eee696c7e4541836e5aa8928e788012
Parameters
| Name | Description |
|---|---|
| id required | Branch ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 568,
"name": "5338 Harvey Stream",
"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/:id
PUT https://api.talenox.com/api/v2/branches/583
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5c2e45e860f7b816f58d56151f863cb8cf24530d
Parameters
{
"branch": {
"name": "New Branch Name",
"employee_ids": [
542,
531,
532,
533
]
}
}
| Name | Description |
|---|---|
| id required | Branch ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 583,
"name": "New Branch Name",
"employee_ids": [
542,
531,
532,
533
],
"no_of_employees": 4,
"address": null,
"postcode": null,
"head_id": null
}
Calendar Holidays (Deprecated)
Returns calendar holidays for a particular country that'll affect calculations within the system. Can be disabled at a company level if required, via the company holidays endpoint. (Will be deprecated and replaced by Holiday Policies api)
List Calendar Holidays
Request
Endpoint
GET /api/v2/master/calendar_holidays
GET /api/v2/master/calendar_holidays?country_id=2
Accept: application/json
Content-Type: application/json
Authorization: Bearer 123
Parameters
country_id: 2
| Name | Description |
|---|---|
| country_id | Country ID 2 - Singapore, 3 - Hong Kong, 4 - Malaysia, 10 - Indonesia |
| year | Year |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 1,
"country_id": 2,
"name": "New Year Day",
"created_at": "2025-06-26T08:15:01.522Z",
"updated_at": "2025-06-26T08:15:01.522Z",
"start_at": "2025-06-26",
"end_at": "2025-06-26",
"state_id": null,
"hk_holiday_type": null,
"state_name": null
}
]
Company Holidays (Deprecated)
Manage holidays in a company, including calendar holidays and custom created ones. (Deprecated and replaced by Holiday Policies api.)
Create Company Custom Holiday
Request
Endpoint
POST https://api.talenox.com/api/v2/company_holidays
POST https://api.talenox.com/api/v2/company_holidays
Accept: application/json
Content-Type: application/json
Authorization: Bearer ff010a0eb6efd1326bad459bc49141096ce5e8b4
Parameters
{
"custom_holiday": {
"name": "Test Holiday",
"start_at": "2025-12-31 23:59:59 +0800",
"end_at": "2025-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": 121,
"calendar_holiday_id": null,
"name": "Test Holiday",
"start_at": "2025-12-31",
"end_at": "2025-12-31",
"hide": false,
"created_at": "2025-06-26T08:16:43.698Z",
"updated_at": "2025-06-26T08:16:43.698Z"
}
Delete Company Calendar Holiday
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/:id
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5685d2f2f873599c5b9d05289943dcbdd2d9ad26
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/:id
DELETE https://api.talenox.com/api/v2/company_holidays/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer dda8ed87addd076140e9a7688cf9c9c01f3ac385
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/:id
GET https://api.talenox.com/api/v2/company_holidays/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4a9ba392bace7a0afa7827d9b78da4404736445a
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 3,
"company_id": 123,
"calendar_holiday_id": null,
"name": "Office Closure",
"start_at": "2025-12-30",
"end_at": "2025-12-31",
"hide": false,
"created_at": "2025-06-26T08:16:50.372Z",
"updated_at": "2025-06-26T08:16:50.372Z"
}
List Company Holidays including Custom and Calendar Holidays
Request
Endpoint
GET https://api.talenox.com/api/v2/company_holidays
GET https://api.talenox.com/api/v2/company_holidays
Accept: application/json
Content-Type: application/json
Authorization: Bearer c795760b20e7abfdbf5eb19122b016c292d5c7b8
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": "2025-06-26T08:16:43.748Z",
"updated_at": "2025-06-26T08:16:43.748Z",
"start_at": "2025-01-01",
"end_at": "2025-01-02",
"state_id": null,
"hk_holiday_type": null,
"type": "CalendarHoliday",
"calendar_holiday_id": 6
},
{
"id": 2,
"company_id": 122,
"calendar_holiday_id": null,
"name": "Office Closure",
"start_at": "2025-12-30",
"end_at": "2025-12-31",
"created_at": "2025-06-26T08:16:46.959Z",
"updated_at": "2025-06-26T08:16:46.959Z",
"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
GET https://api.talenox.com/api/v2/company_holidays/deleted_calendar_holidays
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0f7561fb8da79893ff21e4c1276eb895b81dd983
Parameters
| Name | Description |
|---|---|
| year | Year for filtering, defaults to current year |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 14,
"country_id": 2,
"name": "Calendar Holiday",
"created_at": "2025-06-26T08:17:11.692Z",
"updated_at": "2025-06-26T08:17:11.692Z",
"start_at": "2025-01-01",
"end_at": "2025-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/:id
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/11
Accept: application/json
Content-Type: application/json
Authorization: Bearer b4db37d44a46828d682c4982ba7d7b6c8683ff47
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/:id
PUT https://api.talenox.com/api/v2/company_holidays/4
Accept: application/json
Content-Type: application/json
Authorization: Bearer c1045071a9b0147dcc9941548e37b33a6a60feb1
Parameters
{
"custom_holiday": {
"name": "Change name"
}
}
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"company_id": 124,
"name": "Change name",
"id": 4,
"calendar_holiday_id": null,
"start_at": "2025-12-30",
"end_at": "2025-12-31",
"hide": false,
"created_at": "2025-06-26T08:16:53.798Z",
"updated_at": "2025-06-26T08:16:53.963Z"
}
Company Settings
List Company Settings
Request
Endpoint
GET https://api.talenox.com/api/v2/company_settings
GET https://api.talenox.com/api/v2/company_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer d18ca99c3382c6b02e24cfd81c4262ed65e13f61
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
PUT https://api.talenox.com/api/v2/company_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer c968de006a6523433eeb8715f395c8e175680510
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
POST https://api.talenox.com/api/v2/cost_centres
Accept: application/json
Content-Type: application/json
Authorization: Bearer aa9043b35fde8de61ca2a6eb08d37ef8cf12ac30
Parameters
{
"cost_centre": {
"name": "Business",
"employee_ids": [
"i7ul3dxa4t",
"hrrfo55xd8",
"7l7f6ahkd1",
"3xjq69sw8x"
],
"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": [
637,
638,
633,
634
],
"no_of_employees": 4,
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456789",
"enable_custom_mpf": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null,
"custom_empf_scheme": null,
"custom_empf_payroll_group_name": null
}
Delete Cost Centre
Request
Endpoint
DELETE https://api.talenox.com/api/v2/cost_centres/:id
DELETE https://api.talenox.com/api/v2/cost_centres/11
Accept: application/json
Content-Type: application/json
Authorization: Bearer f044e74337eba780c1d477082564fe742973c3b9
Parameters
| Name | Description |
|---|---|
| id required | Cost Centre ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted cost centre Tory Throughway"
}
List Cost Centre
Request
Endpoint
GET https://api.talenox.com/api/v2/cost_centres
GET https://api.talenox.com/api/v2/cost_centres
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2508332bebe7ac869a5d9a4e9d0967db103a09fb
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 1,
"name": "O'Connell Knolls",
"employee_ids": [],
"no_of_employees": 0,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null,
"enable_custom_mpf": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null,
"custom_empf_scheme": null,
"custom_empf_payroll_group_name": null
}
]
Update Cost Centre
Request
Endpoint
PUT https://api.talenox.com/api/v2/cost_centres/:id
PUT https://api.talenox.com/api/v2/cost_centres/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer 69943548c728d2e6040bd224f9ca5f3def4b2ece
Parameters
{
"cost_centre": {
"name": "Engineer",
"employee_ids": [
"0yk7j9yd0q",
"8qka9bocqx",
"fy5zw9zw6o",
"jrtzhp06uc"
],
"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": [
670,
671,
672,
673
],
"no_of_employees": 4,
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456788",
"enable_custom_mpf": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null,
"custom_empf_scheme": null,
"custom_empf_payroll_group_name": null
}
Custom Pay Items
Create Custom Pay Item
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/custom_pay_items
POST https://api.talenox.com/api/v2/payroll/custom_pay_items
Accept: application/json
Content-Type: application/json
Authorization: Bearer c26e5eae09ad6a0ec33890250e8b3016cdbd5bc6
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", "Additional"]) |
| 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": 33313,
"item_type": "Salary/Wages",
"name": null,
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d52eb4a0-5ced-4fec-bb16-f8d24ee0983e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32011,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"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/:id
DELETE https://api.talenox.com/api/v2/payroll/custom_pay_items/33651
Accept: application/json
Content-Type: application/json
Authorization: Bearer dc3fc07c7254b88242cb194f29a66dd04bf88759
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/:id
GET https://api.talenox.com/api/v2/payroll/custom_pay_items/33398
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8b987d770f3bed44db61e1c7e0a4215d17eedefa
Parameters
| Name | Description |
|---|---|
| id required | Custom Pay Item ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 33398,
"item_type": "Salary/Wages",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "7c04a9e8-838f-43d8-b7fd-ce665e52bb4d",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Period"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32096,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"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
GET https://api.talenox.com/api/v2/payroll/custom_pay_items
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9ca7c88ab425f09c2d5ee5f9799b8b917c2dad5b
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 33314,
"item_type": "Salary/Wages",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "8dcccb7d-ff63-4fa4-b73b-fb76b495fa14",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Period"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32012,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33315,
"item_type": "Salary/Wages",
"name": "Basic Pay(without proration)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "3d8d1bbe-780a-4714-bc2a-d852a6a43263",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32013,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33316,
"item_type": "Allowance",
"name": "Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "c734f250-b3d9-4cfd-b93b-494ab2dd3d59",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32014,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33317,
"item_type": "Allowance",
"name": "Allowance(without proration)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "e1e4f507-0b76-4552-b9ff-09192912d48e",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32015,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33318,
"item_type": "Deduction",
"name": "Deduction",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "97aa1533-15b6-4bf0-9912-4b3e0de7b004",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32016,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33319,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "95b1c588-5155-4fb5-b7d9-df11a8cdef4a",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32017,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33320,
"item_type": "IR21 Tax Withholding",
"name": "IR21 Tax Withholding",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "1f0198c7-39d3-4518-8437-0982a19085e6",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32018,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33321,
"item_type": "Commission",
"name": "Commission (Daily/Weekly/Monthly)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ff241119-2e8a-49e7-a9bf-80d784cd1584",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32019,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33322,
"item_type": "Extra Duty Allowance",
"name": "Extra Duty Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d3e373ca-d5de-4b28-8c46-bd105b69a98b",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32020,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33323,
"item_type": "Housing/Rental Allowance",
"name": "Housing/ Rental Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "e861fb52-38a0-44f5-b69a-59d5c5cbfa74",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32021,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33324,
"item_type": "Incentive Allowance",
"name": "Incentive Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "7cdb9d6d-b54b-46ae-b0e7-c794055f41f0",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32022,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33325,
"item_type": "Meal Allowance",
"name": "Meal Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "026b1505-93d9-4ad7-aacb-ca8f82f619a6",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32023,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33326,
"item_type": "Per Diem Allowance",
"name": "Per Diem Allowance",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ec7624af-949e-479c-a345-6ec9cb3d8e4c",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32024,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33327,
"item_type": "Transport Allowance",
"name": "Transport Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "cb5637a3-9161-4f22-bdba-a67763f2aeae",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32025,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33328,
"item_type": "Tips",
"name": "Tips",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "db42cef8-07a5-48d2-8ced-5b0ea4fd06e3",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32026,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33329,
"item_type": "Director fees",
"name": "Director fees",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "845f06ef-2c3d-4d18-9ecf-a2eae0d2086e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32027,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33330,
"item_type": "Bonus",
"name": "Bonus",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "52378b3e-21b8-45d5-b167-77c9da3524dc",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32028,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33331,
"item_type": "Others",
"name": "Others",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f45aa90b-dfcc-4f11-800e-05daa6971db1",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32029,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33332,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)(no SHG contribution)",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "0d6d31de-c65a-444f-918e-e970be94ea96",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32030,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33333,
"item_type": "Commission",
"name": "Commission (AW)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "060f0e2d-638d-4225-8c11-0c304e066d02",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32031,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33334,
"item_type": "Medisave",
"name": "Medisave",
"category": "Recurring",
"tax": true,
"gross_net_settings": "na",
"proration_enabled": false,
"slug": "70e71732-8ad8-43ee-85d1-376630cbfa93",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32032,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33335,
"item_type": "Deduction Community Chest",
"name": "Deduction Community Chest",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "32bf08ca-0c0c-4d8e-ab56-8fbf8a6e4ac4",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32033,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33336,
"item_type": "Reimbursements",
"name": "Reimbursements",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "983430a8-7e31-4145-afbf-4be1cf1c74cf",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32034,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33337,
"item_type": "Advance Pay",
"name": "Advance Pay",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "fcc22f8c-f0c2-4a4d-b09b-0417529d0a36",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32035,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33338,
"item_type": "Allowance",
"name": "Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "c5aa7ffa-5dfa-4e10-90c4-46c8618e34e9",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32036,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33339,
"item_type": "Deduction",
"name": "Deduction",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "abedb420-cdf5-436d-91de-2f7256c24715",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32037,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33340,
"item_type": "Commission",
"name": "Commission (Irregular)",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "2ca2ceaf-0172-49bc-8f94-0c47337856fd",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32038,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33341,
"item_type": "Extra Duty Allowance",
"name": "Extra Duty Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a3cd7c0c-c2e4-44bc-9fd0-10a74873518f",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32039,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33342,
"item_type": "Festive Allowance",
"name": "Festive Allowance",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "18231cc4-a9bd-429b-83f4-a54d709757d0",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32040,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33343,
"item_type": "Housing/Rental Allowance",
"name": "Housing/ Rental Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "98afefed-1d39-4db1-85b6-2d4cfa12b49b",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32041,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33344,
"item_type": "Incentive",
"name": "Incentive",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "90b83477-272a-40a4-ae8d-3824eea0baba",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32042,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33345,
"item_type": "Incentive Allowance",
"name": "Incentive Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "aee73252-08e8-405f-9fcf-df3113a048e4",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32043,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33346,
"item_type": "IR21 Tax Withholding",
"name": "IR21 Tax Withholding",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "af50a4ae-67c4-4469-80b3-78fba7c2b8db",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32044,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33347,
"item_type": "Meal Allowance",
"name": "Meal Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "84266766-6e0d-4b57-bb58-b64c50fc9b03",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32045,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33348,
"item_type": "Per Diem Allowance",
"name": "Per Diem Allowance",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "26d250cb-6760-4980-a073-6bad28f62e5d",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32046,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33349,
"item_type": "Reimbursements",
"name": "Per Diem Reimbursement",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "4c493f22-bf7b-466b-9af1-9daf8240ca28",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32047,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33350,
"item_type": "Transport Allowance",
"name": "Transport Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d0e161b2-22e7-417a-96d9-d4fcbc1112d6",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32048,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33351,
"item_type": "Referral of Employees Fees",
"name": "Referral of Employees Fees",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "6965a2ea-7a82-4edf-b697-d9a58be3a125",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32049,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33352,
"item_type": "Benefits in Kind",
"name": "Benefits in Kind",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "0f68aa8f-6311-42ac-acaf-9c1dd3d57840",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32050,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33353,
"item_type": "Benefits in Kind",
"name": "Gifts in Kind",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "dfa0c7c9-cbb0-41ab-a4ef-f515e4895624",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32051,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33354,
"item_type": "Stock Option Sale",
"name": "Share Option Sale",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ec166e4c-6bcc-4b49-8a24-de17b9938e22",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32052,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33355,
"item_type": "Termination Benefits",
"name": "Termination Benefits",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "5e4b2c8c-0432-42df-9a7c-6c1d6046341c",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32053,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33356,
"item_type": "Tips",
"name": "Tips",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "fe9f9609-8e9b-40df-bbf1-bdcf309c171b",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32054,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33357,
"item_type": "Annual Wage Supplement",
"name": "Annual Wage Supplement",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "80ce66ce-2900-447c-a939-a2129eb6f9c6",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32055,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33358,
"item_type": "Bonus",
"name": "Bonus",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "03a8c514-af78-4ce4-bf1e-2d3ecc33300a",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32056,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33359,
"item_type": "Bonus",
"name": "Prior Year Bonus",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ffc80169-76f2-4092-8d1f-25a96c78d407",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32057,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33360,
"item_type": "Annual Wage Supplement",
"name": "Prior Year AWS",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "5141c121-875b-4a92-b95d-201a05ae9659",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32058,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33361,
"item_type": "Leave Pay",
"name": "Leave Pay",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b9bcfbbc-20c5-41b3-b78e-a1a30ce12110",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Calculation"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32059,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33362,
"item_type": "Director fees",
"name": "Director fees",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d915cbd5-7d6b-45d7-96e0-08e51a722921",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32060,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33363,
"item_type": "Backdated Salary",
"name": "Backdated Salary Increment",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "cde486bf-ab58-4e9c-bfb8-b57fb84376b6",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32061,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33364,
"item_type": "Backdated Salary",
"name": "Backdated Salary",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "4dd0250b-d511-4cc0-b945-15c4d7ad3404",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32062,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33365,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "b9316a4e-d331-471c-9276-1113e9b26f00",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32063,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33366,
"item_type": "Others",
"name": "Others",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1a7e0560-a97e-412e-b24e-3762129c8b26",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32064,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33367,
"item_type": "Others",
"name": "Others(no gross)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "6a703373-aed8-49a6-b766-4ae914325df8",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32065,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33368,
"item_type": "Salary in Lieu",
"name": "Salary in lieu",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "676d3e90-61bc-4781-9bf0-59a7ef9dd875",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32066,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33369,
"item_type": "Incentive",
"name": "Onboarding incentive",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "3a381500-c0a8-4058-99fc-495af6a7acda",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32067,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33370,
"item_type": "Gratuity",
"name": "Gratuity paid for years of service",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b941bd5b-9455-4cc1-a015-4ddac90ccc6e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32068,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33371,
"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": "43a4af9b-5c6d-4e2b-ba7f-252eb30f7ed4",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32069,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33372,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)(no SHG contribution)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "dfdc9edb-4271-4d06-8de1-d9abcb8617e0",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32070,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33373,
"item_type": "Deduction",
"name": "NS Leave Claims Deduction",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "a487ab42-b1cd-4980-8190-dd8d067af7b8",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32071,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33374,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Personal Insurance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8792c15f-597c-4d00-9a67-6299a4d7f409",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32072,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33375,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Optical Expenses",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a06557a6-0b65-4fce-b17b-8354dfde5ec8",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32073,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33376,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Health Screening & Vaccinations",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "c029c78c-efdd-478f-b63e-d1dc2837efa9",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32074,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33377,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Childcare / Eldercare Fees For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "7115e7e4-d66c-4f5a-aa2f-f917bf93c0d2",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32075,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33378,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Medical Expenses For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a550dc36-532f-4499-ad2f-1c28c1092e1d",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32076,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33379,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Dental Expenses For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "e956fc0f-5f4d-4785-8951-3da3873dd462",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32077,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33380,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Gym Membership",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8a1d44e3-e07e-487a-8f14-35cd05f7f3ea",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32078,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33381,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Holiday Expenses",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "af3ac1bb-601c-4aac-bae2-1e42002aca27",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32079,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33382,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit TCM / CHIRO/ PHYSIO",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8064d994-403a-494d-a7d2-3fffd651371d",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32080,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33383,
"item_type": "Gratuity",
"name": "Gratuity",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "e15e391a-1769-4bb3-a548-f2c92161f34e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32081,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33384,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Work From Home",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b41c5279-8051-4b0b-9a6e-8f275751bc7b",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32082,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33385,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Mental Health Awareness",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "951f712b-14e6-4c97-ae2a-0fc6535d4161",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32083,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33386,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Personal Planning & Enrichment",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "015d6c18-8e60-4b5e-8da8-d1f0708fe317",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32084,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33387,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Home Affairs Support",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "7b320bb1-a04d-46ba-b031-da10f5d6b373",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32085,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33388,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Home Family Bonding Facilitation",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ec137ed4-d805-4c4d-8cbf-49d33b1dae5e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32086,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33389,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Professional Subscription",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "12324934-0fd5-4334-a882-10db9929e38b",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32087,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33390,
"item_type": "Regular Hours",
"name": "Regular Hours",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "df564106-27b7-4fd6-8292-88e51b3bb04a",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32088,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33391,
"item_type": "Overtime Hours",
"name": "Overtime Hours",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "02c75639-517a-4c81-ad71-745bdfeffd16",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32089,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33392,
"item_type": "Regular Days",
"name": "Regular Days",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "513e6739-4a57-4364-8a3a-5a1e51d2b14d",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32090,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33393,
"item_type": "Overtime Days",
"name": "Overtime Days",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "df7c2b9a-41c7-4cc5-8943-547604e7a7fa",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32091,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33394,
"item_type": "Public Holiday Pay",
"name": "Public Holiday Pay",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8e8d4cb2-98be-484f-aca9-5f98c925b64e",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32092,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33395,
"item_type": "Rest Day Pay",
"name": "Rest Day Pay",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "eed64db2-f7cf-4d10-909d-5e5c9222bfd5",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32093,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33396,
"item_type": "Deputy",
"name": "Deputy Awage",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "66f93148-8a18-4163-a91f-653867b6134c",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32094,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage",
"tax_allowance": false
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 33397,
"item_type": "Deputy",
"name": "Deputy",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ab4075b5-ffeb-4fc3-86ae-f0dc7997afb5",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32095,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"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/:id
PATCH https://api.talenox.com/api/v2/payroll/custom_pay_items/33482
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1bd6235fcbec7432d60d2ac311b4d47436d471f2
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": 33482,
"item_type": "Allowance",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ccc40dcb-d280-435b-bda3-4cb09256c793",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Period"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 32264,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage",
"tax_allowance": false
},
"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
POST https://api.talenox.com/api/v2/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0e44204cafea1709094d60608051f463089b0c2a
Parameters
{
"role": {
"name": "Manager",
"employee_ids": [
1471,
1472,
1473,
1474
]
}
}
| 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": 1469,
"name": "Manager",
"employee_ids": [
1471,
1472,
1473,
1474
],
"no_of_employees": 4
}
Delete Role
Request
Endpoint
DELETE https://api.talenox.com/api/v2/roles/:id
DELETE https://api.talenox.com/api/v2/roles/1511
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9ac2c1060f2ebd3c5420d7642a24701b612e50b0
Parameters
| Name | Description |
|---|---|
| id required | Role ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted role 1511"
}
List Roles
Request
Endpoint
GET https://api.talenox.com/api/v2/roles
GET https://api.talenox.com/api/v2/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer f96819336af55d14eb26599aa237925262de4dd2
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 1441,
"name": "electrician",
"employee_ids": [
1458
],
"no_of_employees": 1
},
{
"id": 1442,
"name": "teacher",
"employee_ids": [
1459
],
"no_of_employees": 1
},
{
"id": 1443,
"name": "tailor",
"employee_ids": [
1460
],
"no_of_employees": 1
},
{
"id": 1444,
"name": "philosopher",
"employee_ids": [
1461
],
"no_of_employees": 1
},
{
"id": 1445,
"name": "agriculturist",
"employee_ids": [
1462
],
"no_of_employees": 1
},
{
"id": 1446,
"name": "physicist",
"employee_ids": [
1463
],
"no_of_employees": 1
},
{
"id": 1447,
"name": "pilot",
"employee_ids": [
1464
],
"no_of_employees": 1
},
{
"id": 1448,
"name": "attorney",
"employee_ids": [
1465
],
"no_of_employees": 1
},
{
"id": 1449,
"name": "plumber",
"employee_ids": [
1466
],
"no_of_employees": 1
},
{
"id": 1450,
"name": "biologist",
"employee_ids": [
1467
],
"no_of_employees": 1
},
{
"id": 1451,
"name": "builder",
"employee_ids": [
1468
],
"no_of_employees": 1
},
{
"id": 1452,
"name": "rljecoztdgzbyscpgeoolaoexsetksig",
"employee_ids": [],
"no_of_employees": 0
},
{
"id": 1453,
"name": "cybvtckzqpquokdzlioiegdulduyecpc",
"employee_ids": [],
"no_of_employees": 0
},
{
"id": 1454,
"name": "Engineer",
"employee_ids": [
1469,
1470
],
"no_of_employees": 2
}
]
Show Role
Request
Endpoint
GET https://api.talenox.com/api/v2/roles/:id
GET https://api.talenox.com/api/v2/roles/1483
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0ebac230b8ecda2dd81c934ecd4a2ccc03835b5a
Parameters
| Name | Description |
|---|---|
| id required | Role ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 1483,
"name": "Engineer",
"employee_ids": [
1495,
1496
],
"no_of_employees": 2
}
Update Role
Request
Endpoint
PUT https://api.talenox.com/api/v2/roles/:id
PUT https://api.talenox.com/api/v2/roles/1497
Accept: application/json
Content-Type: application/json
Authorization: Bearer d27b030409573bd5f0918f73549c8e5999b7229e
Parameters
{
"role": {
"name": "New Role Name",
"employee_ids": [
1497,
1498,
1499,
1500
]
}
}
| Name | Description |
|---|---|
| id required | Role ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 1497,
"name": "New Role Name",
"employee_ids": [
1497,
1498,
1499,
1500
],
"no_of_employees": 4
}
Employees
Create HK Employee
Request
Endpoint
POST https://api.talenox.com/api/v2/employees
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer 42dfd3583632a6f731961f8755d5dd1e2a51750e
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",
"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_attributes | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| rate_of_pay | Rate of pay |
| currency | Currency |
| 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 ["3%", "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 ["3%", "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": 803,
"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-ae1f3f01",
"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": 938,
"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": 1073,
"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
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer c0f40f984ba61a237fafcfc7b228d2b831d47581
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",
"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_attributes | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| rate_of_pay | Rate of pay |
| currency | Currency |
| 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": 805,
"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-379096be",
"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": 948,
"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": 1091,
"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
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer 898b627dc6e5fcb231e8d8dbbe4a50ab85e2c559
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",
"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_attributes | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| rate_of_pay | Rate of pay |
| currency | Currency |
| 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": 804,
"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-8665a46a",
"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": 943,
"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": 1082,
"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
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer 013aa17b104a85994b1277a32a98d4b40f605e2d
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",
"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
],
"next_of_kins_attributes": [
{
"name": "John Doe",
"relationship": "Father",
"birthdate": "01/01/2015",
"contact_number": 123456789,
"alternate_contact_number": 987654321,
"citizenship": "Singaporean",
"gender": "Male"
}
]
}
}
| 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_attributes | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| rate_of_pay | Rate of pay |
| currency | Currency |
| 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 |
| preapproved_letter_of_consent_expiry_date | Pre-Approved Letter of consent expiry date |
| preapproved_letter_of_consent_issue_date | Pre-Approved 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": 802,
"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-1967bebd",
"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": "Lynch Spur",
"employee_ids": [
802
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null,
"enable_custom_mpf": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null,
"custom_empf_scheme": null,
"custom_empf_payroll_group_name": null
},
{
"id": 13,
"name": "Quigley Burgs",
"employee_ids": [
802
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null,
"enable_custom_mpf": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null,
"custom_empf_scheme": null,
"custom_empf_payroll_group_name": null
}
],
"default_cost_centre": {
"id": 12,
"name": "Lynch Spur",
"employee_ids": [
802
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null,
"enable_custom_mpf": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null,
"custom_empf_scheme": null,
"custom_empf_payroll_group_name": 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": [
{
"id": 1,
"employee_id": 802,
"name": "John Doe",
"relationship": "Father",
"contact_number": "123456789",
"alternate_contact_number": "987654321",
"birthdate": "2015-01-01",
"gender": "Male",
"marriage_date": null,
"ssn": null,
"passport": null,
"citizenship": "Singaporean"
}
],
"bank_account": {
"id": 933,
"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": 1064,
"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/:id
DELETE https://api.talenox.com/api/v2/employees/817
Accept: application/json
Content-Type: application/json
Authorization: Bearer e3db2b9a0326ed74e536b70c11fb745087bb703f
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/:id
GET https://api.talenox.com/api/v2/employees/812
Accept: application/json
Content-Type: application/json
Authorization: Bearer be1135951633f1c4e82fb7701c716061448f510f
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 812,
"employee_id": "00001",
"first_name": "Al",
"middle_name": null,
"last_name": "Lynch",
"identification_full_name": null,
"email": "johnie.kassulke@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2022-10-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": "1987-06-26",
"slug": "al-lynch-1f91d9ef",
"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": 965,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Al Lynch",
"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": 1118,
"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": "2025-06-26",
"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-10-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
GET https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer 30179276685ccb81268ecf93ef1aee057d7e9b42
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 806,
"employee_id": "00001",
"first_name": "Sal",
"middle_name": null,
"last_name": "Bogan",
"identification_full_name": null,
"email": "juana.spencer@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2024-10-14",
"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": "1988-06-26",
"slug": "sal-bogan-546b5f8f",
"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": "14/10/2024",
"end_date": null,
"remarks": null,
"amount": "7516.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 51,
"title": "Title1",
"department": null,
"start_date": "14/10/2024",
"end_date": null,
"remarks": null,
"amount": "7516.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [],
"bank_account": {
"id": 951,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Sal Bogan",
"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": 1096,
"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": "2025-06-26",
"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-10-14",
"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": 807,
"employee_id": "00002",
"first_name": "Jolene",
"middle_name": null,
"last_name": "Kris",
"identification_full_name": null,
"email": "demarcus@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2023-09-26",
"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": "1985-06-26",
"slug": "jolene-kris-ed860eb9",
"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": 953,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Jolene Kris",
"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": 1099,
"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": "2025-06-26",
"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-26",
"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": 808,
"employee_id": "00003",
"first_name": "Raphael",
"middle_name": null,
"last_name": "Johns",
"identification_full_name": null,
"email": "alexander_feeney@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2024-03-06",
"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": "1995-06-26",
"slug": "raphael-johns-23f77249",
"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": 955,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Raphael Johns",
"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": 1102,
"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": "2025-06-26",
"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-03-06",
"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/:id
PUT https://api.talenox.com/api/v2/employees/814
Accept: application/json
Content-Type: application/json
Authorization: Bearer cef48d1640748ae4ab2897e2f33da736bcd79bf4
Parameters
{
"employee": {
"first_name": "Mary",
"last_name": "Lan"
}
}
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 814,
"employee_id": "00001",
"first_name": "Mary",
"middle_name": null,
"last_name": "Lan",
"identification_full_name": null,
"email": "malia_west@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2024-07-17",
"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-06-26",
"slug": "mary-lan-885af120",
"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": 971,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Addie Johnston",
"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": 1128,
"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": "2025-06-26",
"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-07-17",
"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
}
}
Holiday Policies
Holiday policies allow management of public and statutory holidays for companies. They can be created and assigned to employees based in different countries, and customized per company requirements.
Create Holiday Policy
Request
Endpoint
POST https://api.talenox.com/api/v2/holiday_policies
POST https://api.talenox.com/api/v2/holiday_policies
Accept: application/json
Content-Type: application/json
Authorization: Bearer 669c65f488ac4be004da2b8576fecd28e0cb5985
Parameters
{
"name": "New Holiday Policy",
"country_id": 2,
"description": "Test holiday policy"
}
| Name | Description |
|---|---|
| name required | Name of the holiday policy |
| country_id | Country ID for the policy |
| state_id | State/Region ID for the policy |
| description | Description of the policy |
| employee_ids | Array of employee IDs to assign to this policy |
Response
content-type: application/json; charset=utf-8
201 Created
{
"id": 214,
"name": "New Holiday Policy",
"is_default": false,
"country_id": 2,
"country_name": "Singapore",
"country_code": "SG",
"state_id": null,
"state_name": null,
"description": "Test holiday policy",
"created_at": "2025-06-26T08:20:13.313Z",
"updated_at": "2025-06-26T08:20:13.313Z"
}
Delete Holiday Policy
Request
Endpoint
DELETE https://api.talenox.com/api/v2/holiday_policies/:id
DELETE https://api.talenox.com/api/v2/holiday_policies/226
Accept: application/json
Content-Type: application/json
Authorization: Bearer 81bd912c3b647e3db5bd1aaa60806fb2ae776031
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"message": "holiday policy deleted successfully",
"timestamp": "2025-06-26T16:20:38.028+08:00"
}
Delete Holiday Policy Modification
Request
Endpoint
DELETE https://api.talenox.com/api/v2/holiday_policies/:id/modifications
DELETE https://api.talenox.com/api/v2/holiday_policies/237/modifications
Accept: application/json
Content-Type: application/json
Authorization: Bearer 48487280aa9cae7c1ee7dbe3935525f748a2f396
Parameters
{
"holiday_date": "2025-06-26"
}
| Name | Description |
|---|---|
| holiday_date required | Holiday date to delete modification for (YYYY-MM-DD) |
Response
content-type: application/json; charset=utf-8
200 OK
{
"message": "holiday policy modification deleted successfully",
"holiday_date": "2025-06-26",
"timestamp": "2025-06-26T16:21:00.052+08:00"
}
Get Calendar Events by Default Holiday Policy
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies/company_holidays
GET https://api.talenox.com/api/v2/holiday_policies/company_holidays?year=2025&show_inactive=false
Accept: application/json
Content-Type: application/json
Authorization: Bearer 177e0d6f9a56f0eeefc81de35b706495a52ee182
Parameters
year: 2025
show_inactive: false
| Name | Description |
|---|---|
| company_id | Company ID (defaults to current user's company) |
| year | Year to fetch holidays for |
| show_inactive | Include inactive holidays |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"holiday_date": "2025-06-26",
"name": "Company Custom Holiday",
"duration": "all_day",
"holiday_type": "public_holiday",
"is_active": true,
"holiday_source": "user"
},
{
"holiday_date": "2025-06-27",
"name": "Company Custom Holiday",
"duration": "all_day",
"holiday_type": "public_holiday",
"is_active": true,
"holiday_source": "user"
}
]
Get Calendar Events for Holiday Policy
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies/:id
GET https://api.talenox.com/api/v2/holiday_policies/216?start_at=2025-01-01&end_at=2025-12-31
Accept: application/json
Content-Type: application/json
Authorization: Bearer ed0978bd38d9f2b5f9c15f3e6c6b008676aa71e4
Parameters
start_at: 2025-01-01
end_at: 2025-12-31
| Name | Description |
|---|---|
| start_at required | Start date (YYYY-MM-DD) |
| end_at required | End date (YYYY-MM-DD) |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 216,
"name": "Custom Policy",
"is_default": false,
"country_id": 2,
"country_name": "Singapore",
"country_code": "SG",
"state_id": null,
"state_name": null,
"description": "A test holiday policy",
"created_at": "2025-06-26T08:20:17.272Z",
"updated_at": "2025-06-26T08:20:17.272Z",
"calendar_events": [
{
"holiday_date": "2025-06-26",
"name": "New Year Day",
"duration": "all_day",
"holiday_type": "public_holiday",
"is_active": true,
"holiday_source": "api_subscription"
}
]
}
Get Calendar Events including inactive holidays
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies/company_holidays
GET https://api.talenox.com/api/v2/holiday_policies/company_holidays?year=2025&show_inactive=true
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7a3ffb960b85141fac9c99ccd0b3958129fa58df
Parameters
year: 2025
show_inactive: true
| Name | Description |
|---|---|
| company_id | Company ID (defaults to current user's company) |
| year | Year to fetch holidays for |
| show_inactive | Include inactive holidays |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"holiday_date": "2025-06-26",
"name": "Company Custom Holiday",
"duration": "all_day",
"holiday_type": "public_holiday",
"is_active": true,
"holiday_source": "user"
},
{
"holiday_date": "2025-06-27",
"name": "Company Custom Holiday",
"duration": "all_day",
"holiday_type": "public_holiday",
"is_active": true,
"holiday_source": "user"
}
]
Get Countries
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies/countries
GET https://api.talenox.com/api/v2/holiday_policies/countries
Accept: application/json
Content-Type: application/json
Authorization: Bearer 92925e1ce056ff8c4e94f5f4b8b5185bd2ed3e65
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 18,
"name": "Australia",
"country_code": "AU"
},
{
"id": 11,
"name": "Brunei",
"country_code": "BN"
},
{
"id": 16,
"name": "Cambodia",
"country_code": "KH"
},
{
"id": 7,
"name": "Canada",
"country_code": "CA"
},
{
"id": 24,
"name": "Cayman Islands",
"country_code": "KY"
},
{
"id": 12,
"name": "China",
"country_code": "CN"
},
{
"id": 23,
"name": "Global",
"country_code": "ZZ"
},
{
"id": 3,
"name": "Hong Kong",
"country_code": "HK"
},
{
"id": 17,
"name": "India",
"country_code": "IN"
},
{
"id": 10,
"name": "Indonesia",
"country_code": "ID"
},
{
"id": 19,
"name": "Japan",
"country_code": "JP"
},
{
"id": 25,
"name": "Macau",
"country_code": "MO"
},
{
"id": 4,
"name": "Malaysia",
"country_code": "MY"
},
{
"id": 13,
"name": "Myanmar",
"country_code": "MM"
},
{
"id": 20,
"name": "Pakistan",
"country_code": "PK"
},
{
"id": 14,
"name": "Philippines",
"country_code": "PH"
},
{
"id": 1,
"name": "Qatar",
"country_code": "QA"
},
{
"id": 2,
"name": "Singapore",
"country_code": "SG"
},
{
"id": 22,
"name": "South Africa",
"country_code": "ZA"
},
{
"id": 15,
"name": "Taiwan",
"country_code": "TW"
},
{
"id": 6,
"name": "Thailand",
"country_code": "TH"
},
{
"id": 21,
"name": "United Arab Emirates",
"country_code": "AE"
},
{
"id": 8,
"name": "United Kingdom",
"country_code": "GB"
},
{
"id": 5,
"name": "United States",
"country_code": "US"
},
{
"id": 9,
"name": "Vietnam",
"country_code": "VN"
}
]
Get Country Holidays by Country Code
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies/country_holidays
GET https://api.talenox.com/api/v2/holiday_policies/country_holidays?country_code=SG&start_at=2025-01-01&end_at=2025-12-31
Accept: application/json
Content-Type: application/json
Authorization: Bearer 11e929414edb40ebc4c389e508d148d6a8bc0595
Parameters
country_code: SG
start_at: 2025-01-01
end_at: 2025-12-31
| Name | Description |
|---|---|
| country_id | Country ID to get holidays for |
| country_code | Country code to get holidays for (alternative to country_id) |
| state_id | State/Region ID for regional holidays |
| start_at required | Start date (YYYY-MM-DD) |
| end_at required | End date (YYYY-MM-DD) |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"holiday_date": "2025-06-26",
"name": "New Year Day",
"duration": "all_day",
"holiday_type": "public_holiday",
"is_active": true,
"holiday_source": "api_subscription"
}
]
Get Country Holidays by Country ID
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies/country_holidays
GET https://api.talenox.com/api/v2/holiday_policies/country_holidays?country_id=2&start_at=2025-01-01&end_at=2025-12-31
Accept: application/json
Content-Type: application/json
Authorization: Bearer 42a269c645bae5daa57f94232509c0bb26172e78
Parameters
country_id: 2
start_at: 2025-01-01
end_at: 2025-12-31
| Name | Description |
|---|---|
| country_id | Country ID to get holidays for |
| country_code | Country code to get holidays for (alternative to country_id) |
| state_id | State/Region ID for regional holidays |
| start_at required | Start date (YYYY-MM-DD) |
| end_at required | End date (YYYY-MM-DD) |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"holiday_date": "2025-06-26",
"name": "New Year Day",
"duration": "all_day",
"holiday_type": "public_holiday",
"is_active": true,
"holiday_source": "api_subscription"
}
]
Get Country Holidays with State Filter
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies/country_holidays
GET https://api.talenox.com/api/v2/holiday_policies/country_holidays?country_id=4&state_id=14&start_at=2025-01-01&end_at=2025-12-31
Accept: application/json
Content-Type: application/json
Authorization: Bearer 76a0d8a1c7f2c128eadbd2538d41b78274605c96
Parameters
country_id: 4
state_id: 14
start_at: 2025-01-01
end_at: 2025-12-31
| Name | Description |
|---|---|
| country_id | Country ID to get holidays for |
| country_code | Country code to get holidays for (alternative to country_id) |
| state_id | State/Region ID for regional holidays |
| start_at required | Start date (YYYY-MM-DD) |
| end_at required | End date (YYYY-MM-DD) |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"holiday_date": "2025-06-26",
"name": "State Holiday",
"duration": "all_day",
"holiday_type": "public_holiday",
"is_active": true,
"holiday_source": "api_subscription"
}
]
Get States for Country
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies/states
GET https://api.talenox.com/api/v2/holiday_policies/states?country_id=1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5336e27f3cf87d0953a1bba0452ac7d602ad3e33
Parameters
country_id: 1
| Name | Description |
|---|---|
| country_id required | Country ID to get states for |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 1,
"name": "Ad Dawhah"
},
{
"id": 2,
"name": "Al Ghuwayriyah"
},
{
"id": 3,
"name": "Al Jumayliyah"
},
{
"id": 4,
"name": "Al Khawr"
},
{
"id": 5,
"name": "Al Wakrah"
},
{
"id": 6,
"name": "Ar Rayyan"
},
{
"id": 7,
"name": "Jarayan al Batinah"
},
{
"id": 8,
"name": "Madinat ash Shamal"
},
{
"id": 9,
"name": "Umm Sa'id"
},
{
"id": 10,
"name": "Umm Salal"
}
]
List Holiday Policies
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies
GET https://api.talenox.com/api/v2/holiday_policies
Accept: application/json
Content-Type: application/json
Authorization: Bearer 101ed6aeb013e59a26cdd350e482b707868c4f8c
Parameters
| Name | Description |
|---|---|
| last_seen_id | ID of the last holiday policy seen for pagination |
| limit | Number of results to return (max 50) |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 206,
"name": "Test Holiday Policy",
"is_default": true,
"country_id": 2,
"country_name": "Singapore",
"country_code": "SG",
"state_id": null,
"state_name": null,
"description": "A test holiday policy",
"created_at": "2025-06-26T08:19:58.300Z",
"updated_at": "2025-06-26T08:20:00.924Z"
},
{
"id": 207,
"name": "Custom Policy",
"is_default": false,
"country_id": 2,
"country_name": "Singapore",
"country_code": "SG",
"state_id": null,
"state_name": null,
"description": "A test holiday policy",
"created_at": "2025-06-26T08:20:00.875Z",
"updated_at": "2025-06-26T08:20:00.875Z"
}
]
List Holiday Policies with custom limit
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies
GET https://api.talenox.com/api/v2/holiday_policies?limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3e7c764088cad3f408ea00fcbcff0727edb21fb4
Parameters
limit: 5
| Name | Description |
|---|---|
| last_seen_id | ID of the last holiday policy seen for pagination |
| limit | Number of results to return (max 50) |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 210,
"name": "Test Holiday Policy",
"is_default": true,
"country_id": 2,
"country_name": "Singapore",
"country_code": "SG",
"state_id": null,
"state_name": null,
"description": "A test holiday policy",
"created_at": "2025-06-26T08:20:05.231Z",
"updated_at": "2025-06-26T08:20:07.968Z"
},
{
"id": 211,
"name": "Custom Policy",
"is_default": false,
"country_id": 2,
"country_name": "Singapore",
"country_code": "SG",
"state_id": null,
"state_name": null,
"description": "A test holiday policy",
"created_at": "2025-06-26T08:20:07.923Z",
"updated_at": "2025-06-26T08:20:07.923Z"
}
]
List Holiday Policies with pagination
Request
Endpoint
GET https://api.talenox.com/api/v2/holiday_policies
GET https://api.talenox.com/api/v2/holiday_policies?last_seen_id=208&limit=20
Accept: application/json
Content-Type: application/json
Authorization: Bearer fae0cc5df61d44c809c315da8bd5ca4da7e31e6a
Parameters
last_seen_id: 208
limit: 20
| Name | Description |
|---|---|
| last_seen_id | ID of the last holiday policy seen for pagination |
| limit | Number of results to return (max 50) |
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 209,
"name": "Custom Policy",
"is_default": false,
"country_id": 2,
"country_name": "Singapore",
"country_code": "SG",
"state_id": null,
"state_name": null,
"description": "A test holiday policy",
"created_at": "2025-06-26T08:20:04.328Z",
"updated_at": "2025-06-26T08:20:04.328Z"
}
]
Update Holiday Policy
Request
Endpoint
PUT https://api.talenox.com/api/v2/holiday_policies/:id
PUT https://api.talenox.com/api/v2/holiday_policies/222
Accept: application/json
Content-Type: application/json
Authorization: Bearer d9b61018f984799be3c947ed6646a2993e2d305d
Parameters
{
"name": "Updated Policy Name",
"description": "Updated description"
}
| Name | Description |
|---|---|
| name | Name of the holiday policy |
| country_id | Country ID for the policy |
| state_id | State/Region ID for the policy |
| description | Description of the policy |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 222,
"name": "Updated Policy Name",
"is_default": false,
"country_id": 2,
"country_name": "Singapore",
"country_code": "SG",
"state_id": null,
"state_name": null,
"description": "Updated description",
"created_at": "2025-06-26T08:20:30.371Z",
"updated_at": "2025-06-26T08:20:30.585Z"
}
Upsert Holiday Policy Modification
Request
Endpoint
POST https://api.talenox.com/api/v2/holiday_policies/:id/modifications
POST https://api.talenox.com/api/v2/holiday_policies/231/modifications
Accept: application/json
Content-Type: application/json
Authorization: Bearer 522f588b7e61255571bdc451e27f8a3ae9fefd0c
Parameters
{
"holiday_date": "2024-06-15",
"name": "Custom Holiday",
"duration": "all_day",
"is_active": true,
"holiday_type": "public_holiday"
}
| Name | Description |
|---|---|
| holiday_date required | Holiday date (YYYY-MM-DD) |
| name required | Name of the holiday |
| duration required | Duration of holiday (all_day, first_half_of_day, second_half_of_day) |
| is_active required | Whether the holiday is active |
| holiday_type | Type of holiday (public_holiday, statutory_holiday) |
Response
content-type: application/json; charset=utf-8
200 OK
{
"message": "holiday policy modification upserted successfully",
"modification": {
"holiday_date": "2024-06-15",
"name": "Custom Holiday",
"duration": "all_day",
"holiday_type": "public_holiday",
"is_active": true
},
"timestamp": "2025-06-26T16:20:49.456+08:00"
}
Jobs
Create Job
Request
Endpoint
POST https://api.talenox.com/api/v2/jobs
POST https://api.talenox.com/api/v2/jobs
Accept: application/json
Content-Type: application/json
Authorization: Bearer 76632dd87aa74db0ecd278f0096decbcf956064d
Parameters
{
"title": "",
"employee_id": 1202,
"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/:id
DELETE https://api.talenox.com/api/v2/jobs/66
Accept: application/json
Content-Type: application/json
Authorization: Bearer e7793f0ec3cc64b3bbb9feb02b4066ead75da2b1
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/:id
GET https://api.talenox.com/api/v2/jobs/63
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0ec5d0ae3bcf457ef952527bceafc29ea7e1abd9
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 63,
"title": "Title1",
"department": null,
"start_date": "26/06/2025",
"end_date": null,
"remarks": null,
"amount": "2941.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
Update Job
Request
Endpoint
PUT https://api.talenox.com/api/v2/jobs/:id
PUT https://api.talenox.com/api/v2/jobs/64
Accept: application/json
Content-Type: application/json
Authorization: Bearer b9bcd642d6be391f661cfc6791333776772d4616
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?
GET https://api.talenox.com/api/v2/leave??employee_ids[]=1379
Accept: application/json
Content-Type: application/json
Authorization: Bearer a275d3d6774a051b48f59cf14955214fd2e07358
Parameters
?employee_ids: ["1379"]
| 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": 393,
"employee_id": 1379,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2025-06-26",
"start_date_which_half": "AM",
"end_at": "2025-06-26",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2025-06-26",
"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": 393,
"employee_id": 1379,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2025-06-26",
"start_date_which_half": "AM",
"end_at": "2025-06-26",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2025-06-26",
"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": 393,
"employee_id": 1379,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2025-06-26",
"start_date_which_half": "AM",
"end_at": "2025-06-26",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2025-06-26",
"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/:id
PATCH https://api.talenox.com/api/v2/leave_beta/applications/approve/21
Accept: application/json
Content-Type: application/json
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 21,
"timestamp": "2025-06-26T21:25:05.797+08:00"
}
Create leave application
Request
Endpoint
POST https://api.talenox.com/api/v2/leave_beta/applications
POST https://api.talenox.com/api/v2/leave_beta/applications
Accept: application/json
Content-Type: application/json
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
Parameters
{
"employee_id": 1294,
"category_id": 61,
"category": "type",
"start_date": "2025-06-02",
"end_date": "2025-06-02",
"remarks": "test",
"working_days": [
{
"date": "2025-06-02",
"type": "full_day"
}
],
"applied_durations": [
{
"date": "2025-06-02",
"type": "full_day"
}
],
"approvers": [
{
"approver_id": 1287,
"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/:id
DELETE https://api.talenox.com/api/v2/leave_beta/applications/15
Accept: application/json
Content-Type: application/json
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
Parameters
| Name | Description |
|---|---|
| id required | Leave Application ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 15,
"status": "success",
"timestamp": "2025-06-26T20:24:31.824+08:00"
}
Delete leave attachments
Deletes up to 10 attachment ids
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/attachments
DELETE https://api.talenox.com/api/v2/leave_beta/attachments?ids=4,2
Accept: application/json
Content-Type: application/json
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
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": "2025-06-26T23:04:23.411+08:00"
}
Get leave application by id
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications/:id
GET https://api.talenox.com/api/v2/leave_beta/applications/14
Accept: application/json
Content-Type: application/json
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
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/253/1294/2/dummy_image.png",
"file_preview_url": "/uploads/attachment/253/1294/2/preview_dummy_image.png"
}
],
"category_class": "type",
"category_id": 84,
"created_at": "2025-06-26T12:24:11.798Z",
"employee_id": 1294,
"end_date": "2025-06-26",
"end_time": "PM",
"id": 14,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-06-26",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-06-26T12:24:11.798Z"
}
List all leave applications
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications
GET https://api.talenox.com/api/v2/leave_beta/applications?overlap_from=2025-06-26&overlap_to=2025-06-27
Accept: application/json
Content-Type: application/json
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
Parameters
overlap_from: 2025-06-26
overlap_to: 2025-06-27
| 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": 71,
"created_at": "2025-06-26T11:23:13.070Z",
"employee_id": 1294,
"end_date": "2025-06-26",
"end_time": "PM",
"id": 1,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-06-26",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-06-26T11:23:13.070Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 72,
"created_at": "2025-06-26T11:23:13.710Z",
"employee_id": 1294,
"end_date": "2025-06-26",
"end_time": "PM",
"id": 2,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-06-26",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-06-26T11:23:13.710Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 73,
"created_at": "2025-06-26T11:23:14.399Z",
"employee_id": 1294,
"end_date": "2025-06-26",
"end_time": "PM",
"id": 3,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-06-26",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-06-26T11:23:14.399Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": [
{
"attachment_id": 1,
"filename": "dummy_image.png",
"file_size": 31798,
"file_url": "/uploads/attachment/253/1294/1/dummy_image.png",
"file_preview_url": "/uploads/attachment/253/1294/1/preview_dummy_image.png"
}
],
"category_class": "type",
"category_id": 74,
"created_at": "2025-06-26T11:23:15.016Z",
"employee_id": 1294,
"end_date": "2025-06-26",
"end_time": "PM",
"id": 4,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-06-26",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-06-26T11:23:15.016Z"
}
]
List all leave applications by application status and created dates
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications
GET https://api.talenox.com/api/v2/leave_beta/applications?overlap_from=2025-06-26&overlap_to=2025-06-27&created_start=2025-06-25&created_end=2025-06-27&leave_application_status=pending
Accept: application/json
Content-Type: application/json
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
Parameters
overlap_from: 2025-06-26
overlap_to: 2025-06-27
created_start: 2025-06-25
created_end: 2025-06-27
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": 75,
"created_at": "2025-06-26T11:23:19.566Z",
"employee_id": 1294,
"end_date": "2025-06-26",
"end_time": "PM",
"id": 5,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-06-26",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-06-26T11:23:19.566Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 76,
"created_at": "2025-06-26T11:23:22.734Z",
"employee_id": 1294,
"end_date": "2025-06-26",
"end_time": "PM",
"id": 6,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-06-26",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-06-26T11:23:22.734Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 77,
"created_at": "2025-06-26T11:23:25.587Z",
"employee_id": 1294,
"end_date": "2025-06-26",
"end_time": "PM",
"id": 7,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-06-26",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-06-26T11:23:25.587Z"
}
]
Reject leave
This rejects a pending leave application
Request
Endpoint
PATCH https://api.talenox.com/api/v2/leave_beta/applications/reject/:id
PATCH https://api.talenox.com/api/v2/leave_beta/applications/reject/28
Accept: application/json
Content-Type: application/json
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 28,
"timestamp": "2025-06-26T23:04:04.714+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
POST https://api.talenox.com/api/v2/leave_beta/attachments/upload
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="leave_application_id"
30
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="employee_id"
1294
------------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
DELETE https://api.talenox.com/api/v2/leave_beta/applications?employee_id=1294&leave_application_ids=11
Accept: application/json
Content-Type: application/json
Authorization: Bearer eBVwRLDcvihA06dBvCiFewqemLv2BoKgrJb3GlMgCRE
Parameters
employee_id: 1294
leave_application_ids: 11
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"message": "Leave application ids for input employee id 1294 processed successfully",
"errors": {},
"timestamp": "2025-06-26T20:24:05.096+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/:id/levels
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/124/levels
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
{
"approvers": [
{
"approver_ids": [
1309
],
"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": [
1314
]
},
{
"level": 2,
"approvers": [
1309
]
}
],
"company_default": true,
"id": 124,
"levels": 2,
"name": "Structure ulhmgl328a",
"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/:id/assign_approvers
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/118/assign_approvers
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
{
"approvers": [
{
"approver_ids": [
1309
],
"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": [
1314,
1309
]
}
],
"company_default": true,
"id": 118,
"levels": 1,
"name": "Structure 4tyfyfu4aq",
"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/:id/assign_employees
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/112/assign_employees?employee_ids=1309,1314
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
employee_ids: 1309,1314
| 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": [
1309,
1314
]
}
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
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures?company_id=305
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
company_id: 305
| 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": [
1314
]
}
],
"company_default": true,
"id": 96,
"levels": 1,
"name": "Structure ye96yigwgs",
"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/:id/employees
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/109/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
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
[
1309,
1310
]
Remove levels to a leave approval structure
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/levels
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/127/levels
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
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": "2025-06-26T23:05:50.008+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/:id/unassign_approvers
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/121/unassign_approvers
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
{
"approvers": [
{
"approver_ids": [
1314
],
"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": "2025-06-26T23:05:36.947+08:00"
}
Unassign employees of a leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/unassign_employees
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/115/unassign_employees?employee_ids=1309,1314
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
employee_ids: 1309,1314
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": 1314
}
],
"timestamp": "2025-06-26T23:05:25.109+08:00"
}
creates a leave approval structure
Request
Endpoint
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
{
"name": "new Test LAS ",
"company_id": 305,
"company_default": false,
"employee_ids": [
1309,
1314
]
}
| 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": 95,
"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/:id
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/108
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"message": "leave approval structure deleted successfully",
"timestamp": "2025-06-26T23:05:07.188+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/:id
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/99
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
| Name | Description |
|---|---|
| id required | Leave Approval Structure ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"approvers": [
{
"level": 1,
"approvers": [
1314
]
}
],
"company_default": true,
"id": 99,
"levels": 1,
"name": "Structure z2x96iasuw",
"number_of_employees": 2
}
updates a leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/102
Accept: application/json
Content-Type: application/json
Authorization: Bearer uHvoOVcS-x2HpI0-CNNy1Q9t444THabA-Hs_n4cjZnA
Parameters
{
"name": "new Test LAS 2",
"company_id": 305,
"employee_ids": [
1309,
1314
]
}
| 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": [
1314
]
}
],
"company_default": true,
"id": 102,
"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
GET https://api.talenox.com/api/v2/leave_beta/approvers?employee_id=1351&approver_id=38
Accept: application/json
Content-Type: application/json
Authorization: Bearer hZKhD0g4q2fJfKqFno9M_G5QJF0dLnUhCzjNlorYc4g
Parameters
employee_id: 1351
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": [
1352
],
"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
GET https://api.talenox.com/api/v2/leave_beta/approvers?employee_id=1351
Accept: application/json
Content-Type: application/json
Authorization: Bearer hZKhD0g4q2fJfKqFno9M_G5QJF0dLnUhCzjNlorYc4g
Parameters
employee_id: 1351
| 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": [
1352
],
"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
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance?employee_id=1368&query_date=20250626&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer M45s_k1VJInuaRkFl9t-HoY3brHbahM55LByH0Bptx8
Parameters
employee_id: 1368
query_date: 20250626
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": 1368,
"query_date": "2025-06-26",
"timestamp": "2025-06-26T23:06:24.712+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
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance?employee_id=1368&query_date=20250626&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer M45s_k1VJInuaRkFl9t-HoY3brHbahM55LByH0Bptx8
Parameters
employee_id: 1368
query_date: 20250626
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": 1368,
"query_date": "2025-06-26",
"timestamp": "2025-06-26T23:06:24.989+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/:id
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer M45s_k1VJInuaRkFl9t-HoY3brHbahM55LByH0Bptx8
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-07-26",
"policy_start_date": "2025-06-26",
"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
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/entitlement_period?employee_id=1368&id=6&query_date=20250626
Accept: application/json
Content-Type: application/json
Authorization: Bearer M45s_k1VJInuaRkFl9t-HoY3brHbahM55LByH0Bptx8
Parameters
employee_id: 1368
id: 6
query_date: 20250626
| 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": 1368,
"leave_type_id": 6,
"query_date": "2025-06-26",
"timestamp": "2025-06-26T23:06:25.249+08:00",
"valid_periods": {
"end_date": "2025-07-26",
"errors": [],
"start_date": "2025-06-26"
}
}
List all off in lieus
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
Accept: application/json
Content-Type: application/json
Authorization: Bearer M45s_k1VJInuaRkFl9t-HoY3brHbahM55LByH0Bptx8
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-07-26",
"policy_start_date": "2025-06-26",
"quantity_type": "day"
}
]
List off in lieus for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus?employee_id=1368&id=2
Accept: application/json
Content-Type: application/json
Authorization: Bearer M45s_k1VJInuaRkFl9t-HoY3brHbahM55LByH0Bptx8
Parameters
employee_id: 1368
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-07-26",
"policy_start_date": "2025-06-26",
"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
GET https://api.talenox.com/api/v2/leave_beta/types/balance?employee_id=1361&id=150&query_date=20250626
Accept: application/json
Content-Type: application/json
Authorization: Bearer Q7cqlXQEYuu9B8cyd4AZfnm-0x_tUdfbXp5YFqUxARQ
Parameters
employee_id: 1361
id: 150
query_date: 20250626
| 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": 1361,
"query_date": "2025-06-26",
"timestamp": "2025-06-26T23:06:16.831+08:00",
"results": [
{
"balance": 10.0,
"errors": [],
"leave_type_id": 150
}
]
}
Get leave balance for all leave types of an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/balance
GET https://api.talenox.com/api/v2/leave_beta/types/balance?employee_id=1361&query_date=20250626&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer Q7cqlXQEYuu9B8cyd4AZfnm-0x_tUdfbXp5YFqUxARQ
Parameters
employee_id: 1361
query_date: 20250626
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": 1361,
"query_date": "2025-06-26",
"timestamp": "2025-06-26T23:06:16.622+08:00",
"results": [
{
"balance": 10.0,
"errors": [],
"leave_type_id": 150
},
{
"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": 151
},
{
"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": 152
},
{
"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": 153
},
{
"balance": 365.0,
"errors": [],
"leave_type_id": 154
}
]
}
Get leave entitlement for an employee and leave type
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/entitlement_period
GET https://api.talenox.com/api/v2/leave_beta/types/entitlement_period?employee_id=1361&id=150&query_date=20250626
Accept: application/json
Content-Type: application/json
Authorization: Bearer Q7cqlXQEYuu9B8cyd4AZfnm-0x_tUdfbXp5YFqUxARQ
Parameters
employee_id: 1361
id: 150
query_date: 20250626
| 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": 1361,
"leave_type_id": 150,
"query_date": "2025-06-26",
"timestamp": "2025-06-26T23:06:16.999+08:00",
"valid_periods": [
{
"end_date": "2024-12-31",
"errors": [],
"start_date": "2024-06-26"
},
{
"end_date": "2025-12-31",
"errors": [],
"start_date": "2025-01-01"
}
]
}
Get leave type by id
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/:id
GET https://api.talenox.com/api/v2/leave_beta/types/150
Accept: application/json
Content-Type: application/json
Authorization: Bearer Q7cqlXQEYuu9B8cyd4AZfnm-0x_tUdfbXp5YFqUxARQ
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 150,
"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
GET https://api.talenox.com/api/v2/leave_beta/types
Accept: application/json
Content-Type: application/json
Authorization: Bearer Q7cqlXQEYuu9B8cyd4AZfnm-0x_tUdfbXp5YFqUxARQ
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": 150,
"name": "Annual Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 151,
"name": "Child Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 152,
"name": "Extended Child Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 153,
"name": "Maternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 154,
"name": "No Pay Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 155,
"name": "Paternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 156,
"name": "Shared Parental Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 157,
"name": "Sick Leave - Outpatient",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 158,
"name": "Sick Leave - Hospitalisation",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 159,
"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
GET https://api.talenox.com/api/v2/leave_beta/types?employee_id=1361&last_seen_id=151&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer Q7cqlXQEYuu9B8cyd4AZfnm-0x_tUdfbXp5YFqUxARQ
Parameters
employee_id: 1361
last_seen_id: 151
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": 152,
"name": "Extended Child Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 153,
"name": "Maternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 154,
"name": "No Pay Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 155,
"name": "Paternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 156,
"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
POST https://api.talenox.com/api/v2/metadata/get_items
Accept: application/json
Content-Type: application/json
Authorization: Bearer 842bf3fcab38942a426522fe628027e590ac7add
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": 397,
"name": "Jones, Fay and Von"
}
},
{
"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",
"Pre-Approved Letter of Consent",
"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",
"Kosovar",
"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": [
"CA Indosuez",
"DBS",
"HSBC",
"Standard Chartered",
"RHB",
"POSB",
"POSB Plus",
"OCBC",
"Maybank - Singapore Branch",
"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",
"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",
"Aspire FT Pte. Ltd.",
"Maybank - Singapore Limited",
"Bank of America",
"CIMB"
]
},
{
"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",
"MXN",
"NGN"
]
},
{
"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": [
"3%",
"5%",
"6%",
"7%",
"8%",
"9%",
"10%",
"11%",
"12%",
"13%",
"14%",
"15%"
]
},
{
"voluntary_employee_contribution_rate": [
"3%",
"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%",
"6%",
"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%",
"11%",
"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
POST https://api.talenox.com/api/v2/next_of_kins
Accept: application/json
Content-Type: application/json
Authorization: Bearer b7efbe1c87e03f9f0866c263c1bd780bdb7e1f45
Parameters
{
"employee_id": 1390,
"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 |
| contact_number | Contact Number |
| alternate_contact_number | Alternate Contact Number |
| birthdate | Birth Date |
| relationship required | Relationship |
| gender | Gender |
| citizenship | Citizenship |
| ssn | Identification Number |
| passport | Passport Number |
| marriage_date | Marriage Date |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 4,
"employee_id": 1390,
"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/:id
DELETE https://api.talenox.com/api/v2/next_of_kins/7
Accept: application/json
Content-Type: application/json
Authorization: Bearer eec1290a2da07b1fa2c4b2e74346ac7c991f7cda
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/:id
GET https://api.talenox.com/api/v2/next_of_kins/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0358b0333d9894c7fc238e454ce7b1e16db44bbf
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 5,
"employee_id": 1401,
"name": "Name",
"relationship": "Son",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2025-06-26",
"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/:id
PUT https://api.talenox.com/api/v2/next_of_kins/6
Accept: application/json
Content-Type: application/json
Authorization: Bearer d0c8f4cdba8dd0e5b6392937aa2bee466eeb8b47
Parameters
{
"next_of_kin": {
"name": "Change name"
}
}
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 6,
"employee_id": 1412,
"name": "Change name",
"relationship": "Son",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2025-06-26",
"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
POST https://api.talenox.com/api/v2/payroll/adhoc_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 82c512028f3f627474a1f942cd9351d64e935301
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": 1450,
"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
POST https://api.talenox.com/api/v2/payroll/attendance_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 14712f6bc4a763ffb8b8ef6867922500925c489c
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": 1451,
"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
POST https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9f9575caf4e90580082e66a9f187f68caea1c540
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": 1452,
"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
POST https://api.talenox.com/api/v2/payroll/payroll_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6af370f40d07cde70df7f0f5d067e4844d0ff09d
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
POST https://api.talenox.com/api/v2/payroll/recurring_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 77d002b5b5c75e88e2306d131387901455f3bb6d
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": 1449,
"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/:id
DELETE https://api.talenox.com/api/v2/payroll/adhoc_payment/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1c4c61c86c3ca596edc6f1c335cf705d7b78924b
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1443,
"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/:id
DELETE https://api.talenox.com/api/v2/payroll/attendance_payment/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer cba22985949fbb737c3ae17da988f63fcba4f6bc
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1444,
"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/:id
DELETE https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer 27d66619283dc52fcd446be5043e33622a9df4a9
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1445,
"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/:id
DELETE https://api.talenox.com/api/v2/payroll/payroll_payment/7
Accept: application/json
Content-Type: application/json
Authorization: Bearer c00e0c7bc253e506ee27f426671ca9b098e85c25
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/:id
DELETE https://api.talenox.com/api/v2/payroll/recurring_payment/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer e2c83ddc35919a26040817a31977d296749aecbd
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 5,
"employee_id": 1442,
"item_type": "Salary/Wages",
"remarks": null,
"amount": "1000.0",
"actual_no_of_working_days": 20,
"total_no_of_working_days": 20,
"rate_of_pay": "Monthly",
"currency": "SGD"
}
Export Payroll
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/export_payroll
POST https://api.talenox.com/api/v2/payroll/export_payroll
Accept: application/json
Content-Type: application/json
Authorization: Bearer ff3f88cee4ac13aa5b42171ed36a2c26f168ddba
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": 1453,
"employee_id": "K00001",
"name": "Basil Howell",
"job_title": null,
"department": null,
"country_code": "SG",
"currency_unit": "$",
"attendance_pay_items": [],
"recurring_pay_items": [
{
"id": 7,
"employee_id": 1453,
"currency_id": 1,
"currency_value": "sgd",
"item_type": "Salary/Wages",
"name": "Basic Pay",
"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,
"actual_no_of_working_days": 20
},
"custom_pay_item_id": 35582,
"is_statutory_prorated": false,
"statutory_prorated_amount": "1000.0",
"statutory_prorated_date": null,
"currency_rate": "1.0"
}
],
"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_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_other_pay_items_amount_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_cpf_in_lieu_owage_reverted": "0.0",
"total_cpf_in_lieu_awage_reverted": "0.0"
}
],
"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": 430,
"company_id": 430,
"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": "2025-06-26T15:07:44.192Z",
"updated_at": "2025-06-26T15:07:44.262Z",
"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",
"disable_pph21": false,
"enable_cpf_platform_worker_scheme": false,
"overall_report_group_pis_by_remark_enabled": true,
"enable_empf_submission": false,
"exclude_perkeso_relief_from_mtd": false,
"payslip_include_state_country_in_address": false,
"tax_ir56f_filing_reminder_email_notification": "enable_notification"
}
}
Get Payroll Payment
Request
Endpoint
GET https://api.talenox.com/api/v2/payroll/payroll_payment/:id
GET https://api.talenox.com/api/v2/payroll/payroll_payment/6
Accept: application/json
Content-Type: application/json
Authorization: Bearer 94831a39f1744a39e2a1a70ff28360ac0490d094
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": 1438,
"item_type": "Salary/Wages",
"remarks": null,
"amount": "1000.0",
"actual_no_of_working_days": 20,
"total_no_of_working_days": 20,
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"adhoc_pay_items": [
{
"id": 1,
"employee_id": 1438,
"item_type": "Allowance",
"remarks": "",
"amount": "1000.0",
"rate_of_pay": "0.0",
"currency": "SGD"
}
],
"attendance_pay_items": [
{
"id": 1,
"employee_id": 1438,
"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": 1438,
"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
POST https://api.talenox.com/api/v2/payroll/get_payslips_data
Accept: application/json
Content-Type: application/json
Authorization: Bearer 386af05e5740da1d21835b6a9579ea97c4d02457
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": 1456,
"employee_id": "K00001",
"name": "Freda Will",
"job_title": null,
"department": null,
"country_code": "SG",
"currency_unit": "$",
"attendance_pay_items": [],
"recurring_pay_items": [
{
"id": 10,
"employee_id": 1456,
"currency_id": 1,
"currency_value": "sgd",
"item_type": "Salary/Wages",
"name": "Basic Pay",
"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,
"actual_no_of_working_days": 20
},
"custom_pay_item_id": 35834,
"is_statutory_prorated": false,
"statutory_prorated_amount": "1000.0",
"statutory_prorated_date": null,
"currency_rate": "1.0"
}
],
"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_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_other_pay_items_amount_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_cpf_in_lieu_owage_reverted": "0.0",
"total_cpf_in_lieu_awage_reverted": "0.0"
}
],
"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": 433,
"company_id": 433,
"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": "2025-06-26T15:07:51.890Z",
"updated_at": "2025-06-26T15:07:51.989Z",
"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",
"disable_pph21": false,
"enable_cpf_platform_worker_scheme": false,
"overall_report_group_pis_by_remark_enabled": true,
"enable_empf_submission": false,
"exclude_perkeso_relief_from_mtd": false,
"payslip_include_state_country_in_address": false,
"tax_ir56f_filing_reminder_email_notification": "enable_notification"
}
}
Get Payslips PDF
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/get_payslips
POST https://api.talenox.com/api/v2/payroll/get_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer 49547d918bd091d459335ec7be33bdc36de557fc
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
1454
]
}
| 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
[
{
"1454": null
}
]
Get Payslips PDF with Employee Details
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/get_payslips
POST https://api.talenox.com/api/v2/payroll/get_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer 52d436facc997e3a3be7b4810dba047279bb34f5
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
1455
],
"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
[
{
"1455": {
"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
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 7a9068b0db0a732c7328e43146f82010ae008936
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/:id/process
POST https://api.talenox.com/api/v2/payroll/payroll_payment/8/process
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3fed08543f5ac75c8fb4b7abdc85651a8c8f4e11
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
POST https://api.talenox.com/api/v2/payroll/publish_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4228183148042f33d95b7906c2dcb74e20e583da
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
POST https://api.talenox.com/api/v2/payroll/pull_leave_applications
Accept: application/json
Content-Type: application/json
Authorization: Bearer 53fd744a80e1579c0c7db3b102a730b209f350a4
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/:id/draft
POST https://api.talenox.com/api/v2/payroll/payroll_payment/9/draft
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9d79d07ebc8782fb3a488782e341443f1ed62549
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
POST https://api.talenox.com/api/v2/payroll/unpublish_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer f0869b0476e486e402bf7845be67c0471b2504f8
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
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer 653499686e1010b2a388993fca1985e3439c1b73
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": 1446,
"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
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer cfc1d05309da5ebf650a92d721a7b58234dbce58
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": 1448,
"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
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2b5976d7d4c038c457596a81387bb5873fbf0e21
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": 1447,
"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
GET https://api.talenox.com/api/v2/user_info
Accept: application/json
Content-Type: application/json
Authorization: Bearer p4LVa4jrXOUfP092XZiSGydeWrLdpDrDgzRGbFdzYcA
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"company": {
"id": 455
},
"employee": {
"id": 1589,
"employee_id": "d4e5qqxddq"
}
}
Working Days
Create Working Day
Request
Endpoint
POST https://api.talenox.com/api/v2/working_days
POST https://api.talenox.com/api/v2/working_days
Accept: application/json
Content-Type: application/json
Authorization: Bearer a92452960535f22fa9a8e45df39d45a8e5fe8fbb
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": [
1723
]
}
}
| 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": 175,
"name": "New working day",
"employee_ids": [
1723
],
"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/:id
DELETE https://api.talenox.com/api/v2/working_days/187
Accept: application/json
Content-Type: application/json
Authorization: Bearer d9f314c185a516399a379d93ce98c6b4e3bf0f24
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/:id
GET https://api.talenox.com/api/v2/working_days/177
Accept: application/json
Content-Type: application/json
Authorization: Bearer ef7d984388cfa6df190e3f2144628a9ec3f2f51c
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 177,
"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
GET https://api.talenox.com/api/v2/working_days
Accept: application/json
Content-Type: application/json
Authorization: Bearer a623adbfce67c8257207ff38728d17f58c4fb9e6
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 172,
"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/:id
PUT https://api.talenox.com/api/v2/working_days/179
Accept: application/json
Content-Type: application/json
Authorization: Bearer c2f12f3c541981443c7bef0bd5ad86d7162f5a8f
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": 179,
"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
POST https://api.talenox.com/api/v2/working_hours
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0f5afafe55169ecb3c0459bf3fa888997de23814
Parameters
{
"working_hour": {
"name": "New Working Hour",
"company_default": false,
"hours_per_week": 44.0,
"employee_ids": [
1803
]
}
}
| 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": 178,
"name": "New Working Hour",
"employee_ids": [
1803
],
"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/:id
DELETE https://api.talenox.com/api/v2/working_hours/188
Accept: application/json
Content-Type: application/json
Authorization: Bearer c8c79cb7439c7b1ac7367655eda456602c3b0337
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/:id
GET https://api.talenox.com/api/v2/working_hours/180
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8c70106579976e8fe719e68c20edf1c69b049eaa
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 180,
"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
GET https://api.talenox.com/api/v2/working_hours
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3894aa778ff26029cb747cac406c90bb6bf861e5
Parameters
None known.
Response
content-type: application/json; charset=utf-8
200 OK
[
{
"id": 175,
"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/:id
PUT https://api.talenox.com/api/v2/working_hours/182
Accept: application/json
Content-Type: application/json
Authorization: Bearer 87624a8345ac4d2692350e4c1af1965a16d975d4
Parameters
{
"working_hour": {
"name": "Change name",
"hours_per_week": 40.0
}
}
None known.
Response
content-type: application/json; charset=utf-8
200 OK
{
"id": 182,
"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