API Configurations

The following document contains information about PurePro public API endpoints and its objects. The aim to is to highlight the dependencies and the validation errors, also what keys or values are available for each endpoint.
Common operations;
﻿
Used to retrieve a resourceUsed to retrieve a resource
﻿
Used to Create a new resourceUsed to Create a new resource
﻿
Used to Modify/Update a resourceUsed to Modify/Update a resource
Please refer to the table below for supported API requests and related configurations:
﻿
Category
Action
API Request
Worker
GET
﻿ Worker GET⁠ ﻿
ADD
﻿ PAYE ADD⁠ ﻿
﻿ Contractor ADD⁠ ﻿
﻿ Agency/Umbrella ADD⁠ ﻿
UPDATE
﻿ PAYE UPDATE⁠ ﻿
﻿ Contractor Update⁠ ﻿
﻿ Agency/Umbrella UPDATE⁠ ﻿
Search
﻿ WorkerSearch⁠ ﻿
﻿ WorkerReferenceSearch⁠ ﻿
Transfer
﻿ Worker Transfer⁠ ﻿
﻿ Revert Worker Transfer⁠ ﻿
Payment After Leaving
﻿ Worker Payment After Leaving⁠ ﻿
Restart Worker
﻿ Restart Worker⁠ ﻿
Supplier
GET
﻿ Supplier GET⁠ ﻿
ADD
﻿ Supplier ADD⁠ ﻿
UPDATE
﻿ Supplier UPDATE⁠ ﻿
Customer
GET
﻿ Customer GET⁠ ﻿
ADD
﻿ Customer ADD⁠ ﻿
UPDATE
﻿ Customer UPDATE⁠ ﻿
Placement
GET
﻿ Placement GET⁠ ﻿
ADD
﻿ Placement ADD⁠ ﻿
UPDATE
﻿ Placement UPDATE⁠ ﻿
Timesheet
GET
﻿ Timesheet GET⁠ ﻿
ADD
﻿ Timesheet ADD from Placement⁠ ﻿
﻿ Timesheet ADD (Auto Create Placement)⁠ ﻿
UPDATE
﻿ Timesheet UPDATE⁠ ﻿
Payslip & Remittance
GET
﻿ Get Payslips⁠ ﻿
Payslip Paginated
﻿ Get Payslip Paginated⁠ ﻿
Payslip Rate Detail
﻿ Get Payslip Rate Details⁠ ﻿
Account
GET
﻿ GetAccount⁠ ﻿
﻿ GetCurrentPeriod⁠ ﻿
﻿ GetBusinessUnit⁠ ﻿
﻿ GetProcessingStatus⁠ ﻿
﻿ GetControlJobStatus⁠ ﻿
Documents
GET
﻿ GetByWorker⁠ ﻿
﻿
﻿The contents of this document, along with any associated documents, are the property of PurePro Solutions Ltd. and are shared in strict confidence with the intended recipient. These materials may not be reproduced, shared, or used in any manner without prior written consent from PurePro Solutions Ltd. Unauthorized use or distribution is prohibited.﻿
﻿
﻿
﻿