Reporting - API Requests
This document provides information about the PurePro public API endpoints associated with Reporting operations and their objects.
Common operations;
APIs are Business Unit-specific and do not follow the Parent–Child Business Unit hierarchy.
The Worker/Customer/Supplier must belong to the same Business Unit as the API request.
Please select one of the options below: -
Gross Profit (GP) Report
Method:
BaseURL: //{{publicApiUrl}}/Timesheet/{{accountReference}}/GrossProfit/{periodID}?workerreference=worker_ref&CustomerReference=cust_ref&BusinessUnitReference=bu_ref&SupplierReference=supp_ref&ShowConsultantSplits=true/false
To retrieve summary of an account's gross profit information via public API you need to pass the account reference and period id to the base URL as the required parameters.
The key dependencies and validations are:
Account
String
- Cannot be Null
- Cannot be left blank
PeriodID
String
- Cannot be Null
- You must input the period for which you want to view the document for
- Must be provided in the following format 20261001000
WorkerReference
String
- This is Optional
- Can be Left Blank
- Cannot be null
- Must be a valid worker reference
CustomerReference
String
- This is Optional
- Can be Left Blank
- Cannot be null
- Must be a valid customer reference
SupplierReference
String
- This is Optional
- Can be Left Blank
- Cannot be null
- Must be a valid supplier reference
BusinessUnitReference
String
- This is Optional
- Can be Left Blank
- Cannot be null
- Must be a valid business unit reference
ShowConsultantSplits
Boolean
- This is Optional
- Cannot be null
- Can be left blank
- Accepts values - "True" or "False"
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.