Documents - API Requests
This document provides information about the PurePro public API endpoints associated with document operations and their objects.
Common operations;
Please select one of the options below: -
Documents
GetByWorker
Method:
BaseURL: {{publicApiUrl}}/DocumentExport/{{accountReference}}/{{businessUnitReference}}/{DocumentType}/{periodId}?{WorkerReference}
To retrieve a document from worker details e.g. P45 or P60 issued to the worker via public API you need to pass the account and business unit reference along with the worker reference, period id and the document type to the base URL as the required parameters
Account
- Cannot be Null
- You must select an existing Account
Business Unit
- Cannot be Null
- You must select an existing Business Unit
Document Type
- Cannot be Null
- You need to input the type of document to be retrieved/viewed
PeriodId
- Cannot be Null
- You must input the period for which you want to view the document for
WorkerReference
- Cannot be Null
- You must enter the worker reference for which you want to view the document
The key dependencies and validations are:
PeriodId – must be provided in the following format 20231001000
Documenttype: - must be provided as P45 or P60
WorkerReference: - must be a reference of a worker in the system
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.