Account - API Requests

This document provides information about the PurePro public API endpoints associated with account operations and their objects.
Common operations;
Please select one of the options below: -

Account

GetAccount

Method:
BaseURL: {{publicApiUrl}}/Account/GetAllAccounts
To get details of all the accounts a user has access to. This endpoint also retrieves the control job statuses for all accounts, a user has access to.

GetCurrentPeriod

Method:
BaseURL: {{publicApiUrl}}/Account/GetCurrentPeriod/{{accountReference}}
To get details of current period in an account via public API you need to pass the account to the base URL.
Account
  • Cannot be Null
  • You must select an existing Account

GetBusinessUnit

Method:
BaseURL: {{publicApiUrl}}/Account/GetBusinessUnit/{{accountReference}}/{{businessUnitReference}}
To get details of a business in an account via public API you need to pass the account to the base URL.
Account
  • Cannot be Null
  • You must select an existing Account
Business Unit
  • Cannot be Null
  • Cannot be left blank

GetProcessingStatus

Method:
BaseURL: {{publicApiUrl}}/Account/ProcessingStatus/{{accountReference}}/{{businessUnitReference}}
To get status of processes in a period for an account via public API you need to pass the account to the base URL.
Account
  • Cannot be Null
  • You must select an existing Account
Business Unit
  • Cannot be Null
  • Cannot be left blank

GetControlJobsStatus

Method:
BaseURL: {{publicApiUrl}}/Account/GetControlJobs/{{AccountRef}}/PeriodID
To get details of all control jobs in a period for an account via public API you need to pass the account and periodid to the base URL.
Account
  • Cannot be Null
  • You must select an existing Account
PeriodID
  • Cannot be Null
  • Must be a valid Period ID
if the P60/P45 job is not completed or has failed, the API will return the following:
if the P60 job and P45 are completed, the API will return the following:
if the P60 job or P45 is still processing, then API will return the following:
For further information, please refer to our  💼Control Centre  guide.


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.