Table of Contents
Leave Items
Supported Endpoints and Methods
The endpoint can be found at: https://api.reckon.com/R1/{bookId}/payroll/leaveitems
Methods supported: GET, POST, PUT
The Book ID represents the unique GUID of the Book the user wants to write data to. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401
Endpoint | Additional Parameter(s) | HTTP Method | Description | API Portal | Countries |
leaveitems |
| GET | Retrieve the list of leave items | AU | |
leaveitems | /leaveitemid | PUT | Update a leave item | AU | |
leaveitems |
| POST | Add a leave item | AU |
Get the list of Leave items
Endpoint: https://api.reckon.com/R1/{bookId}/payroll/leaveitems
Method: GET
Sample response
[
{
"LeaveItemID": "d7762045-5427-4b09-8520-31bf1572c71f",
"PayItemType": 2,
"Status": 1,
"LeaveItemType": 14,
"Name": "Long service leave",
"Description": null,
"ExpenseAccountId": "a2b48237-fea5-4b89-910a-e802b27efd4d",
"ExpenseAccountName": "Agency Temp Staff",
"AnnualEntitlement": null,
"AccrualPeriodId": 3,
"Maximum": null,
"LeaveLoadingPercentage": null,
"IsResetEveryYear": false,
"IsPayOnTermination": false,
"IsInTimeWorkedAccrual": true,
"IsShownLeaveBalanceOnPaySlip": true
}
]
Details of each object
Data Field | Description | Data Type | Mandatory? |
LeaveItemID | The unique id of the leave item | GUID | No |
PayItemType | The pay item type | Set data types: 2- Leave | No |
Status | The status of the item | Set data types:
| No |
LeaveItemType | The subtype of the payrolli tem | Set data types:
| Yes |
Name | The name of the item | Text | Yes |
Description | The description of the item | Text | No |
ExpenseAccountID | The GUID of the expense account linked to the item | GUID | No (If ExpenseAccountName is included text to guid will be used) |
ExpenseAccountName | The name of the expense account in text | text | Yes (unless ExpenseAccount is used with a GUID) |
AnnualEntitlement | The annual entitlement for the leave item | Numeric | No |
AccrualPeriodId | The accural period for the item | Set data types:
| Yes |
Maximum | The maximum a leave entitlement can reach | Numeric | No |
LeaveLoadingPercentage | If the item has leave loading associated, the percentage of the leave loading | Numeric | No |
IsResetEveryYear | Whether the entitlement should be reset every year | Boolean true/false | No |
IsPayOnTermination | Whether the leave entitlement shoudl be paid out on termination | Boolean true/false | No |
IsShownLeaveBalanceOnPaySlip | Whether the item should appear on the payslip with the accrued period | Boolean true/false | N |
Minimum Post - Leave Items
Endpoint: https://api.reckon.com/R1/{BOOKID}/payroll/leaveitems
Method: POST
Sample Payload
{
"Name": "{{Name of the Item}}",
"ExpenseAccountName": "{{expense account}}", // To use GUID, use "ExpenseAccountId"
"LeaveItemType": "{{Pay item type}}",
"AccrualPeriodId": "{{accrual period}}"
}
