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 d478f9ab54f71a9dd912969645d6bfe3e3b3e9ef
POST https://api.talenox.com/api/v2/branches
Parameters
{
"branch": {
"name": "Sample Branch",
"address": "390 Leandro Dam",
"postcode": "14086-6933",
"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": "390 Leandro Dam",
"postcode": "14086-6933",
"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 f4afb005985d1aacc4f3ae303522c1521c1f3a3e
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 badeeefe7ac2c5ba4f77e9e36b31669bbcc4f256
GET https://api.talenox.com/api/v2/branches
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 527,
"name": "New Octavioberg",
"employee_ids": [
494
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 528,
"name": "Lake Fredia",
"employee_ids": [
495
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 529,
"name": "East Lizzette",
"employee_ids": [
496
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 530,
"name": "Vernonborough",
"employee_ids": [
497
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 531,
"name": "South Jonasburgh",
"employee_ids": [
498
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 532,
"name": "Lake Geraldineside",
"employee_ids": [
499
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 533,
"name": "Orvalstad",
"employee_ids": [
500
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 534,
"name": "East Raisamouth",
"employee_ids": [
501
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 535,
"name": "Norikoside",
"employee_ids": [
],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 536,
"name": "Shanekaville",
"employee_ids": [
],
"no_of_employees": 0,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 537,
"name": "1647 Zboncak Hills",
"employee_ids": [
502,
503
],
"no_of_employees": 2,
"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": "Jeffereyton",
"employee_ids": [
491
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 525,
"name": "Connellyville",
"employee_ids": [
492
],
"no_of_employees": 1,
"address": null,
"postcode": null,
"head_id": null
},
{
"id": 526,
"name": "Beckerborough",
"employee_ids": [
493
],
"no_of_employees": 1,
"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 7ef8db72d9ed488d4b86818336e6efc53278ab85
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": "62660 Kunze Knolls",
"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 88cd26e8d7f7f562bbdf59509751bab5d21578ef
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 78f5b38bc41c23fdf2ad5e2439d424948cca5823
POST https://api.talenox.com/api/v2/company_holidays
Parameters
{
"custom_holiday": {
"name": "Test Holiday",
"start_at": "2024-12-31 23:59:59 +0800",
"end_at": "2024-12-31 23:59:59 +0800",
"custom_holiday_duration_attributes": {
"start_date_type": "all_day_start",
"end_date_type": "all_day_end"
}
}
}
| Name | Description |
|---|---|
| name required | Holiday name |
| start_at required | Start at |
| end_at required | End at |
| custom_holiday_duration_attributes[start_date_type] required | Start date type (["all_day_start", "first_part_of_the_day_start", "second_part_of_the_day_start"]) |
| custom_holiday_duration_attributes[end_date_type] required | End date type (["all_day_end", "first_part_of_the_day_end", "second_part_of_the_day_end"]) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1,
"company_id": 119,
"calendar_holiday_id": null,
"name": "Test Holiday",
"start_at": "2024-12-31",
"end_at": "2024-12-31",
"hide": false,
"created_at": "2024-08-16T08:10:37.052Z",
"updated_at": "2024-08-16T08:10:37.052Z"
}
Delete Company Calendar Holiday
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/8
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1c65c19fecc207bfb9e6d35511cabd8f7a57c0cf
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 44a427ab4bcf8f3e32b1478861b1253b2e329676
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 a684eb9df2204f832033dcd5ff2d0f82eb8f5aed
GET https://api.talenox.com/api/v2/company_holidays/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"company_id": 121,
"calendar_holiday_id": null,
"name": "Office Closure",
"start_at": "2024-12-30",
"end_at": "2024-12-31",
"hide": false,
"created_at": "2024-08-16T08:10:42.974Z",
"updated_at": "2024-08-16T08:10:42.974Z"
}
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 2664a9b7f0232ab87c6251813a5f9ce5b697010e
GET https://api.talenox.com/api/v2/company_holidays
Parameters
| Name | Description |
|---|---|
| year | Year for filtering, defaults to current year |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"country_id": 2,
"name": "Calendar Holiday",
"created_at": "2024-08-16T08:10:37.103Z",
"updated_at": "2024-08-16T08:10:37.103Z",
"start_at": "2024-01-01",
"end_at": "2024-01-02",
"state_id": null,
"hk_holiday_type": null,
"type": "CalendarHoliday",
"calendar_holiday_id": 4
},
{
"id": 2,
"company_id": 120,
"calendar_holiday_id": null,
"name": "Office Closure",
"start_at": "2024-12-30",
"end_at": "2024-12-31",
"created_at": "2024-08-16T08:10:39.949Z",
"updated_at": "2024-08-16T08:10:39.949Z",
"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 cb1e0bdcfae26d6892d8a427011d4532c43e2740
GET https://api.talenox.com/api/v2/company_holidays/deleted_calendar_holidays
Parameters
| Name | Description |
|---|---|
| year | Year for filtering, defaults to current year |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 12,
"country_id": 2,
"name": "Calendar Holiday",
"created_at": "2024-08-16T08:11:02.562Z",
"updated_at": "2024-08-16T08:11:02.562Z",
"start_at": "2024-01-01",
"end_at": "2024-01-02",
"state_id": null,
"hk_holiday_type": null
}
]
Retore Company Calendar Holiday
Request
Endpoint
PUT https://api.talenox.com/api/v2/company_holidays/calendar_holidays/9
Accept: application/json
Content-Type: application/json
Authorization: Bearer 436ae09d1f37fbd592355bc04680c6547860f5c5
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 c70ef605f05c5d143705134fc102b544cca6c8d5
PUT https://api.talenox.com/api/v2/company_holidays/:id
Parameters
{
"custom_holiday": {
"name": "Change name"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"company_id": 122,
"name": "Change name",
"id": 4,
"calendar_holiday_id": null,
"start_at": "2024-12-30",
"end_at": "2024-12-31",
"hide": false,
"created_at": "2024-08-16T08:10:45.999Z",
"updated_at": "2024-08-16T08:10:46.183Z"
}
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 365d2797c9433859d8c1d0f6f49674db5b1c1252
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 bf32d738cc003cbc8a522d347d4d8042735a4af1
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 3834022f9db06cdc9c7e4b77d53fce4e07694691
POST https://api.talenox.com/api/v2/cost_centres
Parameters
{
"cost_centre": {
"name": "Business",
"employee_ids": [
"pp3kqwtkwr",
"irfzgivfhw",
"r7mhy08x9u",
"o1qyi1kslv"
],
"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": [
627,
628,
629,
630
],
"no_of_employees": 4,
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456789"
}
Delete Cost Centre
Request
Endpoint
DELETE https://api.talenox.com/api/v2/cost_centres/11
Accept: application/json
Content-Type: application/json
Authorization: Bearer cbf9451f3660fef35ab5d9e9019ec6b2060ad40b
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 Christena Circles"
}
List Cost Centre
Request
Endpoint
GET https://api.talenox.com/api/v2/cost_centres
Accept: application/json
Content-Type: application/json
Authorization: Bearer 40771109ced281eefd01582bb691b0b191cfd981
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": "Lemke Tunnel",
"employee_ids": [
],
"no_of_employees": 0,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null
}
]
Update Cost Centre
Request
Endpoint
PUT https://api.talenox.com/api/v2/cost_centres/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer af1ff5b096c5f6276845622cf0ebd6ce20957588
PUT https://api.talenox.com/api/v2/cost_centres/:id
Parameters
{
"cost_centre": {
"name": "Engineer",
"employee_ids": [
"h8505z8jnr",
"ryo6ehcq5y",
"fyh3yk03zu",
"27fnlmvdu1"
],
"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": [
663,
664,
665,
659
],
"no_of_employees": 4,
"enable_custom_cpf_csn": true,
"custom_cpf_csn": "123456788"
}
Custom Pay Items
Create Custom Pay Item
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/custom_pay_items
Accept: application/json
Content-Type: application/json
Authorization: Bearer 540b4a9624d509113c5e0350429af2abc46470d8
POST https://api.talenox.com/api/v2/payroll/custom_pay_items
Parameters
{
"custom_pay_item": {
"proration_enabled": false,
"category": "Recurring",
"item_type": "Salary/Wages",
"gross_net_settings": "gross",
"tax": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"overtime_rate": 1.5,
"additional_sg_info_attributes": {
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info_attributes": {
"mpf": true,
"adw": true
},
"additional_my_info_attributes": {
"epf": true,
"socso": true,
"eis": true,
"hrdf": true
},
"additional_id_info_attributes": {
"bpjs": true,
"thr": true
}
}
}
| Name | Description |
|---|---|
| proration_enabled | Proration Enabled |
| categoary | Category (["Recurring", "Adhoc", "Attendance"]) |
| item_type | Item Type |
| gross_net_settings | Gross/Net settings |
| tax | Tax |
| payslip_display_settings | Payslip Display Settings (["Item Name", "Remarks", "Period", "Calculation"]) |
| overtime_rate | Overtime rate (for Attendance category only) |
| additional_sg_info_attributes | SG pay item related fields |
| cpf | CPF |
| sdl | SDL |
| shg | SHG |
| cpf_owage_awage | OWAGE/AWAGE |
| additional_hk_info_attributes | HK pay item related fields |
| mpf | MPF |
| adw | ADW |
| additional_my_info_attributes | MY pay item related fields |
| epf | EPF |
| socso | SOCSO |
| eis | EIS |
| hrdf | HRDF |
| additional_id_info_attributes | ID pay item related fields |
| bpjs | BPJS |
| thr | THR |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 26238,
"item_type": "Salary/Wages",
"name": null,
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "37d996a9-a853-44a0-9d45-220d9f4c2018",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25122,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": {
"id": 367,
"mpf": true,
"adw": true
},
"additional_my_info": {
"id": 385,
"epf": true,
"socso": true,
"eis": true,
"hrdf": true
},
"additional_id_info": {
"id": 361,
"bpjs": true,
"thr": true
}
}
Delete Custom Pay Item
Request
Endpoint
DELETE https://api.talenox.com/api/v2/payroll/custom_pay_items/26576
Accept: application/json
Content-Type: application/json
Authorization: Bearer 50bde44be8b7e0b53369ca057ad6257cfb50094d
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/26323
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5decd62c5196477035b4eeff92f5aff23540dfe0
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": 26323,
"item_type": "Salary/Wages",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "29c8bbd9-5a86-4192-a678-35d1d35459e7",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Period"
],
"pay_code": null,
"additional_sg_info": {
"id": 25207,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
}
List all Custom Pay Items
Request
Endpoint
GET https://api.talenox.com/api/v2/payroll/custom_pay_items
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0a2a32d26e2863eb55782d012cea14a4978b2846
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": 26239,
"item_type": "Salary/Wages",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "317fa9df-81e9-4ea3-81bd-2d77edcc1f6c",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Period"
],
"pay_code": null,
"additional_sg_info": {
"id": 25123,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26240,
"item_type": "Salary/Wages",
"name": "Basic Pay(without proration)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "4925bf6a-efdd-4701-8586-5898f009d5ed",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25124,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26241,
"item_type": "Allowance",
"name": "Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": true,
"slug": "ebd5459e-6772-4a33-8e3a-fe62759b2d76",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25125,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26242,
"item_type": "Allowance",
"name": "Allowance(without proration)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "4b6f3d30-fb2b-47ac-a690-e6b4dbfb023e",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25126,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26243,
"item_type": "Deduction",
"name": "Deduction",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b68264db-721a-465d-9b75-4bc1be8d3d75",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25127,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26244,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "5a7a7c1a-83e6-4906-856a-b41f98df41c9",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25128,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26245,
"item_type": "IR21 Tax Withholding",
"name": "IR21 Tax Withholding",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "1e9647c8-226b-401f-b6ab-c08746dbb45d",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25129,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26246,
"item_type": "Commission",
"name": "Commission (Daily/Weekly/Monthly)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "88b8bf4f-a772-4e1d-9d4f-b7b01ca33eb5",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25130,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26247,
"item_type": "Extra Duty Allowance",
"name": "Extra Duty Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "fe599587-9807-482f-b535-7be41ae62ec7",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25131,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26248,
"item_type": "Housing/Rental Allowance",
"name": "Housing/ Rental Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "2d7affb9-5087-4f1b-ac05-dfa7e66209a2",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25132,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26249,
"item_type": "Incentive Allowance",
"name": "Incentive Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "5f127c67-da84-4065-907a-b10384cf343d",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25133,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26250,
"item_type": "Meal Allowance",
"name": "Meal Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d83bf2a7-a54c-4424-ac86-52507b64e896",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25134,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26251,
"item_type": "Per Diem Allowance",
"name": "Per Diem Allowance",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "73e2780c-6c9d-4d11-9a53-880b2aff46cd",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25135,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26252,
"item_type": "Transport Allowance",
"name": "Transport Allowance",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b299edf3-b754-415b-bf40-9fd84ff2f919",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25136,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26253,
"item_type": "Tips",
"name": "Tips",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "06c2eb17-3704-4f0f-8461-ee8ffb156b5c",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25137,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26254,
"item_type": "Director fees",
"name": "Director fees",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "63e36a14-8500-4585-ab90-5d292d5d3cd5",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25138,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26255,
"item_type": "Bonus",
"name": "Bonus",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "e55491fb-8a8a-412b-b7be-d513f7cc3d1f",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25139,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26256,
"item_type": "Others",
"name": "Others",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "02a8bf6b-ed94-4ddb-8217-148a31af3b9c",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25140,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26257,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)(no SHG contribution)",
"category": "Recurring",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "d860f714-c703-40f2-a3fe-8176138c578a",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25141,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26258,
"item_type": "Commission",
"name": "Commission (AW)",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "c69bc371-056c-48b1-829c-66d3b3f14598",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25142,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26259,
"item_type": "Medisave",
"name": "Medisave",
"category": "Recurring",
"tax": true,
"gross_net_settings": null,
"proration_enabled": false,
"slug": "4fc321da-3d0f-46bb-bd67-1f0aef5c7e05",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25143,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26260,
"item_type": "Deduction Community Chest",
"name": "Deduction Community Chest",
"category": "Recurring",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "bd2f799a-36a4-4cec-b5c7-7f4906996c00",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25144,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26261,
"item_type": "Reimbursements",
"name": "Reimbursements",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "d9b809d9-7c5e-4ea7-bef6-f84c83ce1c0b",
"is_default": false,
"payslip_display_settings": [
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25145,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26262,
"item_type": "Advance Pay",
"name": "Advance Pay",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "75cc9138-a512-4806-a01b-d8a94dcc40b8",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25146,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26263,
"item_type": "Allowance",
"name": "Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "99c696bc-0f2f-4596-b717-3e7edefed517",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25147,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26264,
"item_type": "Deduction",
"name": "Deduction",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "972dc700-5bf8-44f9-8e71-924300fe0416",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25148,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26265,
"item_type": "Commission",
"name": "Commission (Irregular)",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "184d906d-938f-42f0-b9fd-c7504af66763",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25149,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26266,
"item_type": "Extra Duty Allowance",
"name": "Extra Duty Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "91726bfb-a7c9-47b1-9428-7ed4a875ea2f",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25150,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26267,
"item_type": "Festive Allowance",
"name": "Festive Allowance",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "cdbfc2e1-9ad7-472b-abb3-a86d04bd52f3",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25151,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26268,
"item_type": "Housing/Rental Allowance",
"name": "Housing/ Rental Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "54881260-7985-449e-885a-1bd9da8f98a7",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25152,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26269,
"item_type": "Incentive",
"name": "Incentive",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "4d06e0a9-f363-4267-9c8c-c4014c769079",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25153,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26270,
"item_type": "Incentive Allowance",
"name": "Incentive Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "8bf73e83-adb9-4cf7-97c0-5dde5a1917f1",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25154,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26271,
"item_type": "IR21 Tax Withholding",
"name": "IR21 Tax Withholding",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "6ada1c66-9991-427f-85da-7322a6fdfdf8",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25155,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26272,
"item_type": "Meal Allowance",
"name": "Meal Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f59c4c5e-6e79-4df2-a818-865385c8e043",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25156,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26273,
"item_type": "Per Diem Allowance",
"name": "Per Diem Allowance",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "5f9f939a-902a-4551-b68e-5b099e75b626",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25157,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26274,
"item_type": "Reimbursements",
"name": "Per Diem Reimbursement",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "6d1957e8-2300-43a3-a71f-3b939e2caef5",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25158,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26275,
"item_type": "Transport Allowance",
"name": "Transport Allowance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "dec7d83e-fb28-4a87-839a-3954883e5590",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25159,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26276,
"item_type": "Referral of Employees Fees",
"name": "Referral of Employees Fees",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "7454fdbf-180c-48fc-8f91-fbe778bf784a",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25160,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26277,
"item_type": "Benefits in Kind",
"name": "Benefits in Kind",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "030c5ff9-2c21-455f-a3a3-fe3f25beb5c7",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25161,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26278,
"item_type": "Benefits in Kind",
"name": "Gifts in Kind",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "2fa76777-994b-4fa7-b432-eec6fb8f0d3e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25162,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26279,
"item_type": "Stock Option Sale",
"name": "Share Option Sale",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "d544a3ae-12a7-48c5-8d58-c92ca9be8e6f",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25163,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26280,
"item_type": "Termination Benefits",
"name": "Termination Benefits",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "94da3f0a-24a8-4b1a-ae3e-5298623ef698",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25164,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26281,
"item_type": "Tips",
"name": "Tips",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "7d194446-cc2d-4c9c-b6d2-6a790380d6ff",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25165,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26282,
"item_type": "Annual Wage Supplement",
"name": "Annual Wage Supplement",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "ae0b56f9-76c7-43e8-a7f1-f9fad21c004e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25166,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26283,
"item_type": "Bonus",
"name": "Bonus",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b4b2974a-d1c0-4f7f-9448-cd4cb72f9621",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25167,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26284,
"item_type": "Bonus",
"name": "Prior Year Bonus",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1178c4b3-fd9d-4091-b92d-0e2c47ca8ee2",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25168,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26285,
"item_type": "Annual Wage Supplement",
"name": "Prior Year AWS",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "96fe519b-4033-4bc1-bfbf-e199829578a9",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25169,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26286,
"item_type": "Leave Pay",
"name": "Leave Pay",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "e80a3645-3709-4269-8e63-acf57de6eb6f",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Calculation"
],
"pay_code": null,
"additional_sg_info": {
"id": 25170,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26287,
"item_type": "Director fees",
"name": "Director fees",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "0ab7d297-4099-43d5-be33-e3eb9ea4d3c9",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25171,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26288,
"item_type": "Backdated Salary",
"name": "Backdated Salary Increment",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f81b2ea4-3ea0-4b5b-be8c-ab3ee58f1238",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25172,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26289,
"item_type": "Backdated Salary",
"name": "Backdated Salary",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "3d8c11f7-5154-4c3c-92d3-becf45897b95",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25173,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26290,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "abd4faeb-a187-4e43-a480-34a99b649f89",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25174,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26291,
"item_type": "Others",
"name": "Others",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "b3cadab9-c749-4b58-89aa-f9aeb028ff87",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25175,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26292,
"item_type": "Others",
"name": "Others(no gross)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "d7b9b9e9-db1b-4af2-aa54-0b38ef983add",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25176,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26293,
"item_type": "Salary in Lieu",
"name": "Salary in lieu",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "c7604ba0-8b1e-4c54-9144-a2917a0b4b06",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25177,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26294,
"item_type": "Incentive",
"name": "Onboarding incentive",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "c2fcc6fa-3cb5-4147-83ab-3a34d5c5e670",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25178,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26295,
"item_type": "Gratuity",
"name": "Gratuity paid for years of service",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "3dfaf68c-dc7f-46b4-b1cd-ab10e48e33ef",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25179,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26296,
"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": "64b8eab3-b555-4c5e-95db-3a733fc75050",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25180,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26297,
"item_type": "Deduction",
"name": "Deduction (from Net Salary)(no SHG contribution)",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "e60c2460-47b7-4f26-9cee-24b750305997",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25181,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26298,
"item_type": "Deduction",
"name": "NS Leave Claims Deduction",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "net",
"proration_enabled": false,
"slug": "661386fd-33fd-453c-a07d-1547094eacb6",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25182,
"cpf": false,
"sdl": false,
"shg": false,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26299,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Personal Insurance",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "4034acdc-dc5e-4eb4-852f-477364deb0bb",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25183,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26300,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Optical Expenses",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f6b1b7ed-cf71-4b73-b0a6-7f0b98445c9a",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25184,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26301,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Health Screening & Vaccinations",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "2cf158c6-f7f4-4135-b9ac-33bc1ae20ff3",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25185,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26302,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Childcare / Eldercare Fees For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "bee8e93d-0f3b-470d-a2bb-abe9ffc1ed93",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25186,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26303,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Medical Expenses For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "6861cdfe-8dad-498e-b582-262c124f9575",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25187,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26304,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Dental Expenses For Dependants",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f962bb76-05a5-4405-9382-14ad985d7508",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25188,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26305,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Gym Membership",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "decba644-2ba3-4b15-8150-a82b2205921c",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25189,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26306,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Holiday Expenses",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "3eaa44ef-7ee5-47d3-adb6-495f81728143",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25190,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26307,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit TCM / CHIRO/ PHYSIO",
"category": "Adhoc",
"tax": false,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "9c275c15-e286-415c-a89a-bd67b24088a1",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25191,
"cpf": true,
"sdl": false,
"shg": false,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26308,
"item_type": "Gratuity",
"name": "Gratuity",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "3a714b37-6f2b-42aa-8ffe-4fb8be9739b6",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25192,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26309,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Work From Home",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "97a2c2a0-eac0-41dd-9377-94661987210f",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25193,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26310,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Mental Health Awareness",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "422b7185-f87a-4705-ba30-1d4f6356c435",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25194,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26311,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Personal Planning & Enrichment",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1e0ac52d-ead5-4953-b9f9-6d7b9ef5df09",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25195,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26312,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Home Affairs Support",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "f50adc38-ca4c-4670-8d1a-58e5675d2c0e",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25196,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26313,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Home Family Bonding Facilitation",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "6e9258e2-ec5d-4d0b-bb5d-e4052c10d3c1",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25197,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26314,
"item_type": "Flexi-Benefit",
"name": "Flexi-Benefit Professional Subscription",
"category": "Adhoc",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "0c3089ad-3adc-4b27-a40a-9cd55f777fca",
"is_default": false,
"payslip_display_settings": [
"Item Name",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25198,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26315,
"item_type": "Regular Hours",
"name": "Regular Hours",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "c34cbdf2-55ef-4570-9ce2-656a0295ea8e",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25199,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26316,
"item_type": "Overtime Hours",
"name": "Overtime Hours",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "76e5eb59-ce50-493b-b0f3-0fd9fb6caea4",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25200,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26317,
"item_type": "Regular Days",
"name": "Regular Days",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "94a0aa3e-03ed-4a62-800d-eda4ee7c30f7",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25201,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26318,
"item_type": "Overtime Days",
"name": "Overtime Days",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "afce5617-8465-4f06-8bc7-8c31e8c8ced1",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25202,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26319,
"item_type": "Public Holiday Pay",
"name": "Public Holiday Pay",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "1fef8793-ba1c-4c04-8872-5ed685b569c0",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25203,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26320,
"item_type": "Rest Day Pay",
"name": "Rest Day Pay",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "2a964fd8-1cbc-4dde-adc8-621170dc44eb",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25204,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26321,
"item_type": "Deputy",
"name": "Deputy Awage",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "5d27119a-6aa1-4310-9356-895fe399d6b4",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25205,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "awage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
},
{
"id": 26322,
"item_type": "Deputy",
"name": "Deputy",
"category": "Attendance",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "efd0973e-20c5-4f74-b11d-c66ccf767305",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Calculation",
"Remarks"
],
"pay_code": null,
"additional_sg_info": {
"id": 25206,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": null,
"additional_my_info": null,
"additional_id_info": null
}
]
Update Custom Pay Item
Request
Endpoint
PATCH https://api.talenox.com/api/v2/payroll/custom_pay_items/26407
Accept: application/json
Content-Type: application/json
Authorization: Bearer a28287057fad1c61afe0b62d873db8984b95bae0
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": 26407,
"item_type": "Allowance",
"name": "Basic Pay",
"category": "Recurring",
"tax": true,
"gross_net_settings": "gross",
"proration_enabled": false,
"slug": "27b6d337-a3e2-4a41-b4f5-1067347b88ec",
"is_default": true,
"payslip_display_settings": [
"Item Name",
"Remarks",
"Period"
],
"pay_code": null,
"additional_sg_info": {
"id": 25375,
"cpf": true,
"sdl": true,
"shg": true,
"cpf_owage_awage": "owage"
},
"additional_hk_info": {
"id": 368,
"mpf": true,
"adw": true
},
"additional_my_info": {
"id": 386,
"epf": true,
"socso": true,
"eis": true,
"hrdf": true
},
"additional_id_info": {
"id": 362,
"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 e12e37f3740b58df740ed11166a64fa9ac7bf429
POST https://api.talenox.com/api/v2/roles
Parameters
{
"role": {
"name": "Manager",
"employee_ids": [
1091,
1092,
1093,
1094
]
}
}
| 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": 1090,
"name": "Manager",
"employee_ids": [
1091,
1092,
1093,
1094
],
"no_of_employees": 4
}
Delete Role
Request
Endpoint
DELETE https://api.talenox.com/api/v2/roles/1132
Accept: application/json
Content-Type: application/json
Authorization: Bearer 11c98ef20c2a3f68816fbc6a2a5b86f0ff43a144
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 1132"
}
List Roles
Request
Endpoint
GET https://api.talenox.com/api/v2/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer 63e64b6797878768bc42a25590b34e0230db55b3
GET https://api.talenox.com/api/v2/roles
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 1062,
"name": "photographer",
"employee_ids": [
1078
],
"no_of_employees": 1
},
{
"id": 1063,
"name": "physicist",
"employee_ids": [
1079
],
"no_of_employees": 1
},
{
"id": 1064,
"name": "philosopher",
"employee_ids": [
1080
],
"no_of_employees": 1
},
{
"id": 1065,
"name": "journalist",
"employee_ids": [
1081
],
"no_of_employees": 1
},
{
"id": 1066,
"name": "soldier",
"employee_ids": [
1082
],
"no_of_employees": 1
},
{
"id": 1067,
"name": "politician",
"employee_ids": [
1083
],
"no_of_employees": 1
},
{
"id": 1068,
"name": "traffic warden",
"employee_ids": [
1084
],
"no_of_employees": 1
},
{
"id": 1069,
"name": "fisherman",
"employee_ids": [
1085
],
"no_of_employees": 1
},
{
"id": 1070,
"name": "pilot",
"employee_ids": [
1086
],
"no_of_employees": 1
},
{
"id": 1071,
"name": "factory worker",
"employee_ids": [
1087
],
"no_of_employees": 1
},
{
"id": 1072,
"name": "police officer",
"employee_ids": [
1088
],
"no_of_employees": 1
},
{
"id": 1073,
"name": "owkkdmisuiapwchsgnmsgdvqcbkwvoco",
"employee_ids": [
],
"no_of_employees": 0
},
{
"id": 1074,
"name": "ewmmpbqztjkiezckytghrssozupcucec",
"employee_ids": [
],
"no_of_employees": 0
},
{
"id": 1075,
"name": "Engineer",
"employee_ids": [
1089,
1090
],
"no_of_employees": 2
}
]
Show Role
Request
Endpoint
GET https://api.talenox.com/api/v2/roles/1104
Accept: application/json
Content-Type: application/json
Authorization: Bearer c09b229a48fb8c6420e1648be8e2632a7ceca9d2
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": 1104,
"name": "Engineer",
"employee_ids": [
1115,
1116
],
"no_of_employees": 2
}
Update Role
Request
Endpoint
PUT https://api.talenox.com/api/v2/roles/1118
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1cf858dd5341545d207cc1e6a953b418bcb78724
PUT https://api.talenox.com/api/v2/roles/:id
Parameters
{
"role": {
"name": "New Role Name",
"employee_ids": [
1118,
1119,
1117,
1120
]
}
}
| Name | Description |
|---|---|
| id required | Role ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1118,
"name": "New Role Name",
"employee_ids": [
1118,
1119,
1117,
1120
],
"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 2cec2585a7c919b2e3d885772b50754c8c7f7c78
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "Hong Kong Permanent Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": "",
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"basic_pay_item_attributes": {
"rate_of_pay": "Monthly",
"currency": "SGD",
"amount": 4000
}
},
"bank_account_attributes": {
"bank_type": "DBS",
"bank_code": 1,
"account_name": "Hafsah Haigh",
"number": 131231231231231231,
"branch_code": 1,
"branch_name": "",
"swift_code": "",
"payment_code": 1,
"dbs_company_id": ""
},
"additional_hk_employee_info_attributes": {
"voluntary_employee_contribution": 100,
"voluntary_employer_contribution": 200,
"mpf_scheme": 0,
"mpf_member_account_number": 123123123,
"mpf_enrolled_date": "01/01/2015"
},
"location_attributes": {
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": 12345,
"state": null,
"country_name": "Singapore"
}
}
}
| Name | Description |
|---|---|
| invite_user | If true will create a talenox user for the employee and invite them |
| employee_id | Employee ID |
| first_name required | First name |
| last_name | Last name |
| chinese_name | Chinese name |
| nickname | Nickname |
| identification_full_name | Identification full name |
| email required | Email address |
| hired_date | Hired date |
| confirmation_date | Confirmation date |
| resign_date | Resign date |
| contact_number | Contact number |
| office_did | Office Direct Inward Dialing (DID) Number |
| ssn required | Identification number |
| ssn_should_validate | Should valdate identification number |
| citizenship required | Immigration status |
| nationality | Nationality |
| gender | Gender |
| race | Race |
| religion | Religion |
| marital_status | Marital status |
| birthdate | Birth date |
| passport_number | Passport number |
| passport_date_of_issue | Passport issue date |
| passport_date_of_expiry | Passport expiry date |
| passport_place_of_issue | Passport place of issue |
| vaccination_status | Vaccination status |
| vaccine_brand | Vaccine brand |
| date_of_first_dose | Date of first dose |
| date_of_second_dose | Date of second dose |
| vaccine_booster_brand | Vaccine booster brand |
| date_of_booster_dose | Date of second dose |
| vaccination_remarks | Vaccination remarks |
| payment_method required | Payment type |
| cost_centre_id | Default Cost centre ID (Same as default_cost_centre_id) |
| default_cost_centre_id | Default Cost centre ID (Set the company setting api_allows_employee_multiple_cost_centres to true to avoid resetting employee cost centres when changing default_cost_centre_id value) |
| cost_centre_ids | Cost centre IDs (to assign employee to multiple cost centres) |
| blood_group | Blood group |
| leaving_country | Leaving country |
| employee_attachment_access | Employee attachment access |
| accounting_split | Accounting split |
| employee_can_update_custom_fields | Employee can update custom fields |
| employee_attachment_access | Employee attachment access |
| reason_for_cessation | Reason for cessation |
| other_reason_for_cessation | Other reason for cessation |
| custom_fields | Custom fields |
| current_job_parameters | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| current_job_parameters[basic_pay_item_parameters] | Below are Basic Pay Item related fields |
| current_job_parameters[rate_of_pay] | Rate of pay |
| current_job_parameters[currency] | Currency |
| current_job_parameters[amount] | Basic pay amount |
| bank_account_parameters | Below are Employee's Bank Account related fields |
| bank_type | Bank name |
| bank_code | Bank code |
| account_name | Bank account name |
| number | Bank account number |
| branch_code | Branch code |
| branch_name | Branch name |
| swift_code | Bank swift code |
| payment_code | Payment code (Hang Seng and HSBC only) |
| dbs_company_id | DBS company ID (DBS only) |
| employee_using_cheque | Employee using cheque |
| location_parameters | Below are Employee's Address related fields |
| line_1 | Address line 1 |
| line_2 | Address line 2 |
| postal_code | Postal code |
| state | State |
| country_name | Country name |
| additional_hk_employee_info_parameters | Below are HK Employee's related fields |
| voluntary_employee_contribution_type | MPF Voluntary Employee Additional Contribution Type (["Percentage", "Fixed Amount"]) |
| voluntary_employee_contribution | MPF Voluntary Employee Additional amount (If percentage is chosen, must be one of ["5%", "6%", "7%", "8%", "9%", "10%", "11%", "12%", "13%", "14%", "15%"]) |
| voluntary_employee_contribution_setting | MPF Voluntary Employee Deduction Setting (["Gross Salary", "Net Salary"]) |
| voluntary_employer_contribution_type | MPF Voluntary Employer Additional Contribution Type (["Percentage", "Fixed Amount"]) |
| voluntary_employer_contribution | MPF Voluntary Employer Additional amount (If percentage is chosen, must be one of ["5%", "6%", "7%", "8%", "9%", "10%", "11%", "12%", "13%", "14%", "15%"]) |
| voluntary_employer_contribution_setting | MPF Voluntary Employer Deduction Setting (["Gross Salary", "Net Salary"]) |
| mpf_scheme required | MPF Scheme. 0 => Master trust scheme, 2 => Not contributing MPF |
| mpf_employee_type | MPF employee type (["regular", "casual"]) |
| mpf_member_account_number | MPF account number |
| mpf_enrolled_date | MPF enrolled date |
| identification_expiry_date | Identification expiry date. When you use the API to update this field, we will map to the immigration expiry field. E.g. for IANG, we will map to iang_expiry_date. |
| identification_issue_date | Identification issue date. When you use the API to update this field, we will map to the immigration issue field. E.g. for IANG, we will map to iang_issue_date. |
| non_pr_issue_date | Non PR Issue Date |
| non_pr_expiry_date | Non PR Expiry Date |
| foreigner_issue_date | Foreigner Issue Date |
| foreigner_expiry_date | Foreigner Expiry Date |
| iang_issue_date | IANG Issue Date |
| iang_expiry_date | IANG Expiry Date |
| student_issue_date | Student Issue Date |
| student_expiry_date | Student Expiry Date |
| dependants_issue_date | Dependants Issue Date |
| dependants_expiry_date | Dependants Expiry Date |
| gep_issue_date | GEP Issue Date |
| gep_expiry_date | GEP Expiry Date |
| qmas_issue_date | QMAS Issue Date |
| qmas_expiry_date | QMAS Expiry Date |
| ttps_issue_date | TTPS Issue Date |
| ttps_expiry_date | TTPS Expiry Date |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 792,
"employee_id": "1",
"first_name": "Hafsah",
"middle_name": null,
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "2015-01-01",
"resign_date": null,
"confirmation_date": "2019-01-01",
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": "123456789",
"office_did": null,
"ssn": "S1111111D",
"ssn_should_validate": true,
"citizenship": "Hong Kong Permanent Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "2017-01-01",
"passport_date_of_expiry": "2022-12-01",
"passport_place_of_issue": "Singapore",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "2015-01-01",
"slug": "hafsah-haigh-87f39329",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "2021-01-01",
"date_of_second_dose": "2021-11-01",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "2021-12-01",
"vaccination_remarks": "",
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"cost_centres": [
],
"default_cost_centre": null,
"current_job": {
"id": 48,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 48,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [
],
"bank_account": {
"id": 925,
"bank_type": "DBS",
"bank_code": "1",
"branch_code": "1",
"branch_name": null,
"number": "131231231231231231",
"dbs_company_id": "",
"swift_code": "DHBKHKHH",
"account_name": "Hafsah Haigh",
"payment_code": "1",
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1058,
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": "12345",
"state": null,
"country_name": "Singapore",
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": {
"voluntary_employee_contribution": "100.0",
"voluntary_employer_contribution": "200.0",
"mpf_scheme": "master_trust_scheme",
"mpf_employee_type": "regular",
"mpf_member_account_number": "123123123",
"mpf_enrolled_date": "2015-01-01",
"non_pr_issue_date": null,
"non_pr_expiry_date": null,
"foreigner_issue_date": null,
"foreigner_expiry_date": null,
"iang_issue_date": null,
"iang_expiry_date": null,
"student_issue_date": null,
"student_expiry_date": null,
"dependants_issue_date": null,
"dependants_expiry_date": null,
"voluntary_employer_contribution_type": "Fixed Amount",
"voluntary_employer_contribution_rate": null,
"voluntary_employee_contribution_type": "Fixed Amount",
"voluntary_employee_contribution_rate": null,
"gep_expiry_date": null,
"gep_issue_date": null,
"qmas_issue_date": null,
"qmas_expiry_date": null,
"ttps_issue_date": null,
"ttps_expiry_date": null,
"asmtp_issue_date": null,
"asmtp_expiry_date": null,
"voluntary_employer_contribution_setting": "Gross Salary",
"voluntary_employee_contribution_setting": "Gross Salary"
},
"additional_sg_employee_info": null,
"additional_my_employee_info": null,
"additional_id_employee_info": null
}
Create ID Employee
Request
Endpoint
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer 11f8932bd9b64d0598cba78489d1da08145823d5
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "KTP (Residential Identity Card)",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": "",
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"basic_pay_item_attributes": {
"rate_of_pay": "Monthly",
"currency": "SGD",
"amount": 4000
}
},
"bank_account_attributes": {
"bank_type": "Standard Chartered",
"bank_code": 1,
"account_name": "Hafsah Haigh",
"number": 131231231231231231,
"branch_code": 1,
"branch_name": "",
"swift_code": "",
"payment_code": 1,
"dbs_company_id": ""
},
"additional_id_employee_info_attributes": {
"tax_processing_date": "01/01/2015",
"ptkp": "TK/0",
"npwp": "1234567891234567",
"tax_scheme": "gross",
"previous_past_net": 100,
"previous_past_tax": 100,
"previous_past_net_tax_effective_date": "01/01/2015",
"bpjs_tk_process_date": "01/01/2015",
"bpjs_tk_number": "1234567891234567",
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": "01/01/2015",
"bpjs_kesehatan_number": "1234567891234567",
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": 1,
"bpjs_kesehatan_borne_by_employer": true,
"bpjs_tk_jht_borne_by_employer": true,
"bpjs_jp_borne_by_employer": true,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered"
},
"location_attributes": {
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": 12345,
"state": null,
"country_name": "Singapore"
}
}
}
| Name | Description |
|---|---|
| invite_user | If true will create a talenox user for the employee and invite them |
| employee_id | Employee ID |
| first_name required | First name |
| last_name | Last name |
| chinese_name | Chinese name |
| nickname | Nickname |
| identification_full_name | Identification full name |
| email required | Email address |
| hired_date | Hired date |
| confirmation_date | Confirmation date |
| resign_date | Resign date |
| contact_number | Contact number |
| office_did | Office Direct Inward Dialing (DID) Number |
| ssn required | Identification number |
| ssn_should_validate | Should valdate identification number |
| citizenship required | Immigration status |
| nationality | Nationality |
| gender | Gender |
| race | Race |
| religion | Religion |
| marital_status | Marital status |
| birthdate | Birth date |
| passport_number | Passport number |
| passport_date_of_issue | Passport issue date |
| passport_date_of_expiry | Passport expiry date |
| passport_place_of_issue | Passport place of issue |
| vaccination_status | Vaccination status |
| vaccine_brand | Vaccine brand |
| date_of_first_dose | Date of first dose |
| date_of_second_dose | Date of second dose |
| vaccine_booster_brand | Vaccine booster brand |
| date_of_booster_dose | Date of second dose |
| vaccination_remarks | Vaccination remarks |
| payment_method required | Payment type |
| cost_centre_id | Default Cost centre ID (Same as default_cost_centre_id) |
| default_cost_centre_id | Default Cost centre ID (Set the company setting api_allows_employee_multiple_cost_centres to true to avoid resetting employee cost centres when changing default_cost_centre_id value) |
| cost_centre_ids | Cost centre IDs (to assign employee to multiple cost centres) |
| blood_group | Blood group |
| leaving_country | Leaving country |
| employee_attachment_access | Employee attachment access |
| accounting_split | Accounting split |
| employee_can_update_custom_fields | Employee can update custom fields |
| employee_attachment_access | Employee attachment access |
| reason_for_cessation | Reason for cessation |
| other_reason_for_cessation | Other reason for cessation |
| custom_fields | Custom fields |
| current_job_parameters | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| current_job_parameters[basic_pay_item_parameters] | Below are Basic Pay Item related fields |
| current_job_parameters[rate_of_pay] | Rate of pay |
| current_job_parameters[currency] | Currency |
| current_job_parameters[amount] | Basic pay amount |
| bank_account_parameters | Below are Employee's Bank Account related fields |
| bank_type | Bank name |
| bank_code | Bank code |
| account_name | Bank account name |
| number | Bank account number |
| branch_code | Branch code |
| branch_name | Branch name |
| swift_code | Bank swift code |
| payment_code | Payment code (Hang Seng and HSBC only) |
| dbs_company_id | DBS company ID (DBS only) |
| employee_using_cheque | Employee using cheque |
| location_parameters | Below are Employee's Address related fields |
| line_1 | Address line 1 |
| line_2 | Address line 2 |
| postal_code | Postal code |
| state | State |
| country_name | Country name |
| additional_id_employee_info_parameters | Below are ID Employee's related fields |
| tax_processing_date required | Tax Processing Date |
| ptkp required | PTKP / Tax Deductions Category |
| npwp | NPWP / Tax Identification Number |
| tax_scheme required | Tax Scheme |
| previous_past_net | Previous Past Net |
| previous_past_tax | Previous Past Tax |
| previous_past_net_tax_effective_date | Previous Past Net & Tax Effective Date |
| bpjs_tk_process_date | BPJS TK Process Date |
| bpjs_tk_number | BPJS TK Number |
| bpjs_tk_policy required | BPJS JKK Policy |
| bpjs_tk_jht_borne_by_employer required | BPJS JHT borne by employer |
| bpjs_jp_policy required | BPJS JP Policy |
| bpjs_jp_borne_by_employer required | BPJS JP borne by employer |
| work_accident_insurance_contribution_rate | BPJS JKK Contribution Rate (Required if BPJS JKK Policy is registered) |
| bpjs_jkm_policy required | BPJS JKM Policy |
| bpjs_tk_jht_policy required | BPJS JHT Policy |
| bpjs_kesehatan_process_date | BPJS Kesehatan Process Date |
| bpjs_kesehatan_number | BPJS Kesehatan Number |
| bpjs_kesehatan_policy required | BPJS Kesehatan Policy |
| no_of_bpjs_kesehatan_dependents | BPJS Kesehatan Additional Dependants |
| bpjs_kesehatan_borne_by_employer required | BPJS Kesehatan borne by employer |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 794,
"employee_id": "1",
"first_name": "Hafsah",
"middle_name": null,
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "2015-01-01",
"resign_date": null,
"confirmation_date": "2019-01-01",
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": "123456789",
"office_did": null,
"ssn": "S1111111D",
"ssn_should_validate": true,
"citizenship": "KTP (Residential Identity Card)",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "2017-01-01",
"passport_date_of_expiry": "2022-12-01",
"passport_place_of_issue": "Singapore",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "2015-01-01",
"slug": "hafsah-haigh-2052c486",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "2021-01-01",
"date_of_second_dose": "2021-11-01",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "2021-12-01",
"vaccination_remarks": "",
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"cost_centres": [
],
"default_cost_centre": null,
"current_job": {
"id": 50,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 50,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [
],
"bank_account": {
"id": 935,
"bank_type": "Standard Chartered",
"bank_code": "1",
"branch_code": "1",
"branch_name": null,
"number": "131231231231231231",
"dbs_company_id": "",
"swift_code": "SCBLIDJXXXX",
"account_name": "Hafsah Haigh",
"payment_code": "1",
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1076,
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": "12345",
"state": null,
"country_name": "Singapore",
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": null,
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2015-01-01",
"ptkp": "TK/0",
"npwp": "1234567891234567",
"tax_scheme": "gross",
"previous_past_net": "100.0",
"previous_past_tax": "100.0",
"bpjs_tk_process_date": "2015-01-01",
"bpjs_tk_number": "1234567891234567",
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": "2015-01-01",
"bpjs_kesehatan_number": "1234567891234567",
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": 1,
"bpjs_kesehatan_borne_by_employer": true,
"bpjs_tk_jht_borne_by_employer": true,
"bpjs_jp_borne_by_employer": true,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": "2015-01-01"
}
}
Create MY Employee
Request
Endpoint
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer ef82394c1fec60474594ea46e0880b647db10229
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Married and Spouse Not Working",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": "",
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"basic_pay_item_attributes": {
"rate_of_pay": "Monthly",
"currency": "SGD",
"amount": 4000
}
},
"bank_account_attributes": {
"bank_type": "DBS",
"bank_code": 1,
"account_name": "Hafsah Haigh",
"number": 131231231231231231,
"branch_code": 1,
"branch_name": "",
"swift_code": "",
"payment_code": 1,
"dbs_company_id": ""
},
"additional_my_employee_info_attributes": {
"is_contributing_epf": true,
"epf_number": 123456789,
"employee_epf_setting": "Statutory Default",
"employer_epf_setting": "12%",
"pcb_number": 12312312,
"socso_setting": "Employment Injury Scheme and Invalidity Scheme",
"socso_number": 123123124,
"disabled_individual": false,
"disabled_spouse": false,
"has_eis": true,
"zakat_number": 123123123,
"zakat_amount": 1000,
"accumulated_remuneration_bik_vola": 50.2,
"accumulated_deductions_epf_and_other_funds": 100.9,
"accumulated_deductions_mtd": 700.22,
"accumulated_deductions_zakat_paid": 500.4,
"accumulated_year": 2018,
"accumulated_deductions_medical_treatment_special_needs_or_carer": 50.4,
"accumulated_deductions_father_relief": 2000.9,
"accumulated_deductions_mother_relief": 3020,
"accumulated_deductions_basic_supporting_equipment": 2400,
"accumulated_deductions_higher_education_fees_self": 5090,
"accumulated_deductions_medical_expenses_on_serious_diseases": 1900,
"accumulated_deductions_complete_medical_examination": 990,
"accumulated_deductions_net_deposit_in_sspn": 13123,
"accumulated_deductions_payment_of_alimony_to_former_wife": 500.12,
"accumulated_deductions_contribution_to_private_retirement_schem": 1000.2,
"accumulated_deductions_education_and_medical_insurance": 2000.59,
"accumulated_deductions_interest_on_housing_loan": 290.1,
"accumulated_deductions_tax_deduction_for_lifestyle": 900.5,
"accumulated_deductions_tax_deduction_for_purchase_of_breastfeed": 200,
"accumulated_deductions_tax_deduction_for_fees_paid_to_child_car": 1300,
"noc_under_18_full": 1,
"noc_under_18_half": 2,
"noc_18_above_studying_degree_in_malaysia_full": 3,
"noc_18_above_studying_degree_in_malaysia_half": 4,
"noc_18_above_studying_diploma_in_malaysia_full": 5,
"noc_18_above_studying_diploma_in_malaysia_half": 6,
"noc_18_above_studying_at_least_degree_outside_malaysia_full": 7,
"noc_18_above_studying_at_least_degree_outside_malaysia_half": 8,
"noc_disabled_full": 9,
"noc_disabled_half": 1,
"noc_disabled_studying_at_least_diploma_full": 2,
"noc_disabled_studying_at_least_diploma_half": 2,
"accumulated_month": "September",
"accumulated_month_year": "01/10/2018"
},
"location_attributes": {
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": 12345,
"state": null,
"country_name": "Singapore"
}
}
}
| Name | Description |
|---|---|
| invite_user | If true will create a talenox user for the employee and invite them |
| employee_id | Employee ID |
| first_name required | First name |
| last_name | Last name |
| chinese_name | Chinese name |
| nickname | Nickname |
| identification_full_name | Identification full name |
| email required | Email address |
| hired_date | Hired date |
| confirmation_date | Confirmation date |
| resign_date | Resign date |
| contact_number | Contact number |
| office_did | Office Direct Inward Dialing (DID) Number |
| ssn required | Identification number |
| ssn_should_validate | Should valdate identification number |
| citizenship required | Immigration status |
| nationality | Nationality |
| gender | Gender |
| race | Race |
| religion | Religion |
| marital_status | Marital status |
| birthdate | Birth date |
| passport_number | Passport number |
| passport_date_of_issue | Passport issue date |
| passport_date_of_expiry | Passport expiry date |
| passport_place_of_issue | Passport place of issue |
| vaccination_status | Vaccination status |
| vaccine_brand | Vaccine brand |
| date_of_first_dose | Date of first dose |
| date_of_second_dose | Date of second dose |
| vaccine_booster_brand | Vaccine booster brand |
| date_of_booster_dose | Date of second dose |
| vaccination_remarks | Vaccination remarks |
| payment_method required | Payment type |
| cost_centre_id | Default Cost centre ID (Same as default_cost_centre_id) |
| default_cost_centre_id | Default Cost centre ID (Set the company setting api_allows_employee_multiple_cost_centres to true to avoid resetting employee cost centres when changing default_cost_centre_id value) |
| cost_centre_ids | Cost centre IDs (to assign employee to multiple cost centres) |
| blood_group | Blood group |
| leaving_country | Leaving country |
| employee_attachment_access | Employee attachment access |
| accounting_split | Accounting split |
| employee_can_update_custom_fields | Employee can update custom fields |
| employee_attachment_access | Employee attachment access |
| reason_for_cessation | Reason for cessation |
| other_reason_for_cessation | Other reason for cessation |
| custom_fields | Custom fields |
| current_job_parameters | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| current_job_parameters[basic_pay_item_parameters] | Below are Basic Pay Item related fields |
| current_job_parameters[rate_of_pay] | Rate of pay |
| current_job_parameters[currency] | Currency |
| current_job_parameters[amount] | Basic pay amount |
| bank_account_parameters | Below are Employee's Bank Account related fields |
| bank_type | Bank name |
| bank_code | Bank code |
| account_name | Bank account name |
| number | Bank account number |
| branch_code | Branch code |
| branch_name | Branch name |
| swift_code | Bank swift code |
| payment_code | Payment code (Hang Seng and HSBC only) |
| dbs_company_id | DBS company ID (DBS only) |
| employee_using_cheque | Employee using cheque |
| location_parameters | Below are Employee's Address related fields |
| line_1 | Address line 1 |
| line_2 | Address line 2 |
| postal_code | Postal code |
| state | State |
| country_name | Country name |
| additional_my_employee_info_parameters | Below are MY Employee's related fields |
| is_contributing_epf | Is employee contributing to EPF (For Malaysia employee) |
| epf_number | EPF number |
| employee_epf_setting | Employee EPF setting |
| employer_epf_setting | Employer EPF setting |
| pcb_number | PCB number |
| socso_setting | SOCSO setting |
| socso_number | SOCSO number |
| disabled_individual | Is Disabled individual |
| disabled_spouse | Is Disabled spouse |
| pcb_borne_by_employer | Pcb borne by employer |
| has_eis | Has EIS |
| zakat_number | Zakat Number |
| zakat_amount | Zakat Amount |
| is_contributing_hrdf | Contribute HRDF? (For Malaysia employee) |
| accumulated_remuneration_bik_vola | Accumulated remuneration/Benefit-In-Kind (BIK)/Value Of Living Accomodation (VOLA) |
| accumulated_deductions_epf_and_other_funds | Accumulated EPF and Other Approved Funds [include life premium insurance] |
| accumulated_deductions_mtd | Accumulated MTD paid (including MTD on additional remuneration) |
| accumulated_deductions_zakat_paid | Accumulated Zakat paid |
| accumulated_deductions_medical_treatment_special_needs_or_carer | Accumulated Medical expenses for own parents, special need and parent care |
| accumulated_deductions_father_relief | Accumulated Father Relief |
| accumulated_deductions_mother_relief | Accumulated Mother Relief |
| accumulated_deductions_basic_supporting_equipment | Accumulated Basic supporting equipment for disabled self, spouse, child or parent |
| accumulated_deductions_higher_education_fees_self | Accumulated Education fees |
| accumulated_deductions_medical_expenses_on_serious_diseases | Accumulated Medical expenses on serious diseases for self, spouse or child |
| accumulated_deductions_complete_medical_examination | Accumulated Complete medical examination for self, spouse or child |
| accumulated_deductions_net_deposit_in_sspn | Accumulated Net deposit in Skim Simpanan Pendidikan Nasional (SSPN) |
| accumulated_deductions_payment_of_alimony_to_former_wife | Accumulated Payment of alimony to former wife |
| accumulated_deductions_contribution_to_private_retirement_schem | Accumulated Deferred annuity premium or contribution to Private Retriement Scheme |
| accumulated_deductions_education_and_medical_insurance | Accumulated Education and medical insurance premium |
| accumulated_deductions_interest_on_housing_loan | Accumulated Interest on Housing Loan |
| accumulated_deductions_tax_deduction_for_lifestyle | Accumulated Purchase of readings, computer, smartphone, tablet, sport equipment, gymnasium membership and subscription of broadband internet |
| accumulated_deductions_tax_deduction_for_purchase_of_breastfeed | Accumulated Purchase of Breastfeeding Equipment(deduction is allowed once every 2 years for women tax payer only) |
| accumulated_deductions_tax_deduction_for_fees_paid_to_child_car | Accumulated Fees paid to Child Care Centre and Kindergartens |
| accumulated_deductions_socso_payment | Accumulated SOCSO Contribution |
| accumulated_deductions_life_insurance_for_retired_civil_servant | Accumulated life insurance for retired civil servant |
| accumulated_deductions_life_insurance_for_other_than_retired_ci | Accumulated life insurance for other than retired civil servant |
| accumulated_deductions_sports_equipment_rental_registration_fee | Accumulated sports equipment for sports activities |
| accumulated_deductions_purchase_of_personal_computer_smartphone | Accumulated purchase of personal computer, smartphone or tablet |
| accumulated_deductions_fee_at_registered_premises_and_tourist_a | Accumulated accommodation fee at the accommodation premises registered |
| accumulated_deductions_expenses_on_electric_vehicle_charging_fa | Accumulated expenses on Electric Vehicle Charging Facilities and equipment |
| noc_under_18_full | Eligible children full deduction(RM2000 each) |
| noc_under_18_half | Eligible children half deduction(RM2000 each) |
| noc_18_above_studying_degree_in_malaysia_full | Above 18 years and studying full time in Degree level onwards (inside Malaysia) (Full deduction) |
| noc_18_above_studying_degree_in_malaysia_half | Above 18 years and studying full time in Degree level onwards (inside Malaysia) (Half deduction) |
| noc_18_above_studying_diploma_in_malaysia_full | Above 18 years and studying full time in diploma level onwards (inside Malaysia) (Full deduction) |
| noc_18_above_studying_diploma_in_malaysia_half | Above 18 years and studying full time in diploma level onwards (inside Malaysia) (Half deduction) |
| noc_18_above_studying_at_least_degree_outside_malaysia_full | Above 18 years and studying full time in Degree level onwards (outside Malaysia) (Full deduction) |
| noc_18_above_studying_at_least_degree_outside_malaysia_half | Above 18 years and studying full time in Degree level onwards (outside Malaysia) (Half deduction) |
| noc_disabled_full | Disabled children (Full deduction) |
| noc_disabled_half | Disabled children (Half deduction) |
| noc_disabled_studying_at_least_diploma_full | Disabled child studying in diploma or higher level (in Malaysia)/degree or its equivalent (outside Malaysia) |
| noc_disabled_studying_at_least_diploma_half | Disabled child studying in diploma or higher level (in Malaysia)/degree or its equivalent (outside Malaysia) |
| accumulated_month | Accumulated month |
| accumulated_year | Accumulated year |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 793,
"employee_id": "1",
"first_name": "Hafsah",
"middle_name": null,
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "2015-01-01",
"resign_date": null,
"confirmation_date": "2019-01-01",
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": "123456789",
"office_did": null,
"ssn": "S1111111D",
"ssn_should_validate": true,
"citizenship": "Resident",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Married and Spouse Not Working",
"passport_number": "MA123456",
"passport_date_of_issue": "2017-01-01",
"passport_date_of_expiry": "2022-12-01",
"passport_place_of_issue": "Singapore",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "2015-01-01",
"slug": "hafsah-haigh-b2986406",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "2021-01-01",
"date_of_second_dose": "2021-11-01",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "2021-12-01",
"vaccination_remarks": "",
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"cost_centres": [
],
"default_cost_centre": null,
"current_job": {
"id": 49,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 49,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [
],
"bank_account": {
"id": 930,
"bank_type": "DBS",
"bank_code": "1",
"branch_code": "1",
"branch_name": null,
"number": "131231231231231231",
"dbs_company_id": "",
"swift_code": "DBSSMY2A",
"account_name": "Hafsah Haigh",
"payment_code": "1",
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1067,
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": "12345",
"state": null,
"country_name": "Singapore",
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": null,
"additional_my_employee_info": {
"is_contributing_epf": true,
"epf_number": "123456789",
"employee_epf_setting": "Statutory Default",
"employer_epf_setting": "12%",
"pcb_number": "12312312",
"socso_setting": "Employment Injury Scheme and Invalidity Scheme",
"socso_number": "123123124",
"citizenship": "Resident",
"disabled_individual": false,
"disabled_spouse": false,
"pcb_borne_by_employer": false,
"has_eis": true,
"zakat_number": "123123123",
"is_contributing_hrdf": true,
"zakat_amount": "1000.0",
"accumulated_remuneration_bik_vola": "50.2",
"accumulated_deductions_epf_and_other_funds": "100.9",
"accumulated_deductions_mtd": "700.22",
"accumulated_deductions_zakat_paid": "500.4",
"accumulated_year": "2018",
"accumulated_deductions_socso_payment": "0.0",
"accumulated_deductions_medical_treatment_special_needs_or_carer": "50.4",
"accumulated_deductions_father_relief": "2000.9",
"accumulated_deductions_mother_relief": "3020.0",
"accumulated_deductions_basic_supporting_equipment": "2400.0",
"accumulated_deductions_higher_education_fees_self": "5090.0",
"accumulated_deductions_medical_expenses_on_serious_diseases": "1900.0",
"accumulated_deductions_complete_medical_examination": "990.0",
"accumulated_deductions_net_deposit_in_sspn": "13123.0",
"accumulated_deductions_payment_of_alimony_to_former_wife": "500.12",
"accumulated_deductions_contribution_to_private_retirement_schem": "1000.2",
"accumulated_deductions_education_and_medical_insurance": "2000.59",
"accumulated_deductions_interest_on_housing_loan": "290.1",
"accumulated_deductions_tax_deduction_for_lifestyle": "900.5",
"accumulated_deductions_tax_deduction_for_purchase_of_breastfeed": "200.0",
"accumulated_deductions_tax_deduction_for_fees_paid_to_child_car": "1300.0",
"accumulated_deductions_skills_improvement_self_improvement_cour": "0.0",
"accumulated_deductions_vaccination_expenses": "0.0",
"accumulated_deductions_sports_equipment_rental_registration_fee": "0.0",
"accumulated_deductions_purchase_of_personal_computer_smartphone": "0.0",
"accumulated_deductions_fee_at_registered_premises_and_tourist_a": "0.0",
"accumulated_deductions_expenses_on_electric_vehicle_charging_fa": "0.0",
"noc_under_18_full": 1,
"noc_under_18_half": 2,
"noc_18_above_studying_degree_in_malaysia_full": 3,
"noc_18_above_studying_degree_in_malaysia_half": 4,
"noc_18_above_studying_diploma_in_malaysia_full": 5,
"noc_18_above_studying_diploma_in_malaysia_half": 6,
"noc_18_above_studying_at_least_degree_outside_malaysia_full": 7,
"noc_18_above_studying_at_least_degree_outside_malaysia_half": 8,
"noc_disabled_full": 9,
"noc_disabled_half": 1,
"noc_disabled_studying_at_least_diploma_full": 2,
"noc_disabled_studying_at_least_diploma_half": 2,
"accumulated_month": "September",
"accumulated_month_year": "2018-09-01",
"accumulated_deductions_life_insurance_for_retired_civil_servant": "0.0",
"accumulated_deductions_life_insurance_for_other_than_retired_ci": "0.0",
"socso_first_contribution_month_year": null
},
"additional_id_employee_info": null
}
Create SG Employee
Request
Endpoint
POST https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer b9541fa98e1690708d42900c392d06fb4bae0a7e
POST https://api.talenox.com/api/v2/employees
Parameters
{
"invite_user": true,
"employee": {
"employee_id": 1,
"first_name": "Hafsah",
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "1/1/2015",
"contact_number": 123456789,
"ssn": "S1111111D",
"citizenship": "S Pass",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "01/01/2017",
"passport_date_of_expiry": "01/12/2022",
"passport_place_of_issue": "Singapore",
"vaccination_status": "Fully Vaccinated",
"vaccine_brand": "Pfizer-BioNTech",
"date_of_first_dose": "01/01/2021",
"date_of_second_dose": "01/11/2021",
"vaccine_booster_brand": "Pfizer-BioNTech",
"date_of_booster_dose": "01/12/2021",
"vaccination_remarks": "",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "01/01/2015",
"confirmation_date": "01/01/2019",
"default_cost_centre_id": 12,
"custom_fields": {
"Education": {
"CGPA": "4.00",
"University": "Example University"
}
},
"current_job_attributes": {
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"basic_pay_item_attributes": {
"rate_of_pay": "Monthly",
"currency": "SGD",
"amount": 4000
}
},
"bank_account_attributes": {
"bank_type": "DBS",
"bank_code": 1,
"account_name": "Hafsah Haigh",
"number": 131231231231231231,
"branch_code": 1,
"branch_name": "",
"swift_code": "",
"payment_code": 1,
"dbs_company_id": ""
},
"additional_sg_employee_info_attributes": {
"cpf_donation_type": "N/A",
"cpf_additional_donation_type": "N/A",
"identification_issue_date": "",
"identification_expiry_date": "",
"spass_expiry_date": "01/01/2022",
"spass_issue_date": "01/01/2015",
"spass_dcs": "",
"epass_expiry_date": "",
"epass_issue_date": "",
"pr_status": "",
"pr_effective_date": "",
"pr_expiry_date": "",
"pepass_issue_date": "",
"pepass_expiry_date": "",
"wp_issue_date": "",
"wp_expiry_date": "",
"wp_worker_category": "",
"wp_dcs": "",
"wp_number": "",
"shg_override_amount": 0,
"letter_of_consent_issue_date": "",
"letter_of_consent_expiry_date": "",
"halal_certification_issue_date": "",
"halal_certification_expiry_date": "",
"hygiene_certification_issue_date": "",
"hygiene_certification_expiry_date": ""
},
"location_attributes": {
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": 12345,
"state": null,
"country_name": "Singapore"
},
"cost_centre_ids": [
12,
13
]
}
}
| Name | Description |
|---|---|
| invite_user | If true will create a talenox user for the employee and invite them |
| employee_id | Employee ID |
| first_name required | First name |
| last_name | Last name |
| chinese_name | Chinese name |
| nickname | Nickname |
| identification_full_name | Identification full name |
| email required | Email address |
| hired_date | Hired date |
| confirmation_date | Confirmation date |
| resign_date | Resign date |
| contact_number | Contact number |
| office_did | Office Direct Inward Dialing (DID) Number |
| ssn required | Identification number |
| ssn_should_validate | Should valdate identification number |
| citizenship required | Immigration status |
| nationality | Nationality |
| gender | Gender |
| race | Race |
| religion | Religion |
| marital_status | Marital status |
| birthdate | Birth date |
| passport_number | Passport number |
| passport_date_of_issue | Passport issue date |
| passport_date_of_expiry | Passport expiry date |
| passport_place_of_issue | Passport place of issue |
| vaccination_status | Vaccination status |
| vaccine_brand | Vaccine brand |
| date_of_first_dose | Date of first dose |
| date_of_second_dose | Date of second dose |
| vaccine_booster_brand | Vaccine booster brand |
| date_of_booster_dose | Date of second dose |
| vaccination_remarks | Vaccination remarks |
| payment_method required | Payment type |
| cost_centre_id | Default Cost centre ID (Same as default_cost_centre_id) |
| default_cost_centre_id | Default Cost centre ID (Set the company setting api_allows_employee_multiple_cost_centres to true to avoid resetting employee cost centres when changing default_cost_centre_id value) |
| cost_centre_ids | Cost centre IDs (to assign employee to multiple cost centres) |
| blood_group | Blood group |
| leaving_country | Leaving country |
| employee_attachment_access | Employee attachment access |
| accounting_split | Accounting split |
| employee_can_update_custom_fields | Employee can update custom fields |
| employee_attachment_access | Employee attachment access |
| reason_for_cessation | Reason for cessation |
| other_reason_for_cessation | Other reason for cessation |
| custom_fields | Custom fields |
| current_job_parameters | Below are Employee's Job related fields |
| title | Job title |
| department | Department |
| start_date | Job start date |
| end_date | Job end date |
| remarks | Remarks |
| current_job_parameters[basic_pay_item_parameters] | Below are Basic Pay Item related fields |
| current_job_parameters[rate_of_pay] | Rate of pay |
| current_job_parameters[currency] | Currency |
| current_job_parameters[amount] | Basic pay amount |
| bank_account_parameters | Below are Employee's Bank Account related fields |
| bank_type | Bank name |
| bank_code | Bank code |
| account_name | Bank account name |
| number | Bank account number |
| branch_code | Branch code |
| branch_name | Branch name |
| swift_code | Bank swift code |
| payment_code | Payment code (Hang Seng and HSBC only) |
| dbs_company_id | DBS company ID (DBS only) |
| employee_using_cheque | Employee using cheque |
| location_parameters | Below are Employee's Address related fields |
| line_1 | Address line 1 |
| line_2 | Address line 2 |
| postal_code | Postal code |
| state | State |
| country_name | Country name |
| additional_sg_employee_info_parameters | Below are SG Employee's related fields |
| cpf_donation_type | SHG donation type |
| cpf_additional_donation_type | Additional SHG donation type |
| identification_expiry_date | Identification expiry date. When you use the API to update this field, we will map to the immigration expiry field. E.g. for Spass holders, we will map to spass_expiry_date. |
| identification_issue_date | Identification issue date. When you use the API to update this field, we will map to the immigration issue field. E.g. for Spass holders, we will map to spass_issue_date. |
| spass_expiry_date | S Pass expiry date |
| spass_issue_date | S Pass issue date |
| spass_dcs | S Pass Dependency Ceiling |
| epass_number | E Pass Number |
| epass_expiry_date | E Pass expiry date |
| epass_issue_date | E Pass issue date |
| pr_status | PR status |
| pr_effective_date | PR effective date |
| pr_expiry_date | PR expiry date |
| pepass_issue_date | PE Pass issue date |
| pepass_expiry_date | PE Pass expiry date |
| wp_expiry_date | Work Pass expiry date |
| wp_issue_date | Work Pass issue date |
| techpass_expiry_date | Tech Pass expiry date |
| techpass_issue_date | Tech Pass issue date |
| onepass_expiry_date | ONE Pass expiry date |
| onepass_issue_date | ONE Pass issue date |
| wp_worker_category | Work Pass worker category |
| wp_dcs | Work Pass dependency ceiling |
| wp_number | Work Pass Number |
| shg_automation_enabled | Infer SHG contribution fields from ["citizenship", "race", "religion"]. If passed true, you can omit both cpf_donation_type and cpf_additional_donation_type fields. If unable to determine, object will fail to save |
| shg_contribution_amount_option | SHG contribution amount option (["statutory_default", "custom_shg_amount"]) |
| shg_override_amount | Special cases where SHG needs to be overriden with CPF approval |
| letter_of_consent_expiry_date | Letter of consent expiry date |
| letter_of_consent_issue_date | Letter of consent issue date |
| halal_certification_issue_date | Halal certification issue date |
| halal_certification_expiry_date | Halal certification expiry date |
| hygiene_certification_issue_date | Hygiene certification issue date |
| hygiene_certification_expiry_date | Hygiene certification expiry date |
| additional_shg_contribution_amount_option | Additional SHG contribution amount option (["statutory_default", "custom_shg_amount"]) |
| additional_shg_override_amount | Additional SHG override amount |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 791,
"employee_id": "1",
"first_name": "Hafsah",
"middle_name": null,
"last_name": "Haigh",
"identification_full_name": "Hafsah Haigh",
"email": "test@gmail.com",
"payment_method": "Bank Transfer",
"hired_date": "2015-01-01",
"resign_date": null,
"confirmation_date": "2019-01-01",
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": "123456789",
"office_did": null,
"ssn": "S1111111D",
"ssn_should_validate": true,
"citizenship": "S Pass",
"nationality": "Chinese",
"gender": "Male",
"marital_status": "Single",
"passport_number": "MA123456",
"passport_date_of_issue": "2017-01-01",
"passport_date_of_expiry": "2022-12-01",
"passport_place_of_issue": "Singapore",
"chinese_name": "Xing Zexi",
"nickname": "Jerry",
"birthdate": "2015-01-01",
"slug": "hafsah-haigh-63571f66",
"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": "Dooley Corner",
"employee_ids": [
791
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null
},
{
"id": 13,
"name": "Labadie Estate",
"employee_ids": [
791
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null
}
],
"default_cost_centre": {
"id": 12,
"name": "Dooley Corner",
"employee_ids": [
791
],
"no_of_employees": 1,
"enable_custom_cpf_csn": null,
"custom_cpf_csn": null
},
"current_job": {
"id": 47,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 47,
"title": "Front-end Engineer",
"department": "Engineer",
"start_date": "01/01/2015",
"end_date": null,
"remarks": null,
"amount": "4000.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [
],
"bank_account": {
"id": 920,
"bank_type": "DBS",
"bank_code": "1",
"branch_code": "1",
"branch_name": null,
"number": "131231231231231231",
"dbs_company_id": "",
"swift_code": "DBSSSGSGXXX",
"account_name": "Hafsah Haigh",
"payment_code": "1",
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1049,
"line_1": "Address Line 1",
"line_2": "Address Line 2",
"postal_code": "12345",
"state": null,
"country_name": "Singapore",
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "N/A",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": "2022-01-01",
"identification_issue_date": "2015-01-01",
"spass_expiry_date": "2022-01-01",
"spass_issue_date": "2015-01-01",
"spass_dcs": "",
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "",
"pr_effective_date": null,
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": "",
"wp_dcs": "",
"wp_number": "",
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": null
}
Delete Employee
Request
Endpoint
DELETE https://api.talenox.com/api/v2/employees/806
Accept: application/json
Content-Type: application/json
Authorization: Bearer 811090598b069ef94da07646c4be37129d9b1cfc
DELETE https://api.talenox.com/api/v2/employees/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted employee 00001"
}
Get Employee
Request
Endpoint
GET https://api.talenox.com/api/v2/employees/801
Accept: application/json
Content-Type: application/json
Authorization: Bearer fbd4ff4e00267fe1fb0fd23e813314c3ff7ace4f
GET https://api.talenox.com/api/v2/employees/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 801,
"employee_id": "00001",
"first_name": "Laronda",
"middle_name": null,
"last_name": "Haag",
"identification_full_name": null,
"email": "seth@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2023-01-04",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "Female",
"marital_status": null,
"passport_number": null,
"passport_date_of_issue": null,
"passport_date_of_expiry": null,
"passport_place_of_issue": null,
"chinese_name": null,
"nickname": null,
"birthdate": "1982-08-16",
"slug": "laronda-haag-8794d98b",
"vaccination_status": null,
"vaccine_brand": null,
"date_of_first_dose": null,
"date_of_second_dose": null,
"vaccine_booster_brand": null,
"date_of_booster_dose": null,
"vaccination_remarks": null,
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
},
"cost_centres": [
],
"default_cost_centre": null,
"current_job": null,
"jobs": [
],
"next_of_kins": [
],
"bank_account": {
"id": 952,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Laronda Haag",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1103,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-08-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2023-01-04",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
}
List All Employees
Request
Endpoint
GET https://api.talenox.com/api/v2/employees
Accept: application/json
Content-Type: application/json
Authorization: Bearer 18ff24ce27478322740fdbb7e5064e910b81d232
GET https://api.talenox.com/api/v2/employees
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 795,
"employee_id": "00001",
"first_name": "Isabel",
"middle_name": null,
"last_name": "Zulauf",
"identification_full_name": null,
"email": "kathlyn.auer@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2023-11-04",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "Female",
"marital_status": null,
"passport_number": null,
"passport_date_of_issue": null,
"passport_date_of_expiry": null,
"passport_place_of_issue": null,
"chinese_name": null,
"nickname": null,
"birthdate": "1998-08-16",
"slug": "isabel-zulauf-a3ec7bc3",
"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": "04/11/2023",
"end_date": null,
"remarks": null,
"amount": "8871.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
},
"jobs": [
{
"id": 51,
"title": "Title1",
"department": null,
"start_date": "04/11/2023",
"end_date": null,
"remarks": null,
"amount": "8871.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
],
"next_of_kins": [
],
"bank_account": {
"id": 938,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Isabel Zulauf",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1081,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-08-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2023-11-04",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
},
{
"id": 796,
"employee_id": "00002",
"first_name": "Whitley",
"middle_name": null,
"last_name": "Ratke",
"identification_full_name": null,
"email": "avery@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2023-08-26",
"resign_date": null,
"confirmation_date": null,
"leaving_country": false,
"race": null,
"religion": null,
"blood_group": null,
"contact_number": null,
"office_did": null,
"ssn": "S1234567D",
"ssn_should_validate": true,
"citizenship": "Singapore Citizen",
"nationality": null,
"gender": "Male",
"marital_status": null,
"passport_number": null,
"passport_date_of_issue": null,
"passport_date_of_expiry": null,
"passport_place_of_issue": null,
"chinese_name": null,
"nickname": null,
"birthdate": "1998-08-16",
"slug": "whitley-ratke-805b9644",
"vaccination_status": null,
"vaccine_brand": null,
"date_of_first_dose": null,
"date_of_second_dose": null,
"vaccine_booster_brand": null,
"date_of_booster_dose": null,
"vaccination_remarks": null,
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
},
"cost_centres": [
],
"default_cost_centre": null,
"current_job": null,
"jobs": [
],
"next_of_kins": [
],
"bank_account": {
"id": 940,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Whitley Ratke",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1084,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-08-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2023-08-26",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
},
{
"id": 797,
"employee_id": "00003",
"first_name": "Cliff",
"middle_name": null,
"last_name": "Wiegand",
"identification_full_name": null,
"email": "myrtis@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2023-01-30",
"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": "2003-08-16",
"slug": "cliff-wiegand-a4f784de",
"vaccination_status": null,
"vaccine_brand": null,
"date_of_first_dose": null,
"date_of_second_dose": null,
"vaccine_booster_brand": null,
"date_of_booster_dose": null,
"vaccination_remarks": null,
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
},
"cost_centres": [
],
"default_cost_centre": null,
"current_job": null,
"jobs": [
],
"next_of_kins": [
],
"bank_account": {
"id": 942,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Cliff Wiegand",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1087,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-08-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2023-01-30",
"ptkp": "TK/0",
"npwp": null,
"tax_scheme": "gross",
"previous_past_net": null,
"previous_past_tax": null,
"bpjs_tk_process_date": null,
"bpjs_tk_number": null,
"bpjs_tk_policy": "registered",
"work_accident_insurance_contribution_rate": "0.24%",
"bpjs_kesehatan_process_date": null,
"bpjs_kesehatan_number": null,
"bpjs_kesehatan_policy": "registered",
"no_of_bpjs_kesehatan_dependents": null,
"bpjs_kesehatan_borne_by_employer": false,
"bpjs_tk_jht_borne_by_employer": false,
"bpjs_jp_borne_by_employer": false,
"bpjs_jkm_policy": "registered",
"bpjs_jp_policy": "registered",
"bpjs_tk_jht_policy": "registered",
"previous_past_net_tax_effective_date": null
}
}
]
Update Employee
Request
Endpoint
PUT https://api.talenox.com/api/v2/employees/803
Accept: application/json
Content-Type: application/json
Authorization: Bearer b74fbce0ba87f4f3cbe80a9d9991a3b5691498b0
PUT https://api.talenox.com/api/v2/employees/:id
Parameters
{
"employee": {
"first_name": "Mary",
"last_name": "Lan"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 803,
"employee_id": "00001",
"first_name": "Mary",
"middle_name": null,
"last_name": "Lan",
"identification_full_name": null,
"email": "dallas@talenox.com",
"payment_method": "Bank Transfer",
"hired_date": "2023-07-30",
"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": "1998-08-16",
"slug": "mary-lan-29bab5fb",
"vaccination_status": null,
"vaccine_brand": null,
"date_of_first_dose": null,
"date_of_second_dose": null,
"vaccine_booster_brand": null,
"date_of_booster_dose": null,
"vaccination_remarks": null,
"employee_attachment_access": "hidden",
"accounting_split": "employee",
"employee_can_update_custom_fields": false,
"reason_for_cessation": null,
"other_reason_for_cessation": null,
"custom_fields": {
},
"cost_centres": [
],
"default_cost_centre": null,
"current_job": null,
"jobs": [
],
"next_of_kins": [
],
"bank_account": {
"id": 958,
"bank_type": null,
"bank_code": null,
"branch_code": null,
"branch_name": null,
"number": null,
"dbs_company_id": null,
"swift_code": null,
"account_name": "Rosalinda Rolfson",
"payment_code": null,
"bnm_code": "",
"organization_code": "",
"boa_company_id": null,
"boa_eft_key": null,
"hsbc_account": "standalone_account",
"hsbc_account_type": null
},
"location": {
"id": 1113,
"line_1": null,
"line_2": null,
"postal_code": null,
"state": null,
"country_name": null,
"block_house_no": null,
"street_name": null,
"level_no": null,
"unit_no": null,
"line_3": null
},
"additional_hk_employee_info": null,
"additional_sg_employee_info": {
"cpf_donation_type": "CDAC",
"cpf_additional_donation_type": "N/A",
"identification_expiry_date": null,
"identification_issue_date": null,
"spass_expiry_date": null,
"spass_issue_date": null,
"spass_dcs": null,
"epass_expiry_date": null,
"epass_issue_date": null,
"pr_status": "Graduated",
"pr_effective_date": "2024-08-16",
"pr_expiry_date": null,
"wp_issue_date": null,
"wp_expiry_date": null,
"wp_worker_category": null,
"wp_dcs": null,
"wp_number": null,
"shg_override_amount": "0.0",
"letter_of_consent_issue_date": null,
"letter_of_consent_expiry_date": null,
"pepass_issue_date": null,
"pepass_expiry_date": null,
"halal_certification_issue_date": null,
"halal_certification_expiry_date": null,
"hygiene_certification_issue_date": null,
"hygiene_certification_expiry_date": null
},
"additional_my_employee_info": null,
"additional_id_employee_info": {
"tax_processing_date": "2023-07-30",
"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 a6292beaefb8a10ee24fbebad5321347f5432f25
POST https://api.talenox.com/api/v2/jobs
Parameters
{
"title": "",
"employee_id": 838,
"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": 59,
"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/65
Accept: application/json
Content-Type: application/json
Authorization: Bearer 00ebbee12e47ed62928ebf6270ebc12ce9afe2dc
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 65"
}
Get Job
Request
Endpoint
GET https://api.talenox.com/api/v2/jobs/62
Accept: application/json
Content-Type: application/json
Authorization: Bearer a94875e6b639f29d954290b9a25e9136babbb8f1
GET https://api.talenox.com/api/v2/jobs/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 62,
"title": "Title1",
"department": null,
"start_date": "16/08/2024",
"end_date": null,
"remarks": null,
"amount": "2777.0",
"rate_of_pay": "Monthly",
"currency": "SGD"
}
Update Job
Request
Endpoint
PUT https://api.talenox.com/api/v2/jobs/63
Accept: application/json
Content-Type: application/json
Authorization: Bearer 322c8cd40c7c60f55385228b9eb3409f204ca85e
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": 63,
"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[]=999
Accept: application/json
Content-Type: application/json
Authorization: Bearer c15248ef3cf6f6ceba109a07401a303c8dcfdf88
GET https://api.talenox.com/api/v2/leave?
Parameters
?employee_ids: ["999"]
| Name | Description |
|---|---|
| employee_ids required | Employee IDs |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 45,
"leave_type": "Annual Leave",
"company_id": 308,
"employee_id": 999,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2024-08-16",
"start_date_which_half": "AM",
"end_at": "2024-08-16",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2024-08-16",
"leave_duration_type": "All Day",
"derived_duration_qty": 1
}
],
"number_of_levels": 1,
"approvers": [
],
"admin_approver": null
},
{
"id": 46,
"leave_type": "Annual Leave",
"company_id": 308,
"employee_id": 999,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2024-08-16",
"start_date_which_half": "AM",
"end_at": "2024-08-16",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2024-08-16",
"leave_duration_type": "All Day",
"derived_duration_qty": 1
}
],
"number_of_levels": 1,
"approvers": [
],
"admin_approver": null
},
{
"id": 47,
"leave_type": "Annual Leave",
"company_id": 308,
"employee_id": 999,
"amount_type": "day",
"amount": "1.0",
"remarks": null,
"total_non_working_days": "0.0",
"start_at": "2024-08-16",
"start_date_which_half": "AM",
"end_at": "2024-08-16",
"end_date_which_half": "PM",
"is_single_day": true,
"status": "pending",
"derived_duration_listing": [
{
"working_day_type": "Working Full Day",
"date": "2024-08-16",
"leave_duration_type": "All Day",
"derived_duration_qty": 1
}
],
"number_of_levels": 1,
"approvers": [
],
"admin_approver": null
}
]
Leave Applications (BETA)
Approve leave
This approves a pending leave application
Request
Endpoint
PATCH https://api.talenox.com/api/v2/leave_beta/applications/approve/21
Accept: application/json
Content-Type: application/json
Authorization: Bearer vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
PATCH https://api.talenox.com/api/v2/leave_beta/applications/approve/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 21,
"timestamp": "2024-08-16T16:14:39.196+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 vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
POST https://api.talenox.com/api/v2/leave_beta/applications
Parameters
{
"employee_id": 922,
"category_id": 51,
"category": "type",
"start_date": "2024-08-05",
"end_date": "2024-08-05",
"remarks": "test",
"working_days": [
{
"date": "2024-08-05",
"type": "full_day"
}
],
"applied_durations": [
{
"date": "2024-08-05",
"type": "full_day"
}
],
"approvers": [
{
"approver_id": 932,
"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 vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
DELETE https://api.talenox.com/api/v2/leave_beta/applications/:id
Parameters
| Name | Description |
|---|---|
| id required | Leave Application ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 15,
"status": "success",
"timestamp": "2024-08-16T16:14:28.472+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 vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
DELETE https://api.talenox.com/api/v2/leave_beta/attachments
Parameters
ids: 4,2
| Name | Description |
|---|---|
| ids required | comma separated Attachment IDs |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Attachments deleted successfully",
"errors": {
"2": "no attachment found"
},
"timestamp": "2024-08-16T16:15:08.708+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 vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
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/216/922/2/dummy_image.png",
"file_preview_url": "/uploads/attachment/216/922/2/preview_dummy_image.png"
}
],
"category_class": "type",
"category_id": 74,
"created_at": "2024-08-16T08:14:25.703Z",
"employee_id": 922,
"end_date": "2024-08-16",
"id": 14,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-08-16",
"status": "pending",
"updated_at": "2024-08-16T08:14:25.703Z"
}
List all leave applications
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications?overlap_from=2024-08-16&overlap_to=2024-08-17
Accept: application/json
Content-Type: application/json
Authorization: Bearer vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
GET https://api.talenox.com/api/v2/leave_beta/applications
Parameters
overlap_from: 2024-08-16
overlap_to: 2024-08-17
| Name | Description |
|---|---|
| overlap_from required | Date in YYYY-MM-DD |
| overlap_to required | Date in YYYY-MM-DD |
| created_start | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| created_end | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| modified_start | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| modified_end | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| leave_application_status | leave application status - pending, approved or rejected |
| employee_id | Employee ID |
| approver_id | Employee ID |
| category | 'type' or 'oil' |
| category_id | Leave Type ID for 'type' category, Off In Lieu ID for 'oil' category |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 61,
"created_at": "2024-08-16T08:14:06.082Z",
"employee_id": 922,
"end_date": "2024-08-16",
"id": 1,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-08-16",
"status": "pending",
"updated_at": "2024-08-16T08:14:06.082Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 62,
"created_at": "2024-08-16T08:14:06.574Z",
"employee_id": 922,
"end_date": "2024-08-16",
"id": 2,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-08-16",
"status": "pending",
"updated_at": "2024-08-16T08:14:06.574Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 63,
"created_at": "2024-08-16T08:14:07.066Z",
"employee_id": 922,
"end_date": "2024-08-16",
"id": 3,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-08-16",
"status": "pending",
"updated_at": "2024-08-16T08:14:07.066Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": [
{
"attachment_id": 1,
"filename": "dummy_image.png",
"file_size": 31798,
"file_url": "/uploads/attachment/216/922/1/dummy_image.png",
"file_preview_url": "/uploads/attachment/216/922/1/preview_dummy_image.png"
}
],
"category_class": "type",
"category_id": 64,
"created_at": "2024-08-16T08:14:07.588Z",
"employee_id": 922,
"end_date": "2024-08-16",
"id": 4,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-08-16",
"status": "pending",
"updated_at": "2024-08-16T08:14:07.588Z"
}
]
List all leave applications by application status and created dates
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/applications?overlap_from=2024-08-16&overlap_to=2024-08-17&created_start=2024-08-16&created_end=2024-08-17&leave_application_status=pending
Accept: application/json
Content-Type: application/json
Authorization: Bearer vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
GET https://api.talenox.com/api/v2/leave_beta/applications
Parameters
overlap_from: 2024-08-16
overlap_to: 2024-08-17
created_start: 2024-08-16
created_end: 2024-08-17
leave_application_status: pending
| Name | Description |
|---|---|
| overlap_from required | Date in YYYY-MM-DD |
| overlap_to required | Date in YYYY-MM-DD |
| created_start | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| created_end | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| modified_start | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| modified_end | UTC timestamp in YYYY-MM-DD HH:MM:SSZ |
| leave_application_status | leave application status - pending, approved or rejected |
| employee_id | Employee ID |
| approver_id | Employee ID |
| category | 'type' or 'oil' |
| category_id | Leave Type ID for 'type' category, Off In Lieu ID for 'oil' category |
| last_seen_id | For pagination. Results returned will start from this last seen id + 1 |
| limit | For pagination. Number of items per page (default: 20, max:50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 65,
"created_at": "2024-08-16T08:14:08.992Z",
"employee_id": 922,
"end_date": "2024-08-16",
"id": 5,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-08-16",
"status": "pending",
"updated_at": "2024-08-16T08:14:08.992Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 66,
"created_at": "2024-08-16T08:14:09.515Z",
"employee_id": 922,
"end_date": "2024-08-16",
"id": 6,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-08-16",
"status": "pending",
"updated_at": "2024-08-16T08:14:09.515Z"
},
{
"amount": "1.0",
"approvers": null,
"attachments": null,
"category_class": "type",
"category_id": 67,
"created_at": "2024-08-16T08:14:10.027Z",
"employee_id": 922,
"end_date": "2024-08-16",
"id": 7,
"non_working_amount": "0.0",
"remarks": null,
"start_date": "2024-08-16",
"status": "pending",
"updated_at": "2024-08-16T08:14:10.027Z"
}
]
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 vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
PATCH https://api.talenox.com/api/v2/leave_beta/applications/reject/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 28,
"timestamp": "2024-08-16T16:15:01.710+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 vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
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"
922
------------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=922&leave_application_ids=11
Accept: application/json
Content-Type: application/json
Authorization: Bearer vQ4aYKTu6pKDY1_Y54tDQVOP0DuuxZmCuMCkXXpaDmA
DELETE https://api.talenox.com/api/v2/leave_beta/applications
Parameters
employee_id: 922
leave_application_ids: 11
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Leave application ids for input employee id 922 processed successfully",
"errors": {
},
"timestamp": "2024-08-16T16:14:24.524+08:00"
}
Leave Approval Structure (BETA)
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=268
Accept: application/json
Content-Type: application/json
Authorization: Bearer r_rC2N7uQS36X8yy9WsXtfcmuH2G4m-qRm_5tKKBG3A
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures
Parameters
company_id: 268
| 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": [
951
]
}
],
"company_default": true,
"id": 91,
"levels": 1,
"name": "Structure wjpscmgyi5"
}
]
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/97/assign_employees?employee_ids=944,951
Accept: application/json
Content-Type: application/json
Authorization: Bearer r_rC2N7uQS36X8yy9WsXtfcmuH2G4m-qRm_5tKKBG3A
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/assign_employees
Parameters
employee_ids: 944,951
| 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": [
951,
944
]
}
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/94/employees?last_employee_id=944
Accept: application/json
Content-Type: application/json
Authorization: Bearer r_rC2N7uQS36X8yy9WsXtfcmuH2G4m-qRm_5tKKBG3A
GET https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/employees
Parameters
last_employee_id: 944
| Name | Description |
|---|---|
| company_id required | Company ID |
| 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
[
952
]
unassign employees of a leave approval structure
Request
Endpoint
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/100/unassign_employees?employee_ids=944,951
Accept: application/json
Content-Type: application/json
Authorization: Bearer r_rC2N7uQS36X8yy9WsXtfcmuH2G4m-qRm_5tKKBG3A
PUT https://api.talenox.com/api/v2/leave_beta/leave_approval_structures/:id/unassign_employees
Parameters
employee_ids: 944,951
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "employees unassigned successfully",
"errors": {
"951": "employee not found in leave approval structure"
},
"timestamp": "2024-08-16T16:15:33.530+08:00"
}
Leave Approvers (BETA)
List a leave approver for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/approvers?employee_id=966&approver_id=22
Accept: application/json
Content-Type: application/json
Authorization: Bearer d3ZaAY1JTXFVFTOnv9-7RstKtpcxl1T8vUh2CBiJw7A
GET https://api.talenox.com/api/v2/leave_beta/approvers
Parameters
employee_id: 966
approver_id: 22
| 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": [
970
],
"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=966
Accept: application/json
Content-Type: application/json
Authorization: Bearer d3ZaAY1JTXFVFTOnv9-7RstKtpcxl1T8vUh2CBiJw7A
GET https://api.talenox.com/api/v2/leave_beta/approvers
Parameters
employee_id: 966
| 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": [
970
],
"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=988&query_date=20240816&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer R5rZ1VMHTAorFFqLkOGuXNnd-vqCTKsoRqnwlPToGs4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance
Parameters
employee_id: 988
query_date: 20240816
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": 988,
"query_date": "2024-08-16",
"timestamp": "2024-08-16T16:16:07.228+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=988&query_date=20240816&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer R5rZ1VMHTAorFFqLkOGuXNnd-vqCTKsoRqnwlPToGs4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/balance
Parameters
employee_id: 988
query_date: 20240816
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": 988,
"query_date": "2024-08-16",
"timestamp": "2024-08-16T16:16:07.491+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 R5rZ1VMHTAorFFqLkOGuXNnd-vqCTKsoRqnwlPToGs4
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": "2024-09-16",
"policy_start_date": "2024-08-16",
"quantity_type": "day"
}
Get off in lieu entitlement for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/entitlement_period?employee_id=988&id=6&query_date=20240816
Accept: application/json
Content-Type: application/json
Authorization: Bearer R5rZ1VMHTAorFFqLkOGuXNnd-vqCTKsoRqnwlPToGs4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus/entitlement_period
Parameters
employee_id: 988
id: 6
query_date: 20240816
| 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": 988,
"leave_type_id": 6,
"query_date": "2024-08-16",
"timestamp": "2024-08-16T16:16:07.763+08:00",
"valid_periods": {
"end_date": "2024-09-16",
"errors": [
],
"start_date": "2024-08-16"
}
}
List all off in lieus
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
Accept: application/json
Content-Type: application/json
Authorization: Bearer R5rZ1VMHTAorFFqLkOGuXNnd-vqCTKsoRqnwlPToGs4
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": "2024-09-16",
"policy_start_date": "2024-08-16",
"quantity_type": "day"
}
]
List off in lieus for an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus?employee_id=988&id=2
Accept: application/json
Content-Type: application/json
Authorization: Bearer R5rZ1VMHTAorFFqLkOGuXNnd-vqCTKsoRqnwlPToGs4
GET https://api.talenox.com/api/v2/leave_beta/off_in_lieus
Parameters
employee_id: 988
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": "2024-09-16",
"policy_start_date": "2024-08-16",
"quantity_type": "day"
}
]
Leave Types (BETA)
Get leave balance for a leave type of an employee
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/balance?employee_id=977&id=124&query_date=20240816
Accept: application/json
Content-Type: application/json
Authorization: Bearer IKyTBhL1JzSs90Zap8ke1MtGuASm4ODuPDE55eVacVU
GET https://api.talenox.com/api/v2/leave_beta/types/balance
Parameters
employee_id: 977
id: 124
query_date: 20240816
| 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": 977,
"query_date": "2024-08-16",
"timestamp": "2024-08-16T16:16:00.871+08:00",
"results": [
{
"balance": 8.0,
"errors": [
],
"leave_type_id": 124
}
]
}
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=977&query_date=20240816&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer IKyTBhL1JzSs90Zap8ke1MtGuASm4ODuPDE55eVacVU
GET https://api.talenox.com/api/v2/leave_beta/types/balance
Parameters
employee_id: 977
query_date: 20240816
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": 977,
"query_date": "2024-08-16",
"timestamp": "2024-08-16T16:16:00.645+08:00",
"results": [
{
"balance": 8.0,
"errors": [
],
"leave_type_id": 124
},
{
"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": 125
},
{
"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": 126
},
{
"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": 127
},
{
"balance": 365.0,
"errors": [
],
"leave_type_id": 128
}
]
}
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=977&id=124&query_date=20240816
Accept: application/json
Content-Type: application/json
Authorization: Bearer IKyTBhL1JzSs90Zap8ke1MtGuASm4ODuPDE55eVacVU
GET https://api.talenox.com/api/v2/leave_beta/types/entitlement_period
Parameters
employee_id: 977
id: 124
query_date: 20240816
| 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": 977,
"leave_type_id": 124,
"query_date": "2024-08-16",
"timestamp": "2024-08-16T16:16:01.025+08:00",
"valid_periods": [
{
"end_date": "2023-12-31",
"errors": [
],
"start_date": "2023-08-16"
},
{
"end_date": "2024-12-31",
"errors": [
],
"start_date": "2024-01-01"
}
]
}
Get leave type by id
Request
Endpoint
GET https://api.talenox.com/api/v2/leave_beta/types/124
Accept: application/json
Content-Type: application/json
Authorization: Bearer IKyTBhL1JzSs90Zap8ke1MtGuASm4ODuPDE55eVacVU
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": 124,
"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 IKyTBhL1JzSs90Zap8ke1MtGuASm4ODuPDE55eVacVU
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": 124,
"name": "Annual Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": true,
"id": 125,
"name": "Child Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 126,
"name": "Extended Child Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 127,
"name": "Maternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 128,
"name": "No Pay Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 129,
"name": "Paternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 130,
"name": "Shared Parental Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 131,
"name": "Sick Leave - Outpatient",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 132,
"name": "Sick Leave - Hospitalisation",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 133,
"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=977&last_seen_id=125&limit=5
Accept: application/json
Content-Type: application/json
Authorization: Bearer IKyTBhL1JzSs90Zap8ke1MtGuASm4ODuPDE55eVacVU
GET https://api.talenox.com/api/v2/leave_beta/types
Parameters
employee_id: 977
last_seen_id: 125
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": 126,
"name": "Extended Child Care Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 127,
"name": "Maternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 128,
"name": "No Pay Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "day"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 129,
"name": "Paternity Leave",
"policy_end_date": null,
"policy_start_date": null,
"quantity_type": "week"
},
{
"application_allowed": "allowed",
"half_day_allowed": false,
"id": 130,
"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 03e5e1ef4f27409e5546320f067b3f40ef878028
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": 312,
"name": "Wuckert-Boyer"
}
},
{
"marital_status": [
"Single",
"Widowed",
"Separated",
"Married",
"Divorced"
]
},
{
"gender": [
"Male",
"Female"
]
},
{
"payment_method": [
"Cheque",
"Cash",
"Bank Transfer",
"Forex Transfer"
]
},
{
"rate_of_pay": [
"Monthly",
"Daily",
"Hourly"
]
},
{
"country_name": [
"Åland Islands",
"Afghanistan",
"Albania",
"Algeria",
"American Samoa",
"Andorra",
"Angola",
"Anguilla",
"Antarctica",
"Antigua and Barbuda",
"Argentina",
"Armenia",
"Aruba",
"Australia",
"Austria",
"Azerbaijan",
"Bahamas",
"Bahrain",
"Bangladesh",
"Barbados",
"Belarus",
"Belgium",
"Belize",
"Benin",
"Bermuda",
"Bhutan",
"Bolivia",
"Bonaire, Sint Eustatius and Saba",
"Bosnia and Herzegovina",
"Botswana",
"Bouvet Island",
"Brazil",
"British Indian Ocean Territory",
"Brunei",
"Bulgaria",
"Burkina Faso",
"Burundi",
"Cambodia",
"Cameroon",
"Canada",
"Canary Islands",
"Cape Verde",
"Cayman Islands",
"Central African Republic",
"Chad",
"Channel Islands",
"Chile",
"China",
"Christmas Island",
"Cocos (Keeling Islands)",
"Colombia",
"Comoros",
"Cook Islands",
"Costa Rica",
"Cote D'Ivoire (Ivory Coast)",
"Croatia",
"Cuba",
"Curaco",
"Cyprus",
"Czech Republic",
"Democratic Republic of the Congo",
"Denmark",
"Djibouti",
"Dominica",
"Dominican Republic",
"East Timor",
"Ecuador",
"Egypt",
"El Salvador",
"Equatorial Guinea",
"Eritrea",
"Estonia",
"Ethiopia",
"Falkland Islands (Islas Malvinas)",
"Faroe Islands",
"Fiji",
"Finland",
"France",
"France, Metropolitan",
"French Guiana",
"French Polynesia",
"French Southern Territories",
"French West Indies",
"Gabon",
"Gambia",
"Georgia",
"Germany",
"Ghana",
"Gibraltar",
"Great Britain",
"Greece",
"Greenland",
"Grenada",
"Guadeloupe",
"Guam",
"Guatemala",
"Guernsey",
"Guinea",
"Guinea-Bissau",
"Guyana",
"Haiti",
"Hawaii",
"Heard and McDonald Islands",
"Honduras",
"Hong Kong",
"Hungary",
"Iceland",
"India",
"Indonesia",
"Iran",
"Iraq",
"Ireland",
"Isle of Man",
"Israel",
"Italy",
"Jamaica",
"Japan",
"Jersey",
"Jordan",
"Kazakhstan",
"Kenya",
"Kiribati",
"Korea North",
"Korea South",
"Kosovo",
"Kurdistan",
"Kuwait",
"Kyrgyzstan",
"Laos",
"Latvia",
"Lebanon",
"Lesotho",
"Liberia",
"Libya",
"Liechtenstein",
"Lithuania",
"Luxembourg",
"Macau",
"Macedonia",
"Madagascar",
"Malaysia",
"Malawi",
"Maldives",
"Mali",
"Malta",
"Marshall Islands",
"Martinique",
"Mauritania",
"Mauritius",
"Mayotte",
"Mexico",
"Micronesia",
"Midway Islands",
"Moldova",
"Monaco",
"Mongolia",
"Montenegro",
"Montserrat",
"Morocco",
"Mozambique",
"Myanmar",
"Namibia",
"Nauru",
"Nepal",
"Netherlands Antilles",
"Netherlands",
"Nevis",
"New Caledonia",
"New Zealand",
"Nicaragua",
"Niger",
"Nigeria",
"Niue",
"Norfolk Island",
"Northern Mariana Islands",
"Norway",
"Oman",
"Pakistan",
"Palau",
"Palestinian Territories",
"Panama",
"Papua New Guinea",
"Paraguay",
"Peru",
"Philippines",
"Pitcairn Islands",
"Poland",
"Portugal",
"Puerto Rico",
"Qatar",
"Republic of Serbia",
"Republic of the Congo",
"Reunion",
"Romania",
"Russia",
"Rwanda",
"Saint Barthelemy",
"Saint Helena",
"Saint Kitts and Nevis",
"Saint Lucia",
"Saint Martin (French part)",
"Sint Maarten (Dutch part)",
"Saint Pierre and Miquelon",
"Saint Vincent and the Grenadines",
"Saipan",
"Samoa",
"Samoa American",
"San Marino",
"Sao Tome and Principe",
"Saudi Arabia",
"Senegal",
"Serbia",
"Seychelles",
"Sierra Leone",
"Singapore",
"Slovakia",
"Slovenia",
"Solomon Islands",
"Somalia",
"South Africa",
"South Georgia and the South Sandwich Islands",
"South Sudan",
"Spain",
"Sri Lanka",
"Sudan",
"Suriname",
"Svalbard",
"Swaziland",
"Sweden",
"Switzerland",
"Syria",
"Tahiti",
"Taiwan",
"Tajikistan",
"Tanzania",
"Thailand",
"Togo",
"Tokelau",
"Tonga",
"Trinidad and Tobago",
"Tunisia",
"Turkey",
"Turkmenistan",
"Turks and Caicos Islands",
"Tuvalu",
"Uganda",
"Ukraine",
"United Arab Emirates",
"United Kingdom",
"United States",
"Uruguay",
"US Minor Outlying Islands",
"Uzbekistan",
"Vanuatu",
"Vatican City State",
"Venezuela",
"Vietnam",
"Virgin Islands (British)",
"Virgin Islands (US)",
"Wake Island",
"Wallis and Futuna Islands",
"Western Sahara",
"Yemen",
"Yugoslavia",
"Zaire",
"Zambia",
"Zimbabwe"
]
},
{
"region": [
]
},
{
"citizenship": [
"Singapore Citizen",
"Singapore PR",
"S Pass",
"E Pass",
"Personalised Employment Pass",
"Letter of Consent(Dependent Pass, Long term visit pass)",
"Work Permit",
"Student Visa (No CPF, No SDL)",
"Contract (No CPF, No SDL)",
"Contract With SDL (No CPF, W/SDL)",
"Work Holiday Pass(No CPF)",
"EntrePass",
"Intern",
"Passport (Oversea Director)",
"Tech Pass",
"Overseas Networks & Expertise Pass",
"Training Employment Pass",
"Training Work Permit"
]
},
{
"nationality": [
"Afghan",
"Albanian",
"Algerian",
"American",
"Andorran",
"Angolan",
"Anguillan",
"Antiguan",
"Argentine",
"Armenian",
"Arubian",
"Australian",
"Austrian",
"Azerbaijani",
"Bahamian",
"Bahraini",
"Bangladeshi",
"Barbadian",
"Barbudans",
"Batswana",
"Belarusian",
"Belgian",
"Belizean",
"Beninese",
"Bermudan",
"Bhutanese",
"Bolivian",
"Bosnian",
"Brazilian",
"British",
"British National (Overseas)",
"Bruneian",
"Bulgarian",
"Burkinabe",
"Burmese",
"Burundian",
"Cambodian",
"Cameroonian",
"Canadian",
"Cape Verdean",
"Caymanian",
"Central African",
"Chadian",
"Chilean",
"Chinese",
"Christmas Islander",
"Cocossian",
"Colombian",
"Cook Islander",
"Comoran",
"Congolese",
"Costa Rican",
"Croatian",
"Cuban",
"Cypriot",
"Czech",
"Danish",
"Djibouti",
"Dominican",
"Dutch",
"Ecuadorean",
"Egyptian",
"Emirian",
"Equatorial Guinean",
"Eritrean",
"Estonian",
"Ethiopian",
"Falkland Irishslander",
"Faroese",
"Fijian",
"Filipino",
"Finnish",
"French",
"French Guianese",
"French Polynesian",
"Gabonese",
"Gambian",
"Georgian",
"German",
"Ghanaian",
"Gibraltarian",
"Greek",
"Greenlander",
"Grenadian",
"Guadeloupean",
"Guamanian",
"Guatemalan",
"Guinea Bissauan",
"Guinean",
"Guyanese",
"Haitian",
"Herzegovinian",
"Honduran",
"Hong Kongers",
"Hong Kong Chinese",
"Hungarian",
"I-kiribati",
"Icelander",
"Indian",
"Indonesian",
"Iranian",
"Iraqi",
"Irish",
"Israeli",
"Italian",
"Ivorian",
"Jamaican",
"Japanese",
"Jordanian",
"Kazakhstani",
"Kenyan",
"Kittian And Nevisian",
"Kuwaiti",
"Kyrgyz",
"Laotian",
"Latvian",
"Lebanese",
"Liberian",
"Libyan",
"Liechtensteiner",
"Lithuanian",
"Luxembourger",
"Macau",
"Macedonian",
"Malagasy",
"Malawian",
"Malaysian",
"Maldivan",
"Malian",
"Maltese",
"Manx",
"Marshallese",
"Martinican",
"Mauritanian",
"Mauritian",
"Mexican",
"Micronesian",
"Moldovan",
"Monacan",
"Mongolian",
"Montenegrin",
"Montserratian",
"Moroccan",
"Mosotho",
"Motswana",
"Mozambican",
"Myanmarese",
"Namibian",
"Nauruan",
"Nepalese",
"Nevisian",
"New Caledonian",
"New Zealander",
"Ni Vanuatu",
"Nicaraguan",
"Nigerian",
"Nigerien",
"Niuean",
"Norfolk Islander",
"North Korean",
"Northern Irish",
"Norwegian",
"Omani",
"Pakistani",
"Palauan",
"Palestinian",
"Panamanian",
"Papua New Guinean",
"Paraguayan",
"Peruvian",
"Polish",
"Portuguese",
"Puerto Rican",
"Qatari",
"Romanian",
"Russian",
"Rwandan",
"Saint Lucian",
"Saint Vincentian",
"Salvadorean",
"Samoan",
"Sanmarinese",
"Sao Tomean",
"Saudi",
"Scottish",
"Senegalese",
"Serbian",
"Seychellois",
"Sierra Leonean",
"Singaporean",
"Slovakian",
"Slovenian",
"Solomon Islander",
"Somali",
"South African",
"South Korean",
"Spanish",
"Sri Lankan",
"Sudanese",
"Surinamer",
"Swazi",
"Swedish",
"Swiss",
"Syrian",
"Taiwanese",
"Tajik",
"Tanzanian",
"Thai",
"Timorese",
"Togolese",
"Tokelauan",
"Tongan",
"Trinidadian Or Tobagonian",
"Tunisian",
"Turkish",
"Turkmen",
"Tuvaluan",
"Ugandan",
"Ukrainian",
"Uruguayan",
"Uzbekistani",
"Venezuelan",
"Vietnamese",
"Welsh",
"Western Saharan",
"Yemenite",
"Zambian",
"Zimbabwean"
]
},
{
"race": [
"African",
"African-American",
"Bidayuh",
"Bumiputra",
"Caucasian",
"Chinese",
"Eurasian",
"Filipino",
"Iban",
"Indian",
"Japanese",
"Korean",
"Malay",
"Thai",
"Others"
]
},
{
"religion": [
"Taoism",
"Buddhism",
"Confucianism",
"Bahá'í Faith",
"Islam",
"Catholicism",
"Christianity",
"Hinduism",
"Sikhism",
"Judaism",
"Jainism",
"Others",
"No Religion",
"Free Thinker"
]
},
{
"bank_type": [
"DBS",
"HSBC",
"Standard Chartered",
"RHB",
"POSB",
"POSB Plus",
"OCBC",
"Maybank - Singapore Branch",
"CIMB",
"UOB",
"Citibank N.A Singapore Branch (CNAS)",
"Crédit Agricole",
"Commerzbank",
"Allahabad",
"ANZ",
"HSBC Corporate",
"Bank of China",
"India - HDFC Bank",
"ASB Bank Limited(New Zealand)",
"UBS AG",
"India - State Bank of India",
"India - The Federal Bank Ltd",
"India - Canara Bank",
"ICICI Bank",
"Sydbank",
"Sumitomo Mitsui Banking Corporation",
"Mizuho Corporate Bank, Ltd",
"AXIS Bank",
"DnB NOR Bank ASA",
"Shinhan",
"BNP Paribas",
"The Bank of Tokyo-Mitsubishi UFJ, Ltd",
"Citibank Singapore Limited (CSL)",
"Pakistan - Bank AlHabib",
"Pakistan - Habib Limited Bank",
"Industrial and Commercial Bank of China Limited",
"JP Morgan Chase Bank, N.A",
"Pakistan - Bank Alfalah Limited",
"Italy - Banca Prealpi SanBiagio",
"Commonwealth Bank of Australia",
"CA Indosuez",
"Pakistan - Meezan Bank",
"Vietnam - Asia Commercial Joint Stock Bank",
"State Bank of India",
"Pakistan - MCB Bank Limited",
"United Kingdom - Nationwide Building Society",
"Indonesia - BCA",
"Thailand - Bangkok Bank",
"Sri Lanka - Commercial Bank of Ceylon",
"Sri Lanka - Sampath Bank",
"Sri Lanka - National Development Bank",
"Bangkok Bank",
"Vietnam Techcombank",
"Indonesia - Mandiri Bank",
"Brazil - Banco Maxima Bank",
"United Kingdom - Monzo Bank Limited",
"United Kingdom - Barclays Bank",
"Thailand - Krungthai Bank",
"Indonesia - OCBC NISP",
"Bangkok Bank Public Company Limited",
"Malaysia - Maybank",
"Vietnam - Vietcombank",
"Indonesia - Bank Negara",
"Thailand - Kasikornbank",
"Indonesia - Permata Bank",
"Malaysia - UOB",
"Malaysia - RHB Bank",
"Thailand - Siam Commercial Bank",
"Australia - National Australia Bank",
"Malaysia - HSBC Amanah",
"Denmark - Lan and Spar Bank",
"United States - Bank of America",
"India - Indian Overseas Bank",
"Wise",
"Korea - KEB Hana Bank",
"Switzerland - Sygnum Bank",
"Malaysia - Public Bank",
"Airwallex",
"Maybank - Singapore Limited",
"Bank of America"
]
},
{
"currency": [
"SGD",
"HKD",
"MYR",
"USD",
"QAR",
"EUR",
"AUD",
"THB",
"PHP",
"IDR",
"INR",
"GBP",
"CAD",
"NZD",
"VND",
"BND",
"CNY",
"MMK",
"KRW",
"TWD",
"DKK",
"KHR",
"JPY",
"AED",
"PKR",
"SEK",
"ZAR",
"LKR",
"CHF",
"NPR",
"KES",
"RUB",
"RWF",
"KYD",
"MOP"
]
},
{
"relationship": [
"Wife",
"Husband",
"Daughter",
"Son",
"Mother",
"Father",
"Sister",
"Brother",
"Others"
]
},
{
"wp_worker_category": [
"Skilled",
"Unskilled"
]
},
{
"cpf_donation_type": [
"MBMF",
"CDAC",
"SINDA",
"ECF",
"N/A"
]
},
{
"wp_dcs": [
"Basic Tier / Tier 1: Up to 10% of the total workforce",
"Tier 2: Above 10% to 25% of the total workforce",
"Tier 3: Above 25% to 40% of the total workforce"
]
},
{
"spass_dcs": [
"Basic Tier / Tier 1: Up to 10% of the total workforce",
"Tier 2: Above 10% to 25% of the total workforce",
"Tier 3: Above 25% to 40% of the total workforce"
]
},
{
"voluntary_employer_contribution_type": [
"Percentage",
"Fixed Amount"
]
},
{
"voluntary_employee_contribution_type": [
"Percentage",
"Fixed Amount"
]
},
{
"voluntary_employer_contribution_rate": [
"5%",
"6%",
"7%",
"8%",
"9%",
"10%",
"11%",
"12%",
"13%",
"14%",
"15%"
]
},
{
"voluntary_employee_contribution_rate": [
"5%",
"6%",
"7%",
"8%",
"9%",
"10%",
"11%",
"12%",
"13%",
"14%",
"15%"
]
},
{
"socso_setting": [
"N/A",
"Automatic scheme selection based on age",
"Employment Injury Scheme and Invalidity Scheme",
"Employment Injury Scheme",
"Foreign Workers Social Security"
]
},
{
"employee_epf_setting": [
"Statutory Default",
"4%",
"5.5%",
"7%",
"8%",
"9%",
"10%",
"11%",
"12%",
"13%",
"14%",
"15%",
"16%",
"17%",
"18%",
"19%",
"20%",
"21%",
"22%",
"23%",
"24%",
"25%",
"26%",
"27%",
"28%",
"29%",
"30%",
"32%",
"46.6%"
]
},
{
"employer_epf_setting": [
"Statutory Default",
"N/A",
"6%",
"6.5%",
"12%",
"13%",
"14%",
"15%",
"16%",
"17%",
"18%",
"19%",
"20%",
"21%",
"22%",
"23%",
"24%",
"25%",
"26%",
"27%",
"28%",
"29%",
"30%",
"32%"
]
},
{
"period": [
"Whole Month",
"Whole Month (no monthly pay items)",
"1st Half of Month",
"2nd Half of Month"
]
},
{
"pay_item_types": {
"Recurring": [
"Basic Pay",
"Basic Pay(without proration)",
"Allowance",
"Allowance(without proration)",
"Deduction",
"Deduction (from Net Salary)",
"IR21 Tax Withholding",
"Commission (Daily/Weekly/Monthly)",
"Extra Duty Allowance",
"Housing/ Rental Allowance",
"Incentive Allowance",
"Meal Allowance",
"Per Diem Allowance",
"Transport Allowance",
"Tips",
"Director fees",
"Bonus",
"Others",
"Deduction (from Net Salary)(no SHG contribution)",
"Commission (AW)",
"Medisave",
"Deduction Community Chest"
],
"Adhoc": [
"Reimbursements",
"Advance Pay",
"Allowance",
"Deduction",
"Commission (Irregular)",
"Extra Duty Allowance",
"Festive Allowance",
"Housing/ Rental Allowance",
"Incentive",
"Incentive Allowance",
"IR21 Tax Withholding",
"Meal Allowance",
"Per Diem Allowance",
"Per Diem Reimbursement",
"Transport Allowance",
"Referral of Employees Fees",
"Benefits in Kind",
"Gifts in Kind",
"Share Option Sale",
"Termination Benefits",
"Tips",
"Annual Wage Supplement",
"Bonus",
"Prior Year Bonus",
"Prior Year AWS",
"Leave Pay",
"Director fees",
"Backdated Salary Increment",
"Backdated Salary",
"Deduction (from Net Salary)",
"Others",
"Others(no gross)",
"Salary in lieu",
"Onboarding incentive",
"Gratuity paid for years of service",
"Compensation for loss of employment",
"Deduction (from Net Salary)(no SHG contribution)",
"NS Leave Claims Deduction",
"Flexi-Benefit Personal Insurance",
"Flexi-Benefit Optical Expenses",
"Flexi-Benefit Health Screening & Vaccinations",
"Flexi-Benefit Childcare / Eldercare Fees For Dependants",
"Flexi-Benefit Medical Expenses For Dependants",
"Flexi-Benefit Dental Expenses For Dependants",
"Flexi-Benefit Gym Membership",
"Flexi-Benefit Holiday Expenses",
"Flexi-Benefit TCM / CHIRO/ PHYSIO",
"Gratuity",
"Flexi-Benefit Work From Home",
"Flexi-Benefit Mental Health Awareness",
"Flexi-Benefit Personal Planning & Enrichment",
"Flexi-Benefit Home Affairs Support",
"Flexi-Benefit Home Family Bonding Facilitation",
"Flexi-Benefit Professional Subscription"
],
"Attendance": [
"Regular Hours",
"Overtime Hours",
"Regular Days",
"Overtime Days",
"Public Holiday Pay",
"Rest Day Pay",
"Deputy Awage",
"Deputy"
]
}
}
]
Next of Kins
Create Next of Kin
Request
Endpoint
POST https://api.talenox.com/api/v2/next_of_kins
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0ffc8297b9f12d505be76ee9a41714ed614dd358
POST https://api.talenox.com/api/v2/next_of_kins
Parameters
{
"employee_id": 1010,
"next_of_kin": {
"name": "NOK Name",
"birthdate": "01/01/2018",
"relationship": "Wife",
"gender": "Male",
"citizenship": "Singaporean",
"ssn": "12345678"
}
}
| Name | Description |
|---|---|
| employee_id required | Employee ID |
| name required | Name |
| birthdate | Birth Date |
| relationship required | Relationship |
| gender | Gender |
| citizenship | Citizenship |
| ssn | Identification Number |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 2,
"employee_id": 1010,
"name": "NOK Name",
"relationship": "Wife",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2018-01-01",
"gender": "Male",
"marriage_date": null,
"ssn": "12345678",
"passport": null,
"citizenship": "Singaporean"
}
Delete Next of Kin
Request
Endpoint
DELETE https://api.talenox.com/api/v2/next_of_kins/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer d2af46e3a89513dfe45eeeef0a6690b39b712e36
DELETE https://api.talenox.com/api/v2/next_of_kins/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"message": "Successfully deleted next of kin Name"
}
Get Next of Kin
Request
Endpoint
GET https://api.talenox.com/api/v2/next_of_kins/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer 214e499dba541a232925c4795d29d6b287631e17
GET https://api.talenox.com/api/v2/next_of_kins/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"employee_id": 1021,
"name": "Name",
"relationship": "Son",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2024-08-16",
"gender": null,
"marriage_date": null,
"ssn": null,
"passport": null,
"citizenship": "Singaporean"
}
Update Next of Kin
Request
Endpoint
PUT https://api.talenox.com/api/v2/next_of_kins/4
Accept: application/json
Content-Type: application/json
Authorization: Bearer c26a13e3ffdbdd3481f9ef30d081fb08c577d802
PUT https://api.talenox.com/api/v2/next_of_kins/:id
Parameters
{
"next_of_kin": {
"name": "Change name"
}
}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 4,
"employee_id": 1032,
"name": "Change name",
"relationship": "Son",
"contact_number": null,
"alternate_contact_number": null,
"birthdate": "2024-08-16",
"gender": null,
"marriage_date": null,
"ssn": null,
"passport": null,
"citizenship": "Singaporean"
}
Payroll
Create Adhoc Payment
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/adhoc_payment
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6f69e96458333d974f6ccc0c1d148d3c03ded349
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": 1070,
"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 16dbc8053475c1b34efb9bf7f498b2415be5ab11
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": 1071,
"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 8ea07c9155657b78808a342afbe2373a9915d73b
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": 1072,
"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 b250dd3f1447af9813fd6c025551da944c952a0b
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 d31e47ddc9f15aae041da08f32d294c8c9386fcb
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": 1069,
"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 083314ab88cebef9ee5b3603eceb935577b75d11
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": 1063,
"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 a5bf552338d43ca6982d1ebe6e3120d78d80d920
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": 1064,
"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 d5b8efe8d68be1c339fa061b4bca7e27bdd91d8b
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": 1065,
"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 6a72663f88f506b539e92be3f62e3f550cffb6db
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 84b4a8c4994f75c77649dd311b856f4e71e9ea23
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": 1062,
"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 e55338602201c8d14af3a27007fd49751b64f0f3
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": 1073,
"employee_id": "K00001",
"name": "Guadalupe Stokes",
"job_title": null,
"department": null,
"country_code": "SG",
"currency_unit": "$",
"attendance_pay_items": [
],
"recurring_pay_items": [
{
"id": 7,
"employee_id": 1073,
"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": 28507
}
],
"adhoc_pay_items": [
],
"overtime_pay": "0.0",
"payment_method": "Bank Transfer",
"published": false,
"payslip_pay_date": null,
"payslip_remarks": "",
"payslip_remarks_maximum_length": 500,
"total_leave_pay": "0.0",
"total_reimbursements": "0.0",
"total_basic_salary": "1000.0",
"total_allowances": "0.0",
"total_commissions": "0.0",
"total_directors_fees": "0.0",
"total_gross_full": "1000.0",
"total_leave_payments_or_deductions": "0.0",
"total_others": "0.0",
"total_employee_benefits": "0.0",
"total_other_pay_items_amount": "0.0",
"sg_cpf_donation_type": "CDAC",
"sg_additional_cpf_donation_type": "N/A",
"total_sums_owage_awage": {
"awage": "0.0",
"owage": "1000.0"
},
"sg_cpf_contribution_type": "Year2018::Citizen::Age50",
"total_sg_cpf_owage_subjected": "1000.0",
"total_sg_cpf_awage_subjected": "0.0",
"total_sg_cpf_employee_awage": "0.0",
"total_sg_cpf_employer_awage": "0.0",
"total_sg_cpf_employee_owage": "200.0",
"total_sg_cpf_employer_owage": "170.0",
"sg_total_shg_contributable": "1000.0",
"total_sg_mandatory_cpf_employee": "200.0",
"total_sg_mandatory_cpf_employer": "170.0",
"total_sg_voluntary_cpf_employee": "0.0",
"total_sg_voluntary_cpf_employer": "0.0",
"total_sg_voluntary_cpf_employee_rate": "0.0",
"total_sg_voluntary_cpf_employer_rate": "0.0",
"total_sg_cpf_employee_employer": "370.0",
"total_sg_voluntary_cpf_employer_medisave": "0.0",
"total_cpf_in_lieu_awage": "0.0",
"total_cpf_in_lieu_owage": "0.0",
"total_taxable": "1000.0",
"payment_reconciliation": "0.0",
"total_sg_cpf_withholding": "200.5",
"total_net_payment_converted": "799.5",
"total_recurring_full_converted": "1000.0",
"total_recurring_prorated_converted": "1000.0",
"total_adhoc_converted": "0.0",
"total_attendance_converted": "0.0",
"total_leave_payments_or_deductions_converted": "0.0",
"total_deductions_converted": "0.0",
"total_gross_converted": "1000.0",
"total_bonus_converted": "0.0",
"total_leave_pay_converted": "0.0",
"total_reimbursements_converted": "0.0",
"total_allowances_converted": "0.0",
"total_basic_salary_converted": "1000.0",
"total_commissions_converted": "0.0",
"total_directors_fees_converted": "0.0",
"total_taxable_converted": "1000.0",
"total_others_converted": "0.0",
"total_employee_benefits_converted": "0.0",
"total_sg_cpf_employee_owage_reverted": "200.0",
"total_sg_cpf_employee_awage_reverted": "0.0",
"total_sg_cpf_employee_reverted": "200.0",
"total_sg_mandatory_cpf_employee_reverted": "200.0",
"total_sg_mandatory_cpf_employer_reverted": "170.0",
"total_sg_voluntary_cpf_employee_reverted": "0.0",
"total_sg_voluntary_cpf_employer_reverted": "0.0",
"total_sg_voluntary_cpf_employer_medisave_reverted": "0.0",
"total_sg_cpf_employer_owage_reverted": "170.0",
"total_sg_cpf_employer_awage_reverted": "0.0",
"total_sg_cpf_employer_reverted": "170.0",
"total_sg_cpf_sdl_reverted": "2.5",
"total_sg_cpf_awage_reverted": "0.0",
"total_sg_cpf_owage_reverted": "1000.0",
"total_sg_cpf_donation_reverted": "0.5",
"payment_reconciliation_reverted": "0.0",
"total_sg_additional_cpf_donation_reverted": "0.0",
"total_sg_fwl_reverted": "0.0",
"total_sg_cpf_withholding_reverted": "200.5",
"employee_final_cpf_reverted": "200.5"
}
],
"total_gross_salary": "$1,000.00",
"total_ytd_gross_salary": "$1,000.00",
"total_ytd_bonus": "$0.00",
"total_ytd_net_payment": "$799.50",
"total_ytd_cpf_employee": "$200.00",
"total_ytd_cpf_employer": "$170.00",
"month": "September",
"year": "2018",
"company_payroll_setting": {
"id": 345,
"company_id": 345,
"employers_contribute_shg_on_behalf": "employers_do_not_contribute_shg_on_behalf",
"payslip_update_on_address_change": "need_to_update_payslips_for_address_change",
"payslip_update_on_image_change": "need_to_update_payslips_for_image_change",
"payslip_footer_message": "show",
"payslip_period_display": "show_to_from_dates",
"payslip_ytd_use_gross_salary": "show_ytd_gross_salary",
"payslip_ytd_display": "show_ytd",
"payslip_employee_id_display": "show_id",
"payslip_employee_address_display": "show_address",
"payslip_leave_balance": "show_leave_balance",
"hk_mpf_first_contribution": "first_contribution_default_payment",
"npl_rounding": "no_rounding",
"sick_leave_rounding": "no_rounding",
"maternity_leave_rounding": "no_rounding",
"paternity_leave_rounding": "no_rounding",
"annual_leave_rounding": "no_rounding",
"created_at": "2024-08-16T08:17:14.462Z",
"updated_at": "2024-08-16T08:17:14.533Z",
"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"
}
}
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 6c0a3e9be3c3b36870d26aa9797aac772877466d
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": 1058,
"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": 1058,
"item_type": "Allowance",
"remarks": "",
"amount": "1000.0",
"rate_of_pay": "0.0",
"currency": "SGD"
}
],
"attendance_pay_items": [
{
"id": 1,
"employee_id": 1058,
"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": 1058,
"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 c7eefce9f8fbf99f961e9cdc5d5c8e78e55d12d7
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": 1076,
"employee_id": "K00001",
"name": "Paris Friesen",
"job_title": null,
"department": null,
"country_code": "SG",
"currency_unit": "$",
"attendance_pay_items": [
],
"recurring_pay_items": [
{
"id": 10,
"employee_id": 1076,
"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": 28759
}
],
"adhoc_pay_items": [
],
"overtime_pay": "0.0",
"payment_method": "Bank Transfer",
"published": false,
"payslip_pay_date": null,
"payslip_remarks": "",
"payslip_remarks_maximum_length": 500,
"total_leave_pay": "0.0",
"total_reimbursements": "0.0",
"total_basic_salary": "1000.0",
"total_allowances": "0.0",
"total_commissions": "0.0",
"total_directors_fees": "0.0",
"total_gross_full": "1000.0",
"total_leave_payments_or_deductions": "0.0",
"total_others": "0.0",
"total_employee_benefits": "0.0",
"total_other_pay_items_amount": "0.0",
"sg_cpf_donation_type": "CDAC",
"sg_additional_cpf_donation_type": "N/A",
"total_sums_owage_awage": {
"awage": "0.0",
"owage": "1000.0"
},
"sg_cpf_contribution_type": "Year2018::Citizen::Age50",
"total_sg_cpf_owage_subjected": "1000.0",
"total_sg_cpf_awage_subjected": "0.0",
"total_sg_cpf_employee_awage": "0.0",
"total_sg_cpf_employer_awage": "0.0",
"total_sg_cpf_employee_owage": "200.0",
"total_sg_cpf_employer_owage": "170.0",
"sg_total_shg_contributable": "1000.0",
"total_sg_mandatory_cpf_employee": "200.0",
"total_sg_mandatory_cpf_employer": "170.0",
"total_sg_voluntary_cpf_employee": "0.0",
"total_sg_voluntary_cpf_employer": "0.0",
"total_sg_voluntary_cpf_employee_rate": "0.0",
"total_sg_voluntary_cpf_employer_rate": "0.0",
"total_sg_cpf_employee_employer": "370.0",
"total_sg_voluntary_cpf_employer_medisave": "0.0",
"total_cpf_in_lieu_awage": "0.0",
"total_cpf_in_lieu_owage": "0.0",
"total_taxable": "1000.0",
"payment_reconciliation": "0.0",
"total_sg_cpf_withholding": "200.5",
"total_net_payment_converted": "799.5",
"total_recurring_full_converted": "1000.0",
"total_recurring_prorated_converted": "1000.0",
"total_adhoc_converted": "0.0",
"total_attendance_converted": "0.0",
"total_leave_payments_or_deductions_converted": "0.0",
"total_deductions_converted": "0.0",
"total_gross_converted": "1000.0",
"total_bonus_converted": "0.0",
"total_leave_pay_converted": "0.0",
"total_reimbursements_converted": "0.0",
"total_allowances_converted": "0.0",
"total_basic_salary_converted": "1000.0",
"total_commissions_converted": "0.0",
"total_directors_fees_converted": "0.0",
"total_taxable_converted": "1000.0",
"total_others_converted": "0.0",
"total_employee_benefits_converted": "0.0",
"total_sg_cpf_employee_owage_reverted": "200.0",
"total_sg_cpf_employee_awage_reverted": "0.0",
"total_sg_cpf_employee_reverted": "200.0",
"total_sg_mandatory_cpf_employee_reverted": "200.0",
"total_sg_mandatory_cpf_employer_reverted": "170.0",
"total_sg_voluntary_cpf_employee_reverted": "0.0",
"total_sg_voluntary_cpf_employer_reverted": "0.0",
"total_sg_voluntary_cpf_employer_medisave_reverted": "0.0",
"total_sg_cpf_employer_owage_reverted": "170.0",
"total_sg_cpf_employer_awage_reverted": "0.0",
"total_sg_cpf_employer_reverted": "170.0",
"total_sg_cpf_sdl_reverted": "2.5",
"total_sg_cpf_awage_reverted": "0.0",
"total_sg_cpf_owage_reverted": "1000.0",
"total_sg_cpf_donation_reverted": "0.5",
"payment_reconciliation_reverted": "0.0",
"total_sg_additional_cpf_donation_reverted": "0.0",
"total_sg_fwl_reverted": "0.0",
"total_sg_cpf_withholding_reverted": "200.5",
"employee_final_cpf_reverted": "200.5"
}
],
"total_gross_salary": "$1,000.00",
"total_ytd_gross_salary": "$1,000.00",
"total_ytd_bonus": "$0.00",
"total_ytd_net_payment": "$799.50",
"total_ytd_cpf_employee": "$200.00",
"total_ytd_cpf_employer": "$170.00",
"month": "September",
"year": "2018",
"company_payroll_setting": {
"id": 348,
"company_id": 348,
"employers_contribute_shg_on_behalf": "employers_do_not_contribute_shg_on_behalf",
"payslip_update_on_address_change": "need_to_update_payslips_for_address_change",
"payslip_update_on_image_change": "need_to_update_payslips_for_image_change",
"payslip_footer_message": "show",
"payslip_period_display": "show_to_from_dates",
"payslip_ytd_use_gross_salary": "show_ytd_gross_salary",
"payslip_ytd_display": "show_ytd",
"payslip_employee_id_display": "show_id",
"payslip_employee_address_display": "show_address",
"payslip_leave_balance": "show_leave_balance",
"hk_mpf_first_contribution": "first_contribution_default_payment",
"npl_rounding": "no_rounding",
"sick_leave_rounding": "no_rounding",
"maternity_leave_rounding": "no_rounding",
"paternity_leave_rounding": "no_rounding",
"annual_leave_rounding": "no_rounding",
"created_at": "2024-08-16T08:17:22.066Z",
"updated_at": "2024-08-16T08:17:22.139Z",
"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"
}
}
Get Payslips PDF
Request
Endpoint
POST https://api.talenox.com/api/v2/payroll/get_payslips
Accept: application/json
Content-Type: application/json
Authorization: Bearer 529c69cc85a0f8b5413ce506f7265eb055eb8739
POST https://api.talenox.com/api/v2/payroll/get_payslips
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
1074
]
}
| 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
[
{
"1074": 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 8a968c8986ce05bcefaf9c6e4009bc9cd2d98a6e
POST https://api.talenox.com/api/v2/payroll/get_payslips
Parameters
{
"month": "September",
"year": 2018,
"employee_ids": [
1075
],
"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
[
{
"1075": {
"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 1793ef6fa99563f68c1e7ddace737628bd705361
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 cb14451b3f0fe1c242a4411871a81fae9af83f71
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 cf157b1b22b55c3f9f1ac344917d749c4e9dfeff
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 7abf773cc0a571b94b29b63cf3ff9a751e51d8d2
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 824fa6ae8b3639cd4cc6a97adda043488d69dfd1
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 56d293e8c8e10f32b12017732f364da7214a05ad
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 dd332cc7259677278ede4eb342c459380e5ea9c2
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": 1066,
"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 6b74c5e4a717b2a56a9cb7f624b1d7985cca07ec
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": 1068,
"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 9180da614c7b2f425f3485dd46e861bb1d0a8259
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": 1067,
"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 PAA0rmc6Aux64ikFmM-X-zBavLxJqRZ4n2M2B6e1OJE
GET https://api.talenox.com/api/v2/user_info
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"company": {
"id": 369
},
"employee": {
"id": 1198,
"employee_id": "q4yyqzwf2x"
}
}
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 0cadc78130dcd4bffa74bc05ac4ac5a3ed171a12
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": [
1332
]
}
}
| 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) |
| employee_ids | Employee IDs (This will override the working day's employee) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 158,
"name": "New working day",
"employee_ids": [
1332
],
"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/168
Accept: application/json
Content-Type: application/json
Authorization: Bearer 14312289bab3bec84b5b0e773ff533d2016b427b
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 4"
}
Get Working Day
Request
Endpoint
GET https://api.talenox.com/api/v2/working_days/160
Accept: application/json
Content-Type: application/json
Authorization: Bearer 05bc290a171b483da4ee640d6d6ec587e4b95039
GET https://api.talenox.com/api/v2/working_days/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 160,
"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 c40930d72c6f96edaee44b2f3aef748c8299a63c
GET https://api.talenox.com/api/v2/working_days
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 155,
"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/162
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2100bc67b2d2484fe15efb9a3b94ff9d26bfe1fe
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": 162,
"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 79a3dfb690237223c1effeeabca812c9fe68ea4f
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": [
1401
]
}
}
| 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": 161,
"name": "New Working Hour",
"employee_ids": [
1401
],
"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/171
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4bd98ff8d1478ace72cb99e25448e9f7978a2da2
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/163
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8df2ca26efd6261b1bc7436033d4b2beb528833a
GET https://api.talenox.com/api/v2/working_hours/:id
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 163,
"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 3380fbafb8adb748e0dbffb4579dc1694a13b33f
GET https://api.talenox.com/api/v2/working_hours
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 158,
"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/165
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7c947557ee74110a2b5e178e0f84989cb7f33ec0
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": 165,
"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