Endpoints Overview

 

If you do not include a page limit the return is 50 by default. ie. 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

 

IPA Books+ Payroll uses the same baseURL and endpoints of Reckon One Payroll as it's the white labelled version of Reckon One. This will help you integrate with it easily.

Supported Endpoints and Methods

Endpoint

Additional Parameter(s)

HTTP Method

Description

API Portal

Countries

Payroll Items

 

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.

 Portal

AU

Payroll Items

 

POST

Add a new payroll item to the book specified in the API request. For leave and super items a different endpoint is used

 Portal

AU

Payroll Items

/{payrollitemid}

PUT

Update a payroll item in the book specified in the API request

 Portal

AU

Leave Items

 

GET

Retrieve a list of the leave items from the book you have requested API data from.

 Portal

AU

Leave Items

 

POST

Add a new leave item to the book specified in the API request.

Portal

AU

Leave Items

/{leaveitemid}

PUT

Update a leave item in the book specified in the API request

 Portal

AU

Super Items

 

GET

Retrieve a list of the super items from teh book you have requested API data from.

 

AU

Super Items

 

POST

Add a new super item to the book specified in the API request.

 

AU

Super Items

/{superitemid}

PUT

Update a super item in the book specified in the API request

 

AU

Payroll Contacts

 

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

Portal

AU

Payroll Contacts

/{contactid}

GET

Get the details of an employee by providing it's contactId.

Portal

AU

Payroll Contacts

 

POST

This allows you to add a new contact including payroll data to the book specified in the API request

Portal

AU

Payroll Contacts

/{contactid}

PUT

This allows you to update a contact including payroll data to the book specified in the API request

Portal

AU

Payruns

 

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

 Portal

AU

Payrun by ID

/{payrun-id} 

GET

This allows you to retrieve the full details of a individual payrun from teh book.

 Portal

AU

Post Draft Payrun

 

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.

 Portal

AU

Update Draft Payrun

/{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

 Portal

AU

Update a Payrun

/{payrunid}

PATCH

This allows you to update a specific object of a Pay run.

Portal

AU

Delete Draft Payrun

/{payrunid}

DELETE

This allows you to delete a draft payrun which is in the book specified in the 

 Portal

AU

Delete an earnings line from a Payrun

/{{PayrunId}}/ employees/ {{PayrunEmployeeId}}/ earnings/ {{OTELineId}}

DELETE

This allows you to delete an earnings line item from a Payrun

Portal

AU

How did we do?

Employees API v1

Related Articles

Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)