Placements - API Requests

This document provides information about the PurePro public API endpoints associated with placement operations and their objects.
Common operations;

https://slite.com/api/files/FVe7_Y1MH5pv6Y/imported-image?apiToken=eyJhbGciOiJIUzI1NiIsImtpZCI6IjIwMjMtMDUtMDQifQ.eyJzY29wZSI6Im5vdGUtZXhwb3J0IiwibmlkIjoiSl96THMwMjJ3Ukx6UnUiLCJpYXQiOjE3NjU2ODYxNzYsImlzcyI6Imh0dHBzOi8vc2xpdGUuY29tIiwianRpIjoieXdDSUpZUlhoZ2JKUV8iLCJleHAiOjE3NjgyNzgxNzZ9.s03Znr24p_jV2XjIuBskdUUfAV0YLqNzISY6WlDS8xo
Please select one of the options below: -

PLACEMENT

GET

Method:
BaseURL: {{publicApiUrl}}/Placement/{{accountReference}}/{{businessUnitReference}}/Placement_REF
To retrieve details for a specific placement. To retrieve placement details, users would need to pass account and business unit reference to the base URL, along with the placement reference.
Account
  • Cannot be Null
  • Cannot be left blank
Business Unit
  • Cannot be Null
  • Cannot be left blank
Placement
  • Cannot be Null
  • Cannot be left blank

Placement Add

Method:

https://slite.com/api/files/tbOg7glT-KaRIt/imported-image?apiToken=eyJhbGciOiJIUzI1NiIsImtpZCI6IjIwMjMtMDUtMDQifQ.eyJzY29wZSI6Im5vdGUtZXhwb3J0IiwibmlkIjoiSl96THMwMjJ3Ukx6UnUiLCJpYXQiOjE3NjU2ODYxNzYsImlzcyI6Imh0dHBzOi8vc2xpdGUuY29tIiwianRpIjoieXdDSUpZUlhoZ2JKUV8iLCJleHAiOjE3NjgyNzgxNzZ9.s03Znr24p_jV2XjIuBskdUUfAV0YLqNzISY6WlDS8xo
Base URL: {{publicApiUrl}}/Placement/{{accountReference}}/{{businessUnitReference}}
To add a placement record using the public API you need to pass the account and business unit reference to the base URL with the required objects in the body. Refer to  Appendix K⁠  containing a sample of the request body.
Account
  • Cannot be Null
  • You must select an existing Account to add a placement
Business Unit
  • Cannot be Null
  • You must select an existing Business Unit to add a placement
The key dependencies and validations are:
"Reference":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a placement reference
"WorkerReference":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a worker reference
"CustomerReference":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a customer reference
"StartDate"":string"
  • Cannot be null
  • Cannot be blank
  • You must input a placement start date
  • Acceptable format: 2022-02-02T00:00:00
"EndDate"."string"
  • Cannot be null
  • Cannot be blank
  • You must input an expected placement end date
  • Acceptable format: 2022-02-02T00:00:00
"PlacementType":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a placement type
"approveTimesheets":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a value for approve timesheet field
"BackingData":"string"
Backing data records can only be added if they are enabled in the billing scheme
  • Can be null (if allowed in the billing scheme)
  • Or input the following object in the body
"backingData": {
"consultantReference": "CS1000002",
"costCentre": "CS1000005",
"purchaseOrder": "CU10005A",
"industrySector": "IS0000001",
"jobClassification": "JC0000001",
"jobTitle": "JT0000001",
"HiringManagerContact": "3DD",
"WorkLocationAddress": "3DD",
"BillingAddress": "3DD",
"BillingContact": "3DD",
"externalReference": "EXT-1234",
"hasConsultantSplits": false,
"customBackingData": null
},
"placementRates":"string "
Placement Rates records are optional to provide.
  • Can be null
  • Cannot be blank
  • If Placement Rates records are provided following dependencies will apply
  • Description can be null
  • rateReference cannot be null or blank
  • Pay VAT code cannot be null or blank; acceptable values are “V0”, “V1”, “V2”
  • Bill VAT code cannot be null or blank; acceptable values are “V0”, “V1”, “V2”
  • Pay Rate cannot be null or blank. A valid number must be provided
  • Bill Rate cannot be null or blank. A valid number must be provided
  • Recurring Rate cannot be null or blank; accepted values are “false”, “true”
  • Default Number of Units can be null; else users must provide a valid number
  • Unit reference can be null; else accepted values are “Miles”, “Hour”, “Day”, “Week”, “Month”, “N/A”, “Salary”
  • Created Date can be null, else a valid date & time must be provided
"placementRates": [
{
"description": "Basic Pay",
"rateReference": "1000",
"payVatCode": "V1",
"billVatCode": "V1",
"payRate": 14,
"billRate": 29.01,
"recurringRate": false,
"DefaultNumberOfUnits": "0",
"UnitReference": "Hour",
"createdDate": null
},
{
"description": "Overtime Pay",
"rateReference": "1001",
"payVatCode": "V1",
"billVatCode": "V1",
"payRate": 22.04,
"billRate": 39.10,
"recurringRate": false,
"DefaultNumberOfUnits": "0",
"UnitReference": "Hour",
"createdDate": "2022-02-07T11:04:23.487",
"Delete": false
}
]

Placement Update

Method: 
Base URL: {{publicApiUrl}}/Placement/{{accountReference}}/{{businessUnitReference}}
To update a placement record using the public API you need to pass the account and business unit reference to the base URL with the required objects in the body. Refer to  Appendix L⁠  containing a sample of the request body.
Account
  • Cannot be Null
  • You must select an existing Account to add a placement
Business Unit
  • Cannot be Null
  • You must select an existing Business Unit to add a placement
The key dependencies and validations are:
"Reference":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a placement reference
"WorkerReference":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a worker reference
"CustomerReference":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a customer reference
"StartDate":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a placement start date
EndDate:"string"
  • Cannot be null
  • Cannot be blank
  • You must input an expected placement end date
"PlacementType":"string"
  • Cannot be null
  • Cannot be blank
  • You must input a placement type
"approveTimesheets":"boolean"
  • Cannot be null
  • Cannot be blank
  • You must input a value for approve timesheet field
"BackingData":"string"
Backing data records can only be added if they are enabled in the billing scheme
  • Can be null (if allowed in the billing scheme)
  • Or input the following object in the body
"backingData": {
"consultantReference": "CS1000002",
"costCentre": "CS1000005",
"purchaseOrder": "CU10005A",
"industrySector": "IS0000001",
"jobClassification": "JC0000001",
"jobTitle": "JT0000001",
"HiringManagerContact": "3DD",
"WorkLocationAddress": "3DD",
"BillingAddress": "3DD",
"BillingContact": "3DD",
"externalReference": "EXT-1234",
"hasConsultantSplits": false,
"customBackingData": null
},
"placementRates":"string"
Placement Rates records are optional to provide.
  • Can be null
  • Cannot be blank
  • If Placement Rates records are provided following dependencies will apply
  • Description can be null
  • rateReference cannot be null or blank
  • Pay VAT code cannot be null or blank; acceptable values are “V0”, “V1”, “V2”
  • Bill VAT code cannot be null or blank; acceptable values are “V0”, “V1”, “V2”
  • Pay Rate cannot be null or blank. A valid number must be provided
  • Bill Rate cannot be null or blank. A valid number must be provided
  • Recurring Rate cannot be null or blank; accepted values are “false”, “true”
  • Default Number of Units can be null; else users must provide a valid number
  • Unit reference can be null; else accepted values are “Miles”, “Hour”, “Day”, “Week”, “Month”, “N/A”, “Salary”
  • Created Date can be null, else a valid date & time must be provided
"placementRates": [
{
"description": "Basic Pay",
"rateReference": "1000",
"payVatCode": "V1",
"billVatCode": "V1",
"payRate": 14,
"billRate": 29.01,
"recurringRate": false,
"DefaultNumberOfUnits": "0",
"UnitReference": "Hour",
"createdDate": null
},
{
"description": "Overtime Pay",
"rateReference": "1001",
"payVatCode": "V1",
"billVatCode": "V1",
"payRate": 22.04,
"billRate": 39.10,
"recurringRate": false,
"DefaultNumberOfUnits": "0",
"UnitReference": "Hour",
"createdDate": "2022-02-07T11:04:23.487",
"Delete": 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.