Endpoints Overview
https://api.reckon.com/r1/{cashbookid}/payroll/payrollitems will return 50 records maximum. This is due to the fact the Reckon One API did not have pagination in earlier versions, therefore we did not and could not enforce pagination in the later release. For more information see our Pagination help page.
Supported Endpoints and Methods
Endpoint | Additional Parameter(s) | HTTP Method | Description | API Portal | Countries |
| GET | Retrieve a list of payroll items from the book you have requested API data from. This endpoint does not retrieve leave and super items as they have specific requirements of data. | AU | ||
| POST | Add a new payroll item to the book specified in the API request. For leave and super items a different endpoint is used | AU | ||
/{payrollitemid} | PUT | Update a payroll item in the book specified in the API request | AU | ||
| GET | Retrieve a list of the leave items from the book you have requested API data from. | AU | ||
| POST | Add a new leave item to the book specified in the API request. | AU | ||
/{leaveitemid} | PUT | Update a leave item in the book specified in the API request | AU | ||
| GET | Retrieve a list of the super items from teh book you have requested API data from. |
| AU | |
| POST | Add a new super item to the book specified in the API request. |
| AU | |
/{superitemid} | PUT | Update a super item in the book specified in the API request |
| AU | |
| GET | This is a extension of the already existing Reckon One contacts data. When utilising this endpoint the primary contact data as well as the payroll specific data will be returned | AU | ||
/{contactid} | GET | Get the details of an employee by providing it's contactId. | AU | ||
| POST | This allows you to add a new contact including payroll data to the book specified in the API request | AU | ||
/{contactid} | PUT | This allows you to update a contact including payroll data to the book specified in the API request | AU | ||
| GET | This allows you to retrieve a summary list of the payruns in the book. The data in this response can then be used to retrieve a specific pay runs information | AU | ||
/{payrun-id} | GET | This allows you to retrieve the full details of a individual payrun from teh book. | AU | ||
| POST | This allows you to add a new draft payrun to the book specified in the API request. Note - It is not possible at this time to remotely execute a payrun via the API, the user must do this in the application. | AU | ||
/{payrunid} | PUT | This allows you to update a draft payrun which is in the book specified in the API request. Note - It is not possible at this time to remotely execute a payrun via the API, the user must do this in the application | AU | ||
/{payrunid} | PATCH | This allows you to update a specific object of a Pay run. | AU | ||
/{payrunid} | DELETE | This allows you to delete a draft payrun which is in the book specified in the | AU | ||
/{{PayrunId}}/ employees/ {{PayrunEmployeeId}}/ earnings/ {{OTELineId}} | DELETE | This allows you to delete an earnings line item from a Payrun | AU |
