Introduction
The Talenox API is organized around REST. The APIs are predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
Talenox API token
You can obtain the Talenox API token via the website https://app.talenox.com. Head over to the top right nav bar -> API setting.
Difference of V2 from V1
V1 authenticates requests by checking for API token in URL, V2 moved the token into Authorization request header.
Aside from authentication mechanism, V2 is functionally identical to V1. They are using the same underlying implementation.
OAuth 2.0
Introduction
Talenox supports using OAuth 2.0 to grant third-party systems to access Talenox resources. With OAuth 2.0 application, users are able to define their own permission for accessing the resources.
Where to find and create
Follow these steps to create OAuth 2.0 application for your company:
Log into Talenox https://app.talenox.com
At the top right nav > API Settings, there is a link to the OAuth 2.0 developer page
Create the OAuth 2.0 application by providing Application Name, Redirect URI, Origin URI (Optional) and Scopes
Usage
Direct the user to
https://app.talenox.com/oauth/authorize?client_id=<client ID>&redirect_uri=<redirect URI>&scope=<scope>&response_type=codeAfter the user login and authorize the access, it will be redirect back to the Redirect URI with the code
To obtain the Access Token, with the code from the previous step, make a POST request to
https://app.talenox.com/oauth/token?grant_type=authorization_code&code=<code>&client_id=<client ID>&client_secret=<client secret>&redirect_uri=<redirect URI>The Access Token is valid for 30 minutes. To refresh the Access Token, make a POST to
https://app.talenox.com/oauth/token?grant_type=refresh_token&code=<access code>&refresh_token=<refresh token>&client_id=<client ID>&client_secret=<client secret>&redirect_uri=<redirect URI>
Branches
Create Branch
Request
Endpoint
POST https://api.talenox.com/api/v2/branches
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8a2ea4397ea3538dc08297f6a6fb4c217533e10f
POST https://api.talenox.com/api/v2/branches
Parameters
{
"branch": {
"name": "Sample Branch",
"address": "49167 Franecki Lights",
"postcode": "31337-5788",
"head_id": 504,
"employee_ids": [
510,
511,
504,
505
]
}
}
| Name | Description |
|---|---|
| name required | Name of Branch |
| address | Address |
| postcode | Postcode |
| head_id | Branch Head (Should be an Employee ID) |
| employee_ids | Employee IDs (If specified, will override the existing employees in the branch). |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 553,
"name": "Sample Branch",
"employee_ids": [
510,
511,
504,
505
],
"no_of_employees": 4,
"address": "49167 Franecki Lights",
"postcode": "31337-5788",
"head_id": 504
}
Delete Branch
Request
Endpoint
DELETE https://api.talenox.com/api/v2/branches/598
Accept: application/json
Content-Type: application/json
Authorization: Bearer d845e8df6adec23c24ac63577bd97b09df7b2c6c
DELETE https://api.talenox.com/api/v2/branches/:id
Parameters
| Name | Description |
|---|---|
| id required | Branch ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted branch 598"
}
List Branches
Request
Endpoint
GET https://api.talenox.com/api/v2/branches
Accept: application/json
Content-Type: application/json
Authorization: Bearer ff98c2f2e8e68154f46232d88940a66c5d2f1ce0
GET https://api.talenox.com/api/v2/branches
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 536,
"name": "Prosaccoborough",
"employee_ids": [],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 523,
"name": "Default",
"employee_ids": [],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 524,
"name": "Loraton",
"employee_ids": [
491
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 525,
"name": "Rogahnville",
"employee_ids": [
492
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 526,
"name": "South Delfinaberg",
"employee_ids": [
493
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 527,
"name": "Torieton",
"employee_ids": [
494
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 528,
"name": "East Delicia",
"employee_ids": [
495
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 529,
"name": "Port Zachery",
"employee_ids": [
496
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 530,
"name": "Port Estaborough",
"employee_ids": [
497
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 531,
"name": "East Altonshire",
"employee_ids": [
498
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 532,
"name": "Luettgenburgh",
"employee_ids": [
499
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 533,
"name": "Rooseveltfurt",
"employee_ids": [
500
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 534,
"name": "Paucekville",
"employee_ids": [
501
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 537,
"name": "27868 Karyn Harbor",
"employee_ids": [
502,
503
],
"no_of_employees": 2,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 535,
"name": "Shizuemouth",
"employee_ids": [],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
}
]
Show Branch
Request
Endpoint
GET https://api.talenox.com/api/v2/branches/568
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1e3d92b2319c719bc805af4c18b937dcff0aca7f
GET https://api.talenox.com/api/v2/branches/:id
Parameters
| Name | Description |
|---|---|
| id required | Branch ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 568,
"name": "4690 Devora Plains",
"employee_ids": [
528,
529
],
"no_of_employees": 2,
"address": null,
"postcode": null,
"head_id": null
}
Update Branch
Request
Endpoint
PUT https://api.talenox.com/api/v2/branches/583
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8fff43078455f5c709353b4b42271ab901bd6848
PUT https://api.talenox.com/api/v2/branches/:id
Parameters
{
"branch": {
"name": "New Branch Name",
"employee_ids": [
536,
537,
530,
531
]
}
}
| Name | Description |
|---|---|
| id required | Branch ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 583,
"name": "New Branch Name",
"employee_ids": [
536,
537,
530,
531
],
"no_of_employees": 4,
"address": null,
"postcode": null,
"head_id": null
}
Company Holidays
Manage holidays in a company, including calendar holidays and custom created ones.
Create Company Custom Holiday
Request
Endpoint
POST https://api.talenox.com/api/v2/company_holidays
Accept: application/json
Content-Type: application/json
Authorization: Bearer 11874aed7fdd6102af117dfabe9280af09c8dd3f
POST https://api.talenox.com/api/v2/company_holidays
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-05-06T10:00:47.085Z",
"updated_at": "2025-05-06T10:00:47.085Z"
}
Delete Company Calendar Holiday
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer f44dd644ad07fb8c95608a94cbf6d4b0e5f3546b
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/:id
Parameters
{
"calendar_holiday": {
"hide": true
}
}
| Name | Description |
|---|---|
| hide required | Set to true to hide the calendar holiday for company, false otherwise |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully hidden calendar holiday for company"
}
Delete Company Custom Holiday
Request
Endpoint
DELETE https://api.talenox.com/api/v2/company_holidays/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4efa6367b1d12bce522207baf02bdb979d2ee3db
DELETE https://api.talenox.com/api/v2/company_holidays/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Deleted holiday Office Closure"
}
Get Company Custom Holiday
Request
Endpoint
GET https://api.talenox.com/api/v2/company_holidays/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer cc394334b2620d645e407af90e1b2072f0d12a15
GET https://api.talenox.com/api/v2/company_holidays/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"company_id": 123,
"calendar_holiday_id": null,
"name": "Office Closure",
"start_at": "2025-12-30",
"end_at": "2025-12-31",
"hide": false,
"created_at": "2025-05-06T10:00:53.563Z",
"updated_at": "2025-05-06T10:00:53.563Z"
}
List Company Holidays including Custom and Calendar Holidays
Request
Endpoint
GET https://api.talenox.com/api/v2/company_holidays
Accept: application/json
Content-Type: application/json
Authorization: Bearer ed21f93f4ea224a7fdf20b4b300aed631fb5fd19
GET https://api.talenox.com/api/v2/company_holidays
Parameters
| Name | Description |
|---|---|
| year | Year for filtering, defaults to current year |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"country_id": 2,
"name": "Calendar Holiday",
"created_at": "2025-05-06T10:00:47.132Z",
"updated_at": "2025-05-06T10:00:47.132Z",
"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-05-06T10:00:50.365Z",
"updated_at": "2025-05-06T10:00:50.365Z",
"type": "CustomHoliday",
"custom_holiday_duration": null
}
]
List Hidden Company Calendar Holidays
Request
Endpoint
GET https://api.talenox.com/api/v2/company_holidays/deleted_calendar_holidays
Accept: application/json
Content-Type: application/json
Authorization: Bearer e4ac1f1efa7caf7ce31de5da11f4d6a89205259a
GET https://api.talenox.com/api/v2/company_holidays/deleted_calendar_holidays
Parameters
| Name | Description |
|---|---|
| year | Year for filtering, defaults to current year |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 14,
"country_id": 2,
"name": "Calendar Holiday",
"created_at": "2025-05-06T10:01:13.236Z",
"updated_at": "2025-05-06T10:01:13.236Z",
"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/11
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0a47d30919da75a832a20f3cae78406be6571f57
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/:id
Parameters
{
"calendar_holiday": {
"hide": false
}
}
| Name | Description |
|---|---|
| hide required | Set to true to hide the calendar holiday for company, false otherwise |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully restored calendar holiday for company"
}
Update Company Custom Holiday
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_holidays/4
Accept: application/json
Content-Type: application/json
Authorization: Bearer cb9f8fd660f68e11afcfc7b9d13bc528d6879166
PUT https://api.talenox.com/api/v2/company_holidays/:id
Parameters
{
"custom_holiday": {
"name": "Change name"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"company_id": 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-05-06T10:00:56.835Z",
"updated_at": "2025-05-06T10:00:57.020Z"
}
Company Settings
List Company Settings
Request
Endpoint
GET https://api.talenox.com/api/v2/company_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6747b430b286be8654d564ea7c3f3a6b491cd055
GET https://api.talenox.com/api/v2/company_settings
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"api_allows_employee_multiple_cost_centres": false
}
Update Company Settings
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer dea9c1638f19de41188c52b4d1fe82ee2ab45c43
PUT https://api.talenox.com/api/v2/company_settings
Parameters
{
"company_settings": {
"api_allows_employee_multiple_cost_centres": true
}
}
| Name | Description |
|---|---|
| api_allows_employee_multiple_cost_centres | Set this to true for cost centres endpoint to accept multiple cost centres for any employee. (This is to avoid breaking previous API implementation) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"api_allows_employee_multiple_cost_centres": true
}
Cost Centres
Create Cost Centre
Request
Endpoint
POST https://api.talenox.com/api/v2/cost_centres
Accept: application/json
Content-Type: application/json
Authorization: Bearer 895ff3dc2bd2e17a100500b7020b1d3e11efdb56
POST https://api.talenox.com/api/v2/cost_centres
Parameters
{
"cost_centre": {
"name": "Business",
"employee_ids": [
"w3n6pvowxe",
"v4dc3b9gcc",
"g3recy3tu6",
"jdgx0kaxsz"
],
"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": [
639,
640,
641,
642
],
"no_of_employees": 4,
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456789",
"enable_custom_mpf_employer_no": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null
}
Delete Cost Centre
Request
Endpoint
DELETE https://api.talenox.com/api/v2/cost_centres/11
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1a31ad0d435e30243ee5b9c1ae145802681b1249
DELETE https://api.talenox.com/api/v2/cost_centres/:id
Parameters
| Name | Description |
|---|---|
| id required | Cost Centre ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted cost centre Conn Stravenue"
}
List Cost Centre
Request
Endpoint
GET https://api.talenox.com/api/v2/cost_centres
Accept: application/json
Content-Type: application/json
Authorization: Bearer f628e74c50bea86d7c73f5d7634a95dc9cf226ab
GET https://api.talenox.com/api/v2/cost_centres
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 1,
"name": "Carroll Knoll",
"employee_ids": [],
"no_of_employees": 0,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null,
"enable_custom_mpf_employer_no": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null
}
]
Update Cost Centre
Request
Endpoint
PUT https://api.talenox.com/api/v2/cost_centres/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer a39d1e7b913d8a8dbe10692efee78bb19e3be509
PUT https://api.talenox.com/api/v2/cost_centres/:id
Parameters
{
"cost_centre": {
"name": "Engineer",
"employee_ids": [
"7x9odd8l8z",
"0mn6a7m3qf",
"zs69ekrmgo",
"xuvq8d5ipl"
],
"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": [
674,
675,
676,
670
],
"no_of_employees": 4,
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456788",
"enable_custom_mpf_employer_no": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null
}
Custom Pay Items
Create Custom Pay Item
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/custom_pay_items
Accept: application/json
Content-Type: application/json
Authorization: Bearer bac343e84695a3b0e1d0aac964ad61463db44122
POST https://api.talenox.com/api/v2/payroll/custom_pay_items
Parameters
{
"custom_pay_item": {
"proration_enabled": false,
"category": "Recurring",
"item_type": "Salary/Wages",
"gross_net_settings": "gross",
"tax": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"overtime_rate": 1.5,
"additional_sg_info_attributes": {
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info_attributes": {
"mpf": true,
"adw": true
},
"additional_my_info_attributes": {
"epf": true,
"socso": true,
"eis": true,
"hrdf": true
},
"additional_id_info_attributes": {
"bpjs": true,
"thr": true
}
}
}
| Name | Description |
|---|---|
| proration_enabled | Proration Enabled |
| categoary | Category (["Recurring", "Adhoc", "Attendance", "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": 30625,
"item_type": "Salary/Wages",
"name": null,
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ba81f630-ee10-41b2-88bb-e8f8c48bda84",
"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": 29323,
"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/30963
Accept: application/json
Content-Type: application/json
Authorization: Bearer 607b286af224481a66b5c77d64e2c8175f667e74
DELETE https://api.talenox.com/api/v2/payroll/custom_pay_items/:id
Parameters
| Name | Description |
|---|---|
| id required | Custom Pay Item ID |
Response
Content-Type: text/plain; charset=utf-8
200 OK
Get Custom Pay Item
Request
Endpoint
GET https://api.talenox.com/api/v2/payroll/custom_pay_items/30710
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3e0bebac8070b49ca3927b3f70549acfa2bcdfb3
GET https://api.talenox.com/api/v2/payroll/custom_pay_items/:id
Parameters
| Name | Description |
|---|---|
| id required | Custom Pay Item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 30710,
"item_type": "Salary/Wages",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "24f76158-362b-40da-a05a-263dc63ab249",
"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": 29408,
"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
Accept: application/json
Content-Type: application/json
Authorization: Bearer 50eaa0996187b79ce739c1b90371621e6ad84953
GET https://api.talenox.com/api/v2/payroll/custom_pay_items
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 30626,
"item_type": "Salary/Wages",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "fc89baf0-2895-477b-8aaa-d814daedc44d",
"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": 29324,
"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": 30627,
"item_type": "Salary/Wages",
"name": "Basic Pay(without proration)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "91a59dc6-ae6d-4091-aed7-98b78c82893c",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 29325,
"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": 30628,
"item_type": "Allowance",
"name": "Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "6a4de4ba-fb7c-44f8-be1a-79a865faa0c8",
"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": 29326,
"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": 30629,
"item_type": "Allowance",
"name": "Allowance(without proration)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ed7ac426-f530-4006-be80-484f17e8cc13",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 29327,
"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": 30630,
"item_type": "Deduction",
"name": "Deduction",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "662924e6-f8e3-4c1d-9619-845ed46437df",
"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": 29328,
"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": 30631,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "f736c88f-c015-4b17-90d5-44b275d4012c",
"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": 29329,
"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": 30632,
"item_type": "IR21 Tax Withholding",
"name": "IR21 Tax Withholding",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "4f5fecac-c677-4720-a615-beaf88b0a4fc",
"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": 29330,
"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": 30633,
"item_type": "Commission",
"name": "Commission (Daily/Weekly/Monthly)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "aadb3d8b-19ef-4338-8c9e-050c9fc4b403",
"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": 29331,
"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": 30634,
"item_type": "Extra Duty Allowance",
"name": "Extra Duty Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "25d7d590-6c95-4d5f-a796-f125e3f524a0",
"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": 29332,
"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": 30635,
"item_type": "Housing/Rental Allowance",
"name": "Housing/ Rental Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ffed6e61-8fcd-4f86-8455-090d4d89d571",
"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": 29333,
"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": 30636,
"item_type": "Incentive Allowance",
"name": "Incentive Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "7b42d115-b366-4ab0-aab5-73a9d50f41ae",
"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": 29334,
"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": 30637,
"item_type": "Meal Allowance",
"name": "Meal Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d7011c33-abf5-4cbb-b60d-a2ec762083fd",
"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": 29335,
"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": 30638,
"item_type": "Per Diem Allowance",
"name": "Per Diem Allowance",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "af7c126d-7c86-4ae9-a6ce-911ea08004ac",
"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": 29336,
"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": 30639,
"item_type": "Transport Allowance",
"name": "Transport Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "36db44bc-8767-4e9a-9e7f-7c52c08665de",
"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": 29337,
"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": 30640,
"item_type": "Tips",
"name": "Tips",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "80f411e5-2d16-4446-850e-b30645279f07",
"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": 29338,
"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": 30641,
"item_type": "Director fees",
"name": "Director fees",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "291b42ab-2629-4cab-b7ae-d6fd010cbcf7",
"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": 29339,
"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": 30642,
"item_type": "Bonus",
"name": "Bonus",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "bd8b5d75-2e0f-4d4f-a656-4af55eef0cac",
"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": 29340,
"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": 30643,
"item_type": "Others",
"name": "Others",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a20bb802-3510-4dfd-ad22-2cd0b5901d34",
"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": 29341,
"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": 30644,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)(no SHG contribution)",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "9896e926-dbb5-44ac-addb-af82da8fc3e7",
"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": 29342,
"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": 30645,
"item_type": "Commission",
"name": "Commission (AW)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d33b2cdb-a754-4e06-a47d-2aaaa892cc91",
"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": 29343,
"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": 30646,
"item_type": "Medisave",
"name": "Medisave",
"category": "Recurring",
"tax": true,
"gross_net_settings": "na",
"proration_enabled": false,
"slug": "d44dfd3e-8baa-4167-aec8-170e2845cedc",
"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": 29344,
"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": 30647,
"item_type": "Deduction Community Chest",
"name": "Deduction Community Chest",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "fd87780f-12ed-480e-84b2-eaf10fa9c4dc",
"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": 29345,
"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": 30648,
"item_type": "Reimbursements",
"name": "Reimbursements",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "44cdb96b-fc6c-431e-837c-e1b7c387da49",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"triggered_custom_pay_item_ids": [],
"formula_expression_id": null,
"additional_sg_info": {
"id": 29346,
"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": 30649,
"item_type": "Advance Pay",
"name": "Advance Pay",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "1c4d65b1-d64a-4792-94ad-b5e242ef9046",
"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": 29347,
"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": 30650,
"item_type": "Allowance",
"name": "Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "205762ee-3ea0-424e-b1c7-fd60ed581968",
"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": 29348,
"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": 30651,
"item_type": "Deduction",
"name": "Deduction",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "51b7d50b-e3e2-45cd-87b2-8ae3a2889e4b",
"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": 29349,
"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": 30652,
"item_type": "Commission",
"name": "Commission (Irregular)",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "0f6a5e0c-7700-4d2c-b711-dd085410673f",
"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": 29350,
"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": 30653,
"item_type": "Extra Duty Allowance",
"name": "Extra Duty Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a4656ecf-d464-4f47-b508-6674c20e525b",
"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": 29351,
"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": 30654,
"item_type": "Festive Allowance",
"name": "Festive Allowance",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "a3383189-c812-4553-9175-e35edac67710",
"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": 29352,
"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": 30655,
"item_type": "Housing/Rental Allowance",
"name": "Housing/ Rental Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "769e8f35-cab8-443f-9751-096d6ca780d6",
"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": 29353,
"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": 30656,
"item_type": "Incentive",
"name": "Incentive",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "897760ae-2427-4a3b-ae59-e51952ae0c7a",
"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": 29354,
"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": 30657,
"item_type": "Incentive Allowance",
"name": "Incentive Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "874ec37d-2b48-4b0c-b69e-b899008808f0",
"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": 29355,
"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": 30658,
"item_type": "IR21 Tax Withholding",
"name": "IR21 Tax Withholding",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "af249591-e1e8-4a78-9bc5-8ea20488c4a1",
"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": 29356,
"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": 30659,
"item_type": "Meal Allowance",
"name": "Meal Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ec4b7899-64c1-4bf2-9a50-97699d9e4218",
"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": 29357,
"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": 30660,
"item_type": "Per Diem Allowance",
"name": "Per Diem Allowance",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1bac9a4d-6f61-4fb4-9347-41ba8394fcbc",
"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": 29358,
"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": 30661,
"item_type": "Reimbursements",
"name": "Per Diem Reimbursement",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "2cf81a52-94e9-4a24-bd63-4dc7b9ca993f",
"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": 29359,
"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": 30662,
"item_type": "Transport Allowance",
"name": "Transport Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "0365d9e3-9dc4-4bd3-b370-cf20485861e7",
"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": 29360,
"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": 30663,
"item_type": "Referral of Employees Fees",
"name": "Referral of Employees Fees",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "fc426616-bd17-4864-b860-c5372046cc0e",
"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": 29361,
"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": 30664,
"item_type": "Benefits in Kind",
"name": "Benefits in Kind",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "9e8f6fb3-a882-49a6-9a5f-49d2dab066cd",
"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": 29362,
"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": 30665,
"item_type": "Benefits in Kind",
"name": "Gifts in Kind",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "78a7980f-161d-4e8b-99bb-e45e13b4e88f",
"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": 29363,
"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": 30666,
"item_type": "Stock Option Sale",
"name": "Share Option Sale",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8182dc89-20a4-4440-9602-895f5ccc5072",
"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": 29364,
"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": 30667,
"item_type": "Termination Benefits",
"name": "Termination Benefits",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "a65841de-2ef9-4bc9-a48c-55eff8490854",
"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": 29365,
"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": 30668,
"item_type": "Tips",
"name": "Tips",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d192b802-a691-414f-a41f-d6d4c51e0ce8",
"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": 29366,
"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": 30669,
"item_type": "Annual Wage Supplement",
"name": "Annual Wage Supplement",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "dbad5e5f-c3f9-4181-823a-997feb13a6e9",
"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": 29367,
"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": 30670,
"item_type": "Bonus",
"name": "Bonus",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1fb334c1-f64b-47ec-ab84-668c9cb7eb8f",
"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": 29368,
"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": 30671,
"item_type": "Bonus",
"name": "Prior Year Bonus",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "091650a1-b19f-415f-813d-fc0f2ea24f8e",
"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": 29369,
"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": 30672,
"item_type": "Annual Wage Supplement",
"name": "Prior Year AWS",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "10c936d2-d56a-4093-9cde-69685a4328b4",
"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": 29370,
"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": 30673,
"item_type": "Leave Pay",
"name": "Leave Pay",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "273ccbe9-af65-40c7-bed9-84a5511467d8",
"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": 29371,
"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": 30674,
"item_type": "Director fees",
"name": "Director fees",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "c650f505-9777-4b53-8973-814a0eb4158a",
"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": 29372,
"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": 30675,
"item_type": "Backdated Salary",
"name": "Backdated Salary Increment",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f4d4f38e-e1bb-4acb-ab00-6a3b5625bd49",
"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": 29373,
"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": 30676,
"item_type": "Backdated Salary",
"name": "Backdated Salary",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "cf4203d9-6446-4101-9018-fef5608c41bf",
"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": 29374,
"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": 30677,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "bb65cd22-4451-4c1a-a416-fcd8760d155a",
"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": 29375,
"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": 30678,
"item_type": "Others",
"name": "Others",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f5aac050-9a49-4622-a4e1-8e8c7225674f",
"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": 29376,
"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": 30679,
"item_type": "Others",
"name": "Others(no gross)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "736c6ce5-bc3b-4205-8a48-fb0585c0e2a6",
"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": 29377,
"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": 30680,
"item_type": "Salary in Lieu",
"name": "Salary in lieu",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "03a24d14-067f-49ae-83f5-ca4e0dc35b0d",
"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": 29378,
"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": 30681,
"item_type": "Incentive",
"name": "Onboarding incentive",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "818d6e45-9876-425a-ab06-032daa5142d9",
"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": 29379,
"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": 30682,
"item_type": "Gratuity",
"name": "Gratuity paid for years of service",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "fe78c84a-d70b-4548-8011-513bb73d347e",
"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": 29380,
"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": 30683,
"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": "31b8899f-9915-4c3b-8fcc-5ac1c639e62f",
"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": 29381,
"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": 30684,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)(no SHG contribution)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "12964c59-d6ea-47b7-9811-395806e26c89",
"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": 29382,
"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": 30685,
"item_type": "Deduction",
"name": "NS Leave Claims Deduction",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "f48d32ac-3b6f-4d5d-a463-b211814fea64",
"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": 29383,
"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": 30686,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Personal Insurance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "9ff45f42-35cd-4695-bf61-8177c607304d",
"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": 29384,
"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": 30687,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Optical Expenses",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "35bbf43e-be4a-4ce9-956d-ca002aa438c1",
"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": 29385,
"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": 30688,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Health Screening & Vaccinations",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b4ef0af2-cf5f-4f83-a585-0c0e031ca338",
"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": 29386,
"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": 30689,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Childcare / Eldercare Fees For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "5935ea4a-8e54-4c61-84e5-05ff40692365",
"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": 29387,
"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": 30690,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Medical Expenses For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8039503a-de2a-4b83-8f7d-6e5a36771bf3",
"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": 29388,
"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": 30691,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Dental Expenses For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "495903f8-9507-4b64-a597-52d27b7fab43",
"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": 29389,
"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": 30692,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Gym Membership",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "25eefffa-77d9-4fcb-a188-a6cccde97665",
"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": 29390,
"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": 30693,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Holiday Expenses",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "637ebb90-39a4-43b6-a487-54889ef8fbea",
"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": 29391,
"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": 30694,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit TCM / CHIRO/ PHYSIO",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "555f1aa1-53cc-437c-a1cf-db0b9a6d4c80",
"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": 29392,
"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": 30695,
"item_type": "Gratuity",
"name": "Gratuity",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "fa54447f-452b-4aea-8b0b-5f04fde674b7",
"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": 29393,
"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": 30696,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Work From Home",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "90f73be4-2a1f-4d81-a303-b24b80af4884",
"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": 29394,
"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": 30697,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Mental Health Awareness",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f1d0d2b1-df0e-46d4-8a9f-c0220c5c5a38",
"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": 29395,
"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": 30698,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Personal Planning & Enrichment",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "5a8da58b-4240-4f3d-a292-420419ac7780",
"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": 29396,
"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": 30699,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Home Affairs Support",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "cfcfb834-6a49-425e-8c35-63f9676324ad",
"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": 29397,
"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": 30700,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Home Family Bonding Facilitation",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f8989c0e-40de-443c-a9a2-2b9e4648dea3",
"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": 29398,
"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": 30701,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Professional Subscription",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "32d368bb-0996-4f93-8126-d3ec4b613cdd",
"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": 29399,
"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": 30702,
"item_type": "Regular Hours",
"name": "Regular Hours",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1ac98f7e-a4f2-4fb8-971c-915295230c55",
"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": 29400,
"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": 30703,
"item_type": "Overtime Hours",
"name": "Overtime Hours",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "9ab51df8-1025-498e-8aec-1c7beb49123a",
"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": 29401,
"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": 30704,
"item_type": "Regular Days",
"name": "Regular Days",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "5e906cd8-e822-4eb5-bbf8-3ea1acc53c5b",
"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": 29402,
"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": 30705,
"item_type": "Overtime Days",
"name": "Overtime Days",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "195424f2-d9b5-4a0c-a44c-619dccf18cf4",
"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": 29403,
"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": 30706,
"item_type": "Public Holiday Pay",
"name": "Public Holiday Pay",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "65b2d28b-cb54-432b-a643-2a4c988e048e",
"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": 29404,
"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": 30707,
"item_type": "Rest Day Pay",
"name": "Rest Day Pay",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "330dcd74-c4bf-43e0-b133-dd8cf26cf5af",
"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": 29405,
"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": 30708,
"item_type": "Deputy",
"name": "Deputy Awage",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "40779cc6-02de-445f-ba94-226e303b6aa0",
"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": 29406,
"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": 30709,
"item_type": "Deputy",
"name": "Deputy",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "9efdf6fe-e7fe-4cae-a134-260f01626012",
"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": 29407,
"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/30794
Accept: application/json
Content-Type: application/json
Authorization: Bearer 910fdbd977e1db370c9eed0ab0dcaae0787fa238
PATCH https://api.talenox.com/api/v2/payroll/custom_pay_items/:id
Parameters
{
"custom_pay_item": {
"proration_enabled": false,
"category": "Recurring",
"item_type": "Allowance",
"gross_net_settings": "gross",
"tax": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"overtime_rate": 1.5,
"additional_sg_info_attributes": {
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info_attributes": {
"mpf": true,
"adw": true
},
"additional_my_info_attributes": {
"epf": true,
"socso": true,
"eis": true,
"hrdf": true
},
"additional_id_info_attributes": {
"bpjs": true,
"thr": true
}
}
}
| Name | Description |
|---|---|
| id required | Custom Pay Item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 30794,
"item_type": "Allowance",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1c090bec-7238-4bad-afd7-300e8e7aa1cb",
"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": 29576,
"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
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0c9978fba51b8ee12a0e97fbf3ab5984ad06f5b5
POST https://api.talenox.com/api/v2/roles
Parameters
{
"role": {
"name": "Manager",
"employee_ids": [
1120,
1121,
1122,
1119
]
}
}
| 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": 1117,
"name": "Manager",
"employee_ids": [
1120,
1121,
1122,
1119
],
"no_of_employees": 4
}
Delete Role
Request
Endpoint
DELETE https://api.talenox.com/api/v2/roles/1159
Accept: application/json
Content-Type: application/json
Authorization: Bearer c57f57577c630c17a992ad2f2f0de3af1dcdae2f
DELETE https://api.talenox.com/api/v2/roles/:id
Parameters
| Name | Description |
|---|---|
| id required | Role ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted role 1159"
}
List Roles
Request
Endpoint
GET https://api.talenox.com/api/v2/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer e6ed48ec0bd0a9b423e3a23a48d9fcb26895fecc
GET https://api.talenox.com/api/v2/roles
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 1089,
"name": "lecturer",
"employee_ids": [
1106
],
"no_of_employees": 1
},
{
"id": 1090,
"name": "editor",
"employee_ids": [
1107
],
"no_of_employees": 1
},
{
"id": 1091,
"name": "waiter",
"employee_ids": [
1108
],
"no_of_employees": 1
},
{
"id": 1092,
"name": "coach",
"employee_ids": [
1109
],
"no_of_employees": 1
},
{
"id": 1093,
"name": "secretary",
"employee_ids": [
1110
],
"no_of_employees": 1
},
{
"id": 1094,
"name": "artist",
"employee_ids": [
1111
],
"no_of_employees": 1
},
{
"id": 1095,
"name": "barber",
"employee_ids": [
1112
],
"no_of_employees": 1
},
{
"id": 1096,
"name": "banker",
"employee_ids": [
1113
],
"no_of_employees": 1
},
{
"id": 1097,
"name": "developer",
"employee_ids": [
1114
],
"no_of_employees": 1
},
{
"id": 1098,
"name": "tailor",
"employee_ids": [
1115
],
"no_of_employees": 1
},
{
"id": 1099,
"name": "writer",
"employee_ids": [
1116
],
"no_of_employees": 1
},
{
"id": 1100,
"name": "yzsxbsoipmtescdauqigohpaijzyrmwm",
"employee_ids": [],
"no_of_employees": 0
},
{
"id": 1101,
"name": "uogoovszrsveldgqnziodeeurcdllvit",
"employee_ids": [],
"no_of_employees": 0
},
{
"id": 1102,
"name": "Engineer",
"employee_ids": [
1117,
1118
],
"no_of_employees": 2
}
]
Show Role
Request
Endpoint
GET https://api.talenox.com/api/v2/roles/1131
Accept: application/json
Content-Type: application/json
Authorization: Bearer 04a5a0e30f3ad1ed2f9e872db02ecf1d00cd6067
GET https://api.talenox.com/api/v2/roles/:id
Parameters
| Name | Description |
|---|---|
| id required | Role ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1131,
"name": "Engineer",
"employee_ids": [
1143,
1144
],
"no_of_employees": 2
}
Update Role
Request
Endpoint
PUT https://api.talenox.com/api/v2/roles/1145
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1f690abd1107950950d957e371a6009a57615731
PUT https://api.talenox.com/api/v2/roles/:id
Parameters
{
"role": {
"name": "New Role Name",
"employee_ids": [
1145,
1146,
1147,
1148
]
}
}
| Name | Description |
|---|---|
| id required | Role ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1145,
"name": "New Role Name",
"employee_ids": [
1145,
1146,
1147,
1148
],
"no_of_employees": 4
}
Employees
Create HK Employee
Request
Endpoint
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer e9d19eb422138aab54f0b113137b74083157b3b9
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "Hong Kong Permanent Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": "",
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"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-a5f513fa",
"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
Accept: application/json
Content-Type: application/json
Authorization: Bearer f9d0baa8b57a5fed23f1367d83b22edb03664dc5
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "KTP (Residential Identity Card)",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": "",
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"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-4f5de8a7",
"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
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8187feb9512033503b49535a17e2427effd58894
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Married and Spouse Not Working",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": "",
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"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-dde7e969",
"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
Accept: application/json
Content-Type: application/json
Authorization: Bearer 04c47e5a62f386303a36b1d4d0e3125fa5611000
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "S Pass",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": 12,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"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-a50603bf",
"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": "Lawrence Circles",
"employee_ids": [
802
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null,
"enable_custom_mpf_employer_no": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null
},
{
"id": 13,
"name": "Bechtelar Circles",
"employee_ids": [
802
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null,
"enable_custom_mpf_employer_no": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": null
}
],
"default_cost_centre": {
"id": 12,
"name": "Lawrence Circles",
"employee_ids": [
802
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null,
"enable_custom_mpf_employer_no": false,
"custom_mpf_employer_no": null,
"mpf_provider_id": 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/817
Accept: application/json
Content-Type: application/json
Authorization: Bearer 27d0557710db5eabc4b96839c9973c5f193956af
DELETE https://api.talenox.com/api/v2/employees/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted employee 00001"
}
Get Employee
Request
Endpoint
GET https://api.talenox.com/api/v2/employees/812
Accept: application/json
Content-Type: application/json
Authorization: Bearer 390ceb1884208796f53e8d9cb91f8f16f645f6b1
GET https://api.talenox.com/api/v2/employees/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 812,
"employee_id": "00001",
"first_name": "Lashaunda",
"middle_name": null,
"last_name": "Wilkinson",
"identification_full_name": null,
"email": "beatrice_cassin@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2024-03-13",
"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": "1985-05-06",
"slug": "lashaunda-wilkinson-e2dc5d97",
"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": "Lashaunda Wilkinson",
"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-05-06",
"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-13",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
}
List All Employees
Request
Endpoint
GET https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer c7647da26e96a3ad714ad05f9e9727da83264277
GET https://api.talenox.com/api/v2/employees
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 806,
"employee_id": "00001",
"first_name": "Abigail",
"middle_name": null,
"last_name": "Huels",
"identification_full_name": null,
"email": "suzanne@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2023-06-22",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "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": "1990-05-06",
"slug": "abigail-huels-9dbecf84",
"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": "22/06/2023",
"end_date": null,
"remarks": null,
"amount": "1632.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 51,
"title": "Title1",
"department": null,
"start_date": "22/06/2023",
"end_date": null,
"remarks": null,
"amount": "1632.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": "Abigail Huels",
"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-05-06",
"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-06-22",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
},
{
"id": 807,
"employee_id": "00002",
"first_name": "Era",
"middle_name": null,
"last_name": "Nolan",
"identification_full_name": null,
"email": "ray@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2024-01-13",
"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": "1997-05-06",
"slug": "era-nolan-17adff4b",
"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": "Era Nolan",
"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-05-06",
"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-01-13",
"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": "Marta",
"middle_name": null,
"last_name": "Kuphal",
"identification_full_name": null,
"email": "kala_rowe@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2024-06-22",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "Female",
"marital_status": null,
"passport_number": null,
"passport_date_of_issue": null,
"passport_date_of_expiry": null,
"passport_place_of_issue": null,
"chinese_name": null,
"nickname": null,
"birthdate": "1993-05-06",
"slug": "marta-kuphal-dd842e3c",
"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": "Marta Kuphal",
"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-05-06",
"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-06-22",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
}
]
Update Employee
Request
Endpoint
PUT https://api.talenox.com/api/v2/employees/814
Accept: application/json
Content-Type: application/json
Authorization: Bearer 363b16be89c1ac756f177419c5909cd79649d9fb
PUT https://api.talenox.com/api/v2/employees/:id
Parameters
{
"employee": {
"first_name": "Mary",
"last_name": "Lan"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 814,
"employee_id": "00001",
"first_name": "Mary",
"middle_name": null,
"last_name": "Lan",
"identification_full_name": null,
"email": "mariana@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2022-11-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": "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": "2004-05-06",
"slug": "mary-lan-c244d987",
"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": "Jarred Pouros",
"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-05-06",
"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-11-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
}
}
Jobs
Create Job
Request
Endpoint
POST https://api.talenox.com/api/v2/jobs
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5a2f7f3c0d3b9507f967dee61dbc0d086fee9975
POST https://api.talenox.com/api/v2/jobs
Parameters
{
"title": "",
"employee_id": 850,
"job": {
"title": "Testing job",
"department": "Testing Department",
"start_date": "03/05/2019",
"end_date": "31/05/2020",
"currency": "SGD",
"amount": 1000,
"rate_of_pay": "Monthly",
"remarks": "Testing remark"
}
}
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| title | Job Title |
| department | Job Department |
| start_date required | Job Start Date |
| end_date required | Job End Date |
| rate_of_pay | Rate of pay |
| amount | Basic pay amount |
| currency | Currency |
| remarks | Job Remarks |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 60,
"title": "Testing job",
"department": "Testing Department",
"start_date": "03/05/2019",
"end_date": "31/05/2020",
"remarks": "Testing remark",
"amount": "1000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
Delete Job
Request
Endpoint
DELETE https://api.talenox.com/api/v2/jobs/66
Accept: application/json
Content-Type: application/json
Authorization: Bearer 34faeb4414560e1e5585b767fea924648d8d21a2
DELETE https://api.talenox.com/api/v2/jobs/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted job 66"
}
Get Job
Request
Endpoint
GET https://api.talenox.com/api/v2/jobs/63
Accept: application/json
Content-Type: application/json
Authorization: Bearer 32b73f088fea13bbc4e1ae4cc7a1ad957bbbcfc2
GET https://api.talenox.com/api/v2/jobs/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 63,
"title": "Title1",
"department": null,
"start_date": "06/05/2025",
"end_date": null,
"remarks": null,
"amount": "5493.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
Update Job
Request
Endpoint
PUT https://api.talenox.com/api/v2/jobs/64
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2de69f1bb94c43c061876d9f9a4099852957533a
PUT https://api.talenox.com/api/v2/jobs/:id
Parameters
{
"job": {
"title": "Updated job",
"department": "Updated Department",
"currency": "HKD",
"start_date": "01/01/2017",
"end_date": "03/01/2019",
"amount": 2000,
"rate_of_pay": "Daily"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 64,
"title": "Updated job",
"department": "Updated Department",
"start_date": "01/01/2017",
"end_date": "03/01/2019",
"remarks": null,
"amount": "2000.0",
"rate_of_pay": "Daily",
"currency": "HKD"
}
Leave
List All Leave Applications
Request
Endpoint
GET https://api.talenox.com/api/v2/leave??employee_ids[]=1027
Accept: application/json
Content-Type: application/json
Authorization: Bearer 13b1f9e35d0731cea57beca6926fbcb28fba39c8
GET https://api.talenox.com/api/v2/leave?
Parameters
?employee_ids: ["1027"]
| 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": 361,
"employee_id": 1027,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2025-05-06",
"start_date_which_half": "AM",
"end_at": "2025-05-06",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2025-05-06",
"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": 361,
"employee_id": 1027,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2025-05-06",
"start_date_which_half": "AM",
"end_at": "2025-05-06",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2025-05-06",
"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": 361,
"employee_id": 1027,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2025-05-06",
"start_date_which_half": "AM",
"end_at": "2025-05-06",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2025-05-06",
"leave_duration_type": "All Day",
"derived_duration_qty": 1
}
],
"number_of_levels": 1,
"approvers": [],
"admin_approver": null
}
]
Leave Applications (BETA)
Approve leave
This approves a pending leave application
Request
Endpoint
PATCH https://api.talenox.com/api/v2/leave_beta/applications/approve/21
Accept: application/json
Content-Type: application/json
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
PATCH https://api.talenox.com/api/v2/leave_beta/applications/approve/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 21,
"timestamp": "2025-05-06T18:04:05.721+08:00"
}
Create leave application
Request
Endpoint
POST https://api.talenox.com/api/v2/leave_beta/applications
Accept: application/json
Content-Type: application/json
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
POST https://api.talenox.com/api/v2/leave_beta/applications
Parameters
{
"employee_id": 935,
"category_id": 61,
"category": "type",
"start_date": "2025-05-05",
"end_date": "2025-05-05",
"remarks": "test",
"working_days": [
{
"date": "2025-05-05",
"type": "full_day"
}
],
"applied_durations": [
{
"date": "2025-05-05",
"type": "full_day"
}
],
"approvers": [
{
"approver_id": 943,
"level": 1
}
]
}
| Name | Description |
|---|---|
| approver_id required | Employee ID |
| category required | 'type' or 'oil' |
| employee_id required | Employee ID |
| applied_durations | json array of duration json object with date (YYYY-MM-DD) and type as attributes. type must be 'full_day', 'first_half' or 'second_half'. See Leave Application flow for details |
| working_days | json array of working_day json object with date (YYYY-MM-DD) and type as attributes. type must be 'full_day', 'first_half', 'second_half', 'holiday' or 'not_working' |
| category_id | Leave Type ID for 'type' category, Off In Lieu ID for 'oil' category |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"leave_application_id": 20
}
Delete leave application
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/applications/15
Accept: application/json
Content-Type: application/json
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
DELETE https://api.talenox.com/api/v2/leave_beta/applications/:id
Parameters
| Name | Description |
|---|---|
| id required | Leave Application ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 15,
"status": "success",
"timestamp": "2025-05-06T18:03:56.273+08:00"
}
Delete leave attachments
Deletes up to 10 attachment ids
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/attachments?ids=4,2
Accept: application/json
Content-Type: application/json
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
DELETE https://api.talenox.com/api/v2/leave_beta/attachments
Parameters
ids: 4,2
| Name | Description |
|---|---|
| ids required | comma separated Attachment IDs |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Attachments deleted successfully",
"errors": {
"2": "no attachment found"
},
"timestamp": "2025-05-06T18:04:30.404+08:00"
}
Get leave application by id
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications/14
Accept: application/json
Content-Type: application/json
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
GET https://api.talenox.com/api/v2/leave_beta/applications/:id
Parameters
| Name | Description |
|---|---|
| overlap_from required | Date in YYYY-MM-DD |
| overlap_to required | Date in YYYY-MM-DD |
| employee_id | Employee ID |
| approver_id | Employee ID of leave approver |
| category | 'type' or 'oil' |
| category_id | Leave Type ID for 'type' category, Off In Lieu ID for 'oil' category |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"amount": "1.0",
"approvers": null,
"attachments": [
{
"attachment_id": 2,
"filename": "dummy_image.png",
"file_size": 31798,
"file_url": "/uploads/attachment/221/935/2/dummy_image.png",
"file_preview_url": "/uploads/attachment/221/935/2/preview_dummy_image.png"
}
],
"category_class": "type",
"category_id": 84,
"created_at": "2025-05-06T10:03:53.701Z",
"employee_id": 935,
"end_date": "2025-05-06",
"end_time": "PM",
"id": 14,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-05-06",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-05-06T10:03:53.701Z"
}
List all leave applications
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications?overlap_from=2025-05-06&overlap_to=2025-05-07
Accept: application/json
Content-Type: application/json
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
GET https://api.talenox.com/api/v2/leave_beta/applications
Parameters
overlap_from: 2025-05-06
overlap_to: 2025-05-07
| 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-05-06T10:03:38.067Z",
"employee_id": 935,
"end_date": "2025-05-06",
"end_time": "PM",
"id": 1,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-05-06",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-05-06T10:03:38.067Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 72,
"created_at": "2025-05-06T10:03:38.472Z",
"employee_id": 935,
"end_date": "2025-05-06",
"end_time": "PM",
"id": 2,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-05-06",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-05-06T10:03:38.472Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 73,
"created_at": "2025-05-06T10:03:39.262Z",
"employee_id": 935,
"end_date": "2025-05-06",
"end_time": "PM",
"id": 3,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-05-06",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-05-06T10:03:39.262Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": [
{
"attachment_id": 1,
"filename": "dummy_image.png",
"file_size": 31798,
"file_url": "/uploads/attachment/221/935/1/dummy_image.png",
"file_preview_url": "/uploads/attachment/221/935/1/preview_dummy_image.png"
}
],
"category_class": "type",
"category_id": 74,
"created_at": "2025-05-06T10:03:39.701Z",
"employee_id": 935,
"end_date": "2025-05-06",
"end_time": "PM",
"id": 4,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-05-06",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-05-06T10:03:39.701Z"
}
]
List all leave applications by application status and created dates
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications?overlap_from=2025-05-06&overlap_to=2025-05-07&created_start=2025-05-06&created_end=2025-05-07&leave_application_status=pending
Accept: application/json
Content-Type: application/json
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
GET https://api.talenox.com/api/v2/leave_beta/applications
Parameters
overlap_from: 2025-05-06
overlap_to: 2025-05-07
created_start: 2025-05-06
created_end: 2025-05-07
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-05-06T10:03:41.121Z",
"employee_id": 935,
"end_date": "2025-05-06",
"end_time": "PM",
"id": 5,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-05-06",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-05-06T10:03:41.121Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 76,
"created_at": "2025-05-06T10:03:41.556Z",
"employee_id": 935,
"end_date": "2025-05-06",
"end_time": "PM",
"id": 6,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-05-06",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-05-06T10:03:41.556Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 77,
"created_at": "2025-05-06T10:03:42.052Z",
"employee_id": 935,
"end_date": "2025-05-06",
"end_time": "PM",
"id": 7,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2025-05-06",
"start_time": "AM",
"status": "pending",
"updated_at": "2025-05-06T10:03:42.052Z"
}
]
Reject leave
This rejects a pending leave application
Request
Endpoint
PATCH https://api.talenox.com/api/v2/leave_beta/applications/reject/28
Accept: application/json
Content-Type: application/json
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
PATCH https://api.talenox.com/api/v2/leave_beta/applications/reject/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 28,
"timestamp": "2025-05-06T18:04:23.981+08:00"
}
Upload leave attachment
Upload a leave attachment with multipart/form-data. Required parameters are Leave application id, employee id and file
Request
Endpoint
POST https://api.talenox.com/api/v2/leave_beta/attachments/upload
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
POST https://api.talenox.com/api/v2/leave_beta/attachments/upload
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="leave_application_id"
30
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="employee_id"
935
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="file"; filename="dummy_image.png"
content-type: image/png
content-length: 31798
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
None known.
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"attachment_id": 3
}
delete multiple leave applications
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/applications?employee_id=935&leave_application_ids=11
Accept: application/json
Content-Type: application/json
Authorization: Bearer l13BUebDhSgU4tm1ib2RyB5uzb9O3KU8_2-5CR4DlEQ
DELETE https://api.talenox.com/api/v2/leave_beta/applications
Parameters
employee_id: 935
leave_application_ids: 11
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Leave application ids for input employee id 935 processed successfully",
"errors": {},
"timestamp": "2025-05-06T18:03:52.352+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/124/levels
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/levels
Parameters
{
"approvers": [
{
"approver_ids": [
963
],
"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": [
965
]
},
{
"level": 2,
"approvers": [
963
]
}
],
"company_default": true,
"id": 124,
"levels": 2,
"name": "Structure llfw4ijkr1",
"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/118/assign_approvers
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/assign_approvers
Parameters
{
"approvers": [
{
"approver_ids": [
963
],
"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": [
965,
963
]
}
],
"company_default": true,
"id": 118,
"levels": 1,
"name": "Structure zo1stysklo",
"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/112/assign_employees?employee_ids=963,965
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/assign_employees
Parameters
employee_ids: 963,965
| 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": [
963,
965
]
}
List all leave approval structures for a company
returns an array of leave approval structures for an authorized user's company
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures?company_id=273
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures
Parameters
company_id: 273
| 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": [
965
]
}
],
"company_default": true,
"id": 96,
"levels": 1,
"name": "Structure 0ol10y9w8n",
"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/109/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/employees
Parameters
| Name | Description |
|---|---|
| company_id required | Company ID |
| last_employee_id | For pagination. Results returned will start from this employee id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
955,
963
]
Remove levels to a leave approval structure
Request
Endpoint
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/127/levels
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/levels
Parameters
{
"levels": [
1
]
}
| Name | Description |
|---|---|
| approver_ids required | json array of approver_ids and approval level |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "levels removed successfully",
"errors": [],
"timestamp": "2025-05-06T18:05:30.045+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/121/unassign_approvers
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/unassign_approvers
Parameters
{
"approvers": [
{
"approver_ids": [
965
],
"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-05-06T18:05:21.341+08:00"
}
Unassign employees of a leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/115/unassign_employees?employee_ids=963,965
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/unassign_employees
Parameters
employee_ids: 963,965
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": 965
}
],
"timestamp": "2025-05-06T18:05:12.248+08:00"
}
creates a leave approval structure
Request
Endpoint
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
POST https://api.talenox.com/api/v2/leave_beta/leave_approval_structures
Parameters
{
"name": "new Test LAS ",
"company_id": 273,
"company_default": false,
"employee_ids": [
963,
965
]
}
| 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/108
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
DELETE https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "leave approval structure deleted successfully",
"timestamp": "2025-05-06T18:04:58.594+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/99
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id
Parameters
| Name | Description |
|---|---|
| id required | Leave Approval Structure ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"approvers": [
{
"level": 1,
"approvers": [
965
]
}
],
"company_default": true,
"id": 99,
"levels": 1,
"name": "Structure egp5ai0nn8",
"number_of_employees": 2
}
updates a leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/102
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFjfntzm8fRuXmkDzK4tmM-4MvMtgIOPqKw0Z7JbriQ
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id
Parameters
{
"name": "new Test LAS 2",
"company_id": 273,
"employee_ids": [
963,
965
]
}
| 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": [
965
]
}
],
"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?employee_id=990&approver_id=38
Accept: application/json
Content-Type: application/json
Authorization: Bearer PN62V-LJyCBxYzLKTPexokMWWyGAS3f-v_m_kMVAg0k
GET https://api.talenox.com/api/v2/leave_beta/approvers
Parameters
employee_id: 990
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": [
1000
],
"level": 1,
"flexible": false
}
]
List all leave approvers for an employee
This returns an array of leave approval structures for an authorized user's company
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/approvers?employee_id=990
Accept: application/json
Content-Type: application/json
Authorization: Bearer PN62V-LJyCBxYzLKTPexokMWWyGAS3f-v_m_kMVAg0k
GET https://api.talenox.com/api/v2/leave_beta/approvers
Parameters
employee_id: 990
| 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": [
1000
],
"level": 1,
"flexible": false
}
]
Leave Off in Lieus (BETA)
Get off in lieu balance for all off in lieus of an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance?employee_id=1016&query_date=20250506&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer iz3Y2lcwngrg8Q_eDfWrqVr342zRNoxf5KfEVlqL6pI
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance
Parameters
employee_id: 1016
query_date: 20250506
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": 1016,
"query_date": "2025-05-06",
"timestamp": "2025-05-06T18:05:59.406+08:00",
"results": [
{
"balance": 1.0,
"errors": [],
"leave_type_id": 4
}
]
}
Get off in lieu balance for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance?employee_id=1016&query_date=20250506&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer iz3Y2lcwngrg8Q_eDfWrqVr342zRNoxf5KfEVlqL6pI
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance
Parameters
employee_id: 1016
query_date: 20250506
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": 1016,
"query_date": "2025-05-06",
"timestamp": "2025-05-06T18:05:59.584+08:00",
"results": [
{
"balance": 1.0,
"errors": [],
"leave_type_id": 5
}
]
}
Get off in lieu by id
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer iz3Y2lcwngrg8Q_eDfWrqVr342zRNoxf5KfEVlqL6pI
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 3,
"name": "Off day",
"policy_end_date": "2025-06-06",
"policy_start_date": "2025-05-06",
"quantity_type": "day"
}
Get off in lieu entitlement for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/entitlement_period?employee_id=1016&id=6&query_date=20250506
Accept: application/json
Content-Type: application/json
Authorization: Bearer iz3Y2lcwngrg8Q_eDfWrqVr342zRNoxf5KfEVlqL6pI
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/entitlement_period
Parameters
employee_id: 1016
id: 6
query_date: 20250506
| 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": 1016,
"leave_type_id": 6,
"query_date": "2025-05-06",
"timestamp": "2025-05-06T18:05:59.768+08:00",
"valid_periods": {
"end_date": "2025-06-06",
"errors": [],
"start_date": "2025-05-06"
}
}
List all off in lieus
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
Accept: application/json
Content-Type: application/json
Authorization: Bearer iz3Y2lcwngrg8Q_eDfWrqVr342zRNoxf5KfEVlqL6pI
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
Parameters
| Name | Description |
|---|---|
| employee_id | Employee ID |
| id | Off in Lieu ID |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 1,
"name": "Off day",
"policy_end_date": "2025-06-06",
"policy_start_date": "2025-05-06",
"quantity_type": "day"
}
]
List off in lieus for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus?employee_id=1016&id=2
Accept: application/json
Content-Type: application/json
Authorization: Bearer iz3Y2lcwngrg8Q_eDfWrqVr342zRNoxf5KfEVlqL6pI
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
Parameters
employee_id: 1016
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-06-06",
"policy_start_date": "2025-05-06",
"quantity_type": "day"
}
]
Leave Types (BETA)
Get leave balance for a leave type of an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/balance?employee_id=1013&id=150&query_date=20250506
Accept: application/json
Content-Type: application/json
Authorization: Bearer a-KTtxKZQGiGm7daClwihDbY_owAjVCV1ZpoPZ7oAOw
GET https://api.talenox.com/api/v2/leave_beta/types/balance
Parameters
employee_id: 1013
id: 150
query_date: 20250506
| 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": 1013,
"query_date": "2025-05-06",
"timestamp": "2025-05-06T18:05:52.314+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?employee_id=1013&query_date=20250506&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer a-KTtxKZQGiGm7daClwihDbY_owAjVCV1ZpoPZ7oAOw
GET https://api.talenox.com/api/v2/leave_beta/types/balance
Parameters
employee_id: 1013
query_date: 20250506
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": 1013,
"query_date": "2025-05-06",
"timestamp": "2025-05-06T18:05:52.186+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?employee_id=1013&id=150&query_date=20250506
Accept: application/json
Content-Type: application/json
Authorization: Bearer a-KTtxKZQGiGm7daClwihDbY_owAjVCV1ZpoPZ7oAOw
GET https://api.talenox.com/api/v2/leave_beta/types/entitlement_period
Parameters
employee_id: 1013
id: 150
query_date: 20250506
| 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": 1013,
"leave_type_id": 150,
"query_date": "2025-05-06",
"timestamp": "2025-05-06T18:05:52.402+08:00",
"valid_periods": [
{
"end_date": "2024-12-31",
"errors": [],
"start_date": "2024-05-06"
},
{
"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/150
Accept: application/json
Content-Type: application/json
Authorization: Bearer a-KTtxKZQGiGm7daClwihDbY_owAjVCV1ZpoPZ7oAOw
GET https://api.talenox.com/api/v2/leave_beta/types/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 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
Accept: application/json
Content-Type: application/json
Authorization: Bearer a-KTtxKZQGiGm7daClwihDbY_owAjVCV1ZpoPZ7oAOw
GET https://api.talenox.com/api/v2/leave_beta/types
Parameters
| Name | Description |
|---|---|
| employee_id | Employee ID |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 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?employee_id=1013&last_seen_id=151&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer a-KTtxKZQGiGm7daClwihDbY_owAjVCV1ZpoPZ7oAOw
GET https://api.talenox.com/api/v2/leave_beta/types
Parameters
employee_id: 1013
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
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5aff27504da4bff27af79e008012aed44f68ced8
POST https://api.talenox.com/api/v2/metadata/get_items
Parameters
{
"fields": [
"company",
"marital_status",
"gender",
"payment_method",
"rate_of_pay",
"country_name",
"region",
"citizenship",
"nationality",
"race",
"religion",
"bank_type",
"currency",
"relationship",
"wp_worker_category",
"cpf_donation_type",
"wp_dcs",
"spass_dcs",
"voluntary_employer_contribution_type",
"voluntary_employee_contribution_type",
"voluntary_employer_contribution_rate",
"voluntary_employee_contribution_rate",
"socso_setting",
"employee_epf_setting",
"employer_epf_setting",
"period",
"pay_item_types"
]
}
| Name | Description |
|---|---|
| fields required | List of parameters |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"company": {
"id": 365,
"name": "Emmerich, Bogisich and Strosin"
}
},
{
"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": [
"Medisave",
"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)",
"Deduction Community Chest"
],
"Adhoc": [
"Reimbursements",
"Advance Pay",
"Allowance",
"Deduction",
"Commission (Irregular)",
"Extra Duty Allowance",
"Festive Allowance",
"Housing/ Rental Allowance",
"Incentive",
"Incentive Allowance",
"IR21 Tax Withholding",
"Meal Allowance",
"Per Diem Allowance",
"Per Diem Reimbursement",
"Transport Allowance",
"Referral of Employees Fees",
"Benefits in Kind",
"Gifts in Kind",
"Share Option Sale",
"Termination Benefits",
"Tips",
"Annual Wage Supplement",
"Bonus",
"Prior Year Bonus",
"Prior Year AWS",
"Leave Pay",
"Director fees",
"Backdated Salary Increment",
"Backdated Salary",
"Deduction (from Net Salary)",
"Others",
"Others(no gross)",
"Salary in lieu",
"Onboarding incentive",
"Gratuity paid for years of service",
"Compensation for loss of employment",
"Deduction (from Net Salary)(no SHG contribution)",
"NS Leave Claims Deduction",
"Flexi-Benefit Personal Insurance",
"Flexi-Benefit Optical Expenses",
"Flexi-Benefit Health Screening & Vaccinations",
"Flexi-Benefit Childcare / Eldercare Fees For Dependants",
"Flexi-Benefit Medical Expenses For Dependants",
"Flexi-Benefit Dental Expenses For Dependants",
"Flexi-Benefit Gym Membership",
"Flexi-Benefit Holiday Expenses",
"Flexi-Benefit TCM / CHIRO/ PHYSIO",
"Gratuity",
"Flexi-Benefit Work From Home",
"Flexi-Benefit Mental Health Awareness",
"Flexi-Benefit Personal Planning & Enrichment",
"Flexi-Benefit Home Affairs Support",
"Flexi-Benefit Home Family Bonding Facilitation",
"Flexi-Benefit Professional Subscription"
],
"Attendance": [
"Regular Hours",
"Overtime Hours",
"Regular Days",
"Overtime Days",
"Public Holiday Pay",
"Rest Day Pay",
"Deputy Awage",
"Deputy"
]
}
}
]
Next of Kins
Create Next of Kin
Request
Endpoint
POST https://api.talenox.com/api/v2/next_of_kins
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8c060d804ce0b1b044728d7faf527f897b353d6d
POST https://api.talenox.com/api/v2/next_of_kins
Parameters
{
"employee_id": 1038,
"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": 1038,
"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/7
Accept: application/json
Content-Type: application/json
Authorization: Bearer e37f5a826745d50dc48e006a46b017d34f5acda0
DELETE https://api.talenox.com/api/v2/next_of_kins/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted next of kin Name"
}
Get Next of Kin
Request
Endpoint
GET https://api.talenox.com/api/v2/next_of_kins/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer b06c5045948da5360f73561f8e0b843c8d086dc8
GET https://api.talenox.com/api/v2/next_of_kins/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 5,
"employee_id": 1049,
"name": "Name",
"relationship": "Son",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2025-05-06",
"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/6
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7273bc524dd883727c61829c14516decda451ec1
PUT https://api.talenox.com/api/v2/next_of_kins/:id
Parameters
{
"next_of_kin": {
"name": "Change name"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 6,
"employee_id": 1060,
"name": "Change name",
"relationship": "Son",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2025-05-06",
"gender": null,
"marriage_date": null,
"ssn": null,
"passport": null,
"citizenship": "Singaporean"
}
Payroll
Create Adhoc Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/adhoc_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer c52e40ee621dc010573f308de84b1f1426a74bdb
POST https://api.talenox.com/api/v2/payroll/adhoc_payment
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 18
},
"pay_items": [
{
"employee_id": "K00001",
"item_type": "Allowance",
"amount": 1000,
"remarks": ""
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| pay_items required | Below are pay items related fields |
| employee_id required | Employee ID |
| item_type required | Pay Item Type |
| remarks | Remarks |
| amount required | Amount |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 18,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"pay_items": [
{
"id": 4,
"employee_id": 1098,
"item_type": "Allowance",
"remarks": "",
"amount": "1000.0",
"rate_of_pay": "0.0",
"currency": "SGD"
}
]
}
Create Attendance Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/attendance_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6933d99a18f73bc862e14cbb2894b031723a050b
POST https://api.talenox.com/api/v2/payroll/attendance_payment
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 19
},
"pay_items": [
{
"employee_id": "K00001",
"item_type": "Regular Hours",
"amount": 1000,
"rate_of_pay": 20,
"no_of_hours_slash_days": 8,
"remarks": null
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| pay_items required | Below are pay items related fields |
| employee_id required | Employee ID |
| item_type required | Pay Item Type |
| remarks | Remarks |
| amount required | Amount |
| no_of_hours_slash_days | Number of days or hours worked |
| rate_of_pay | Rate of pay |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 19,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"pay_items": [
{
"id": 4,
"employee_id": 1099,
"item_type": "Regular Hours",
"remarks": null,
"amount": "1000.0",
"rate_of_pay": "20.0",
"no_of_hours_slash_days": "8.0",
"currency": "SGD"
}
]
}
Create Leave Payment or Deduction
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3cd7fe4e2604bec5858a2c78d740100b8755e396
POST https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 20
},
"pay_items": [
{
"employee_id": "K00001",
"item_type": "No Pay Leave(Unpaid Leave)",
"remarks": "1/9/2018",
"amount": 2000,
"override_working_days": 21
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| pay_items required | Below are pay items related fields |
| employee_id required | Employee ID |
| item_type required | Pay Item Type |
| remarks | Remarks |
| amount | If provided, the system will use this amount instead of the calculated value |
| override_working_days | If provided, will override the NPL calculation working days |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 20,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"pay_items": [
{
"id": 4,
"employee_id": 1100,
"item_type": "No Pay Leave(Unpaid Leave)",
"remarks": "01/09/2018",
"amount": "-2000.0",
"override_working_days": "21.0",
"currency": "SGD"
}
]
}
Create Payroll Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/payroll_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 490c32941a0cb218f27f09a9e4525aa17515a64e
POST https://api.talenox.com/api/v2/payroll/payroll_payment
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"with_pay_items": true
},
"employee_ids": [
"K00001"
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| month required | Month of payment |
| year required | Year of payment |
| period required | Period of payment |
| pay_group | Pay group of payment |
| with_pay_items | With Monthly pay items |
| employee_ids | Employee IDs to create payment for |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 4,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully created payment."
}
Create Recurring Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/recurring_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7b2d85499dfc1e47ec46304939f0ed9d3709190e
POST https://api.talenox.com/api/v2/payroll/recurring_payment
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 17
},
"pay_items": [
{
"employee_id": "K00001",
"item_type": "Basic Pay",
"amount": 1000,
"remarks": null,
"actual_no_of_working_days": 22,
"total_no_of_working_days": 30
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| pay_items required | Below are pay items related fields |
| employee_id required | Employee ID |
| item_type required | Pay Item Type |
| remarks | Remarks |
| amount required | Amount |
| actual_no_of_working_days | Actual number of working days (If provided, the default calculated value will be overridden) |
| total_no_of_working_days | Total number of working days (If provided, the default calculated value will be overridden) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 17,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"pay_items": [
{
"id": 6,
"employee_id": 1097,
"item_type": "Salary/Wages",
"remarks": null,
"amount": "1000.0",
"actual_no_of_working_days": 22,
"total_no_of_working_days": 30,
"rate_of_pay": "Monthly",
"currency": "SGD"
}
]
}
Delete Adhoc Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/adhoc_payment/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer f86148bb5e12b97d4aadf8067f8c2cd18cd0a8dd
DELETE https://api.talenox.com/api/v2/payroll/adhoc_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1091,
"item_type": "Allowance",
"remarks": "",
"amount": "1000.0",
"rate_of_pay": "0.0",
"currency": "SGD"
}
Delete Attendance Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/attendance_payment/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer a720ea031b17f2378093be00be22e56cae3bbad1
DELETE https://api.talenox.com/api/v2/payroll/attendance_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1092,
"item_type": "Regular Hours",
"remarks": null,
"amount": "1000.0",
"rate_of_pay": "20.0",
"no_of_hours_slash_days": "8.0",
"currency": "SGD"
}
Delete Leave Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer c5d2f30cf9829f8fb3f80701c58197047e7c82c7
DELETE https://api.talenox.com/api/v2/payroll/leave_payment_or_deduction/:id
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1093,
"item_type": "No Pay Leave(Unpaid Leave)",
"remarks": "1/9/2018",
"amount": "2000.0",
"override_working_days": "21.0",
"currency": null
}
Delete Payroll Payment
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/payroll_payment/7
Accept: application/json
Content-Type: application/json
Authorization: Bearer e37f08648942d251026083c2c11b5e7dff4bab56
DELETE https://api.talenox.com/api/v2/payroll/payroll_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Payment ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 7,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully deleted payment."
}
Delete Recurring Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/recurring_payment/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer f1aaa23bdaa66162d8f129a77d20969af6eaf599
DELETE https://api.talenox.com/api/v2/payroll/recurring_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Pay item ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 5,
"employee_id": 1090,
"item_type": "Salary/Wages",
"remarks": null,
"amount": "1000.0",
"actual_no_of_working_days": 20.0,
"total_no_of_working_days": 20.0,
"rate_of_pay": "Monthly",
"currency": "SGD"
}
Export Payroll
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/export_payroll
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7c3ba7748ec579e1f58b4e5d7942f5a5a80f86b3
POST https://api.talenox.com/api/v2/payroll/export_payroll
Parameters
{
"month": "September",
"year": 2018,
"period": "Whole Month"
}
| Name | Description |
|---|---|
| month required | Month of payment |
| year required | Year of payment |
| period required | Period of payment |
| pay_date | Pay date |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payslips": [
{
"ytd_gross_salary": "$1,000.00",
"ytd_bonus": "$0.00",
"ytd_net_payment": "$799.50",
"total_recurring_full": "$1,000.00",
"total_recurring_prorated": "$1,000.00",
"total_adhoc": "$0.00",
"total_attendance": "$0.00",
"total_gross": "$1,000.00",
"total_bonus": "$0.00",
"total_net_payment": "$799.50",
"total_deductions": "$0.00",
"ytd_cpf_employee": "$200.00",
"ytd_cpf_employer": "$170.00",
"total_sg_fwl": "$0.00",
"total_sg_cpf_owage": "$1,000.00",
"total_sg_cpf_awage": "$0.00",
"total_sg_cpf_employee": "$200.00",
"total_sg_cpf_employer": "$170.00",
"total_sg_cpf_donation": "$0.50",
"total_sg_additional_cpf_donation": "$0.00",
"total_sg_cpf_sdl": "$2.50",
"employee_final_cpf": "$200.50",
"sg_total_sdl_contributable": "$1,000.00",
"id": 1101,
"employee_id": "K00001",
"name": "Georgeanna Adams",
"job_title": null,
"department": null,
"country_code": "SG",
"currency_unit": "$",
"attendance_pay_items": [],
"recurring_pay_items": [
{
"id": 7,
"employee_id": 1101,
"currency_id": 1,
"currency_value": "sgd",
"item_type": "Salary/Wages",
"amount": "1000.0",
"prorated_amount": "1000.0",
"remarks": null,
"preferences": {
"sg_cpf": true,
"sg_sdl": true,
"sg_shg": true,
"sg_tax": true
},
"working_days_setting": {
"total_no_of_working_days": 20.0,
"actual_no_of_working_days": 20.0
},
"custom_pay_item_id": 32894,
"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": 398,
"company_id": 398,
"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-05-06T10:06:59.097Z",
"updated_at": "2025-05-06T10:06:59.157Z",
"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,
"exclude_perkeso_relief_from_mtd": false
}
}
Get Payroll Payment
Request
Endpoint
GET https://api.talenox.com/api/v2/payroll/payroll_payment/6
Accept: application/json
Content-Type: application/json
Authorization: Bearer 25831a06716fb333e3ca1e4ccd685e9fdf9472da
GET https://api.talenox.com/api/v2/payroll/payroll_payment/:id
Parameters
| Name | Description |
|---|---|
| id required | Payment ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 6,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"created_by_webhook": true,
"bank_file_exported": false,
"bank_file_value_date": null,
"cheque_payment_exported": false,
"cheque_payment_value_date": null,
"recurring_pay_items": [
{
"id": 3,
"employee_id": 1086,
"item_type": "Salary/Wages",
"remarks": null,
"amount": "1000.0",
"actual_no_of_working_days": 20.0,
"total_no_of_working_days": 20.0,
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"adhoc_pay_items": [
{
"id": 1,
"employee_id": 1086,
"item_type": "Allowance",
"remarks": "",
"amount": "1000.0",
"rate_of_pay": "0.0",
"currency": "SGD"
}
],
"attendance_pay_items": [
{
"id": 1,
"employee_id": 1086,
"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": 1086,
"item_type": "No Pay Leave(Unpaid Leave)",
"remarks": "1/9/2018",
"amount": "2000.0",
"override_working_days": "21.0",
"currency": null
}
]
}
Get Payslips Data
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/get_payslips_data
Accept: application/json
Content-Type: application/json
Authorization: Bearer 93a4bf2e223b1c78c04b80c8bef5710521096dfd
POST https://api.talenox.com/api/v2/payroll/get_payslips_data
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
"K00001"
]
}
| Name | Description |
|---|---|
| employee_ids | Employee IDs |
| month required | Month of payment |
| year required | Year of payment |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payslips": [
{
"ytd_gross_salary": "$1,000.00",
"ytd_bonus": "$0.00",
"ytd_net_payment": "$799.50",
"total_recurring_full": "$1,000.00",
"total_recurring_prorated": "$1,000.00",
"total_adhoc": "$0.00",
"total_attendance": "$0.00",
"total_gross": "$1,000.00",
"total_bonus": "$0.00",
"total_net_payment": "$799.50",
"total_deductions": "$0.00",
"ytd_cpf_employee": "$200.00",
"ytd_cpf_employer": "$170.00",
"total_sg_fwl": "$0.00",
"total_sg_cpf_owage": "$1,000.00",
"total_sg_cpf_awage": "$0.00",
"total_sg_cpf_employee": "$200.00",
"total_sg_cpf_employer": "$170.00",
"total_sg_cpf_donation": "$0.50",
"total_sg_additional_cpf_donation": "$0.00",
"total_sg_cpf_sdl": "$2.50",
"employee_final_cpf": "$200.50",
"sg_total_sdl_contributable": "$1,000.00",
"id": 1104,
"employee_id": "K00001",
"name": "Sandy Beer",
"job_title": null,
"department": null,
"country_code": "SG",
"currency_unit": "$",
"attendance_pay_items": [],
"recurring_pay_items": [
{
"id": 10,
"employee_id": 1104,
"currency_id": 1,
"currency_value": "sgd",
"item_type": "Salary/Wages",
"amount": "1000.0",
"prorated_amount": "1000.0",
"remarks": null,
"preferences": {
"sg_cpf": true,
"sg_sdl": true,
"sg_shg": true,
"sg_tax": true
},
"working_days_setting": {
"total_no_of_working_days": 20.0,
"actual_no_of_working_days": 20.0
},
"custom_pay_item_id": 33146,
"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": 401,
"company_id": 401,
"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-05-06T10:07:05.673Z",
"updated_at": "2025-05-06T10:07:05.735Z",
"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,
"exclude_perkeso_relief_from_mtd": false
}
}
Get Payslips PDF
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/get_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer 91796a37ecb4c379a2b11c4ed73646ebcd36aab4
POST https://api.talenox.com/api/v2/payroll/get_payslips
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
1102
]
}
| 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
[
{
"1102": null
}
]
Get Payslips PDF with Employee Details
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/get_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer b7883c61642d49c81258d3ff9eba6825ccb1e897
POST https://api.talenox.com/api/v2/payroll/get_payslips
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
1103
],
"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
[
{
"1103": {
"payslip_url": null,
"employee_id": null,
"employee_first_name": null,
"employee_last_name": null,
"employee_birthdate": null
}
}
]
List All Payroll Payments
Request
Endpoint
GET https://api.talenox.com/api/v2/payroll/payroll_payment?month=September&year=2018&created_by_webhook=true
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7ad5a489c31db7b2c37b063f2c73b0ba49f0b316
GET https://api.talenox.com/api/v2/payroll/payroll_payment
Parameters
month: September
year: 2018
created_by_webhook: true
| Name | Description |
|---|---|
| month required | Month of payment |
| year required | Year of payment |
| created_by_webhook | Filter for querying only the payments created by webhook |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"payment_id": 5,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"created_by_webhook": true,
"bank_file_exported": false,
"bank_file_value_date": null,
"cheque_payment_exported": false,
"cheque_payment_value_date": null,
"recurring_pay_items": [],
"adhoc_pay_items": [],
"attendance_pay_items": [],
"leave_pay_items": []
}
]
Process Payroll Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/payroll_payment/8/process
Accept: application/json
Content-Type: application/json
Authorization: Bearer 416cba093239bf2f88178fd3860d1c150c00fc9c
POST https://api.talenox.com/api/v2/payroll/payroll_payment/:id/process
Parameters
| Name | Description |
|---|---|
| id required | Payment ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 8,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Processed",
"message": "Successfully processed payment."
}
Publish Payslips
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/publish_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer 161de3255ce6b519d2651b0004edf5e92481a531
POST https://api.talenox.com/api/v2/payroll/publish_payslips
Parameters
{
"month": "September",
"year": "2018",
"payslip_pay_date": "30/09/2018",
"payslip_send_on_pd_setting": 0,
"attach_payslip_to_email": 0
}
| Name | Description |
|---|---|
| month required | Month of payment |
| year required | Year of payment |
| payslip_pay_date required | Payslip Pay Date |
| payslip_send_on_pd_setting required | payslip Send On Pay Date Setting |
| attach_payslip_to_email required | Attach Payslip To Email |
| employee_ids | Employee IDs |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Payslips published",
"published": true
}
Pull Leave Applications
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/pull_leave_applications
Accept: application/json
Content-Type: application/json
Authorization: Bearer ce4d8b7ddb2d50d358272d19c784f5738f00171f
POST https://api.talenox.com/api/v2/payroll/pull_leave_applications
Parameters
{
"payment": {
"month": "September",
"year": 2018,
"period": "Whole Month",
"pay_group": null
}
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Leave applications pulled successfully"
}
Set Payment to Draft
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/payroll_payment/9/draft
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9b68835f6d1c09c4a71c14a9193541ec73b7c405
POST https://api.talenox.com/api/v2/payroll/payroll_payment/:id/draft
Parameters
| Name | Description |
|---|---|
| id required | Payment ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 9,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment."
}
Unpublish Payslips
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/unpublish_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer a830377711cb2d82416f2259896a012195695996
POST https://api.talenox.com/api/v2/payroll/unpublish_payslips
Parameters
{
"month": "September",
"year": "2018"
}
| Name | Description |
|---|---|
| month required | Month of payment |
| year required | Year of payment |
| employee_ids | Employee IDs |
Response
Content-Type: text/plain; charset=utf-8
200 OK
Update Payment Settings
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer 521ca80e66473868dfb9cfcad7f288b027729604
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 14
},
"settings": [
{
"employee_id": "K00001",
"is_bank_payment": false,
"selected_cost_centre_id": 47,
"employees_payment_methods": "Bank Transfer"
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| settings required | Settings related fields |
| employee_id | Employee ID |
| employees_payment_methods | Indicate payment mode for employee: Bank/Cheque/Forex/Cash payment |
| selected_cost_centre_id | Cost centre ID to process the employee under (defaults to default cost centre) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 14,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"settings": [
{
"employee_id": 1094,
"selected_cost_centre_id": 47,
"employees_payment_methods": "Bank Transfer"
}
]
}
Update without payment methods - is_bank_payment set to false
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer 759b0b58ffe1fb94fceef9e2c8e5458919063b62
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 16
},
"settings": [
{
"employee_id": "K00001",
"is_bank_payment": false,
"selected_cost_centre_id": 51
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| settings required | Settings related fields |
| employee_id | Employee ID |
| employees_payment_methods | Indicate payment mode for employee: Bank/Cheque/Forex/Cash payment |
| selected_cost_centre_id | Cost centre ID to process the employee under (defaults to default cost centre) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 16,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"settings": [
{
"employee_id": 1096,
"selected_cost_centre_id": 51,
"employees_payment_methods": "Cheque"
}
]
}
Update without payment methods - is_bank_payment set to true
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Accept: application/json
Content-Type: application/json
Authorization: Bearer a1bdf9935173ef481e5d8db4ac6ad4a4fc65a037
POST https://api.talenox.com/api/v2/payroll/update_payment_settings
Parameters
{
"payment": {
"year": 2018,
"month": "September",
"period": "Whole Month",
"pay_group": null,
"id": 15
},
"settings": [
{
"employee_id": "K00001",
"is_bank_payment": true,
"selected_cost_centre_id": 49
}
]
}
| Name | Description |
|---|---|
| payment required | Payment related fields |
| id | Payment ID (If not specified, last payment created by API will be used) |
| month | Month of payment (Mandatory if id not specified) |
| year | Year of payment (Mandatory if id not specified) |
| period | Period of payment (Mandatory if id not specified) |
| pay_group | Pay group of payment |
| settings required | Settings related fields |
| employee_id | Employee ID |
| employees_payment_methods | Indicate payment mode for employee: Bank/Cheque/Forex/Cash payment |
| selected_cost_centre_id | Cost centre ID to process the employee under (defaults to default cost centre) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"payment_id": 15,
"month": "September",
"year": "2018",
"period": "Whole Month",
"pay_group": null,
"status": "Draft",
"message": "Successfully updated payment.",
"settings": [
{
"employee_id": 1095,
"selected_cost_centre_id": 49,
"employees_payment_methods": "Bank Transfer"
}
]
}
User Info (OAuth)
Get user info
Request
Endpoint
GET https://api.talenox.com/api/v2/user_info
Accept: application/json
Content-Type: application/json
Authorization: Bearer m15y352Z6awlwAHgBEi8fz5UrTzuhJr2o8aMDOkG2cc
GET https://api.talenox.com/api/v2/user_info
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"company": {
"id": 423
},
"employee": {
"id": 1237,
"employee_id": "opq50dhvya"
}
}
Working Days
Create Working Day
Request
Endpoint
POST https://api.talenox.com/api/v2/working_days
Accept: application/json
Content-Type: application/json
Authorization: Bearer a536061f58d51a868761ee3799b972138f193adb
POST https://api.talenox.com/api/v2/working_days
Parameters
{
"working_day": {
"name": "New working day",
"company_default": false,
"week_schedule": [
"not_working",
"second_half",
"full_day",
"full_day",
"full_day",
"first_half",
"not_working"
],
"employee_ids": [
1371
]
}
}
| 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": [
1371
],
"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/187
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0565841e4e02678db6ac08ec246cc419ce3cbe9e
DELETE https://api.talenox.com/api/v2/working_days/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted working day 5"
}
Get Working Day
Request
Endpoint
GET https://api.talenox.com/api/v2/working_days/177
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3773bcc1f27055a5e28707d08901c0a15211b663
GET https://api.talenox.com/api/v2/working_days/:id
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
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5db715da12e5a341ee97fc2570be9d95a27515bd
GET https://api.talenox.com/api/v2/working_days
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/179
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8de211cd14eb05b835b09f6e99cdd9525db34b3a
PUT https://api.talenox.com/api/v2/working_days/:id
Parameters
{
"working_day": {
"name": "Change name",
"week_schedule": [
"not_working",
"full_day",
"full_day",
"full_day",
"full_day",
"not_working",
"not_working"
]
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 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
Accept: application/json
Content-Type: application/json
Authorization: Bearer 66f80fda29b5552e0eab72f9a2bf9ca64756922e
POST https://api.talenox.com/api/v2/working_hours
Parameters
{
"working_hour": {
"name": "New Working Hour",
"company_default": false,
"hours_per_week": 44.0,
"employee_ids": [
1451
]
}
}
| 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": [
1451
],
"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/188
Accept: application/json
Content-Type: application/json
Authorization: Bearer 218e0b5dd704a113dc2b27229a2c03757495c6d8
DELETE https://api.talenox.com/api/v2/working_hours/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted working hour Default"
}
Get Working Hour
Request
Endpoint
GET https://api.talenox.com/api/v2/working_hours/180
Accept: application/json
Content-Type: application/json
Authorization: Bearer 172c2593c33e5960c4be2df98a458a3acc7b5fd6
GET https://api.talenox.com/api/v2/working_hours/:id
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
Accept: application/json
Content-Type: application/json
Authorization: Bearer 04277d4a0fd972c5c89f478f8957d4c365999762
GET https://api.talenox.com/api/v2/working_hours
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/182
Accept: application/json
Content-Type: application/json
Authorization: Bearer f5d9e7bbaa0db821c6163893639bfcad0950d748
PUT https://api.talenox.com/api/v2/working_hours/:id
Parameters
{
"working_hour": {
"name": "Change name",
"hours_per_week": 40.0
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 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