APIs Activity Reports and Service Receptions
Activity Reports and Service receptions APIs are part of LittleBig Connection APIs and help you in the Control stage of your project lifecycle. Let’s see in this article when and how you can use it, and which information it includes.
Within this article
- Presentation of Activity Reports and Service Receptions APIs
- Using Activity Reports (AR) API
- Using Service Receptions API
.
Presentation of Activity Reports and Service Receptions API
These APIs allow you to control in one place the hours worked reported by your consultants to ensure the success of your projects. Indeed, your Consultants will be able to enter the days worked, overtime and expenses on your suppliers' portal, and it will then be automatically synchronized with LittleBig platform thanks to AR API. And once the AR has been validated, you can use the Service Reception API as a final verification step before triggering the invoicing.
You can activate either or both of the APIs, and use them at the following moments:
For more information on the AR validation process, please read this article.
.
Using Activity Reports (AR) API
.
AR submission by the Consultant
The AR is created within the LittleBig Connection platform, it becomes then possible to fill it in. The information it includes may be updated directly from the Supplier's LittleBig Connection account, alternatively the task may be delegated to your organization's portal. Depending on the case, the original status of the AR that you can track from the platform, will vary:
If the AR is to be filled in within the LittleBig Connection account of your supplier | If the AR update is delegated to your organisation's portal | |
Status on LB platform | Pending | Pending transmission |
API information |
Status: notValidated Detail: pendingConsultantValidation |
Status: notValidated Detail: pendingTransmission |
Follow-up actions | The consultant must fill in and submit the AR | The consultant must then confirm their Activity Report and expenses incurred* |
*In order for the consultant to submit their AR via your portal, your internal tools must first be able to retrieve the pending Activity Reports, then import it into your portal so that the consultant may view and validate the data.
To retrieve these pending ARs, you can use the API call operation SearchActivityReports, and filter out the Activity Reports that have not yet been validated, for a period of a specific month or year. Have a look at the API Documentation page to have more details on the search criteria.
The response you will receive contains information from the AR that matches the following criteria:
|
|
On this step, only Activity Reports that are on Pending Transmission status detail should be considered.
.
AR approval by the Business manager
Once the consultant has submitted their AR, you may use the API call operation UpdateActivityReport to be able to send the information back to the LittleBig platform, with the purpose of allowing the validation by the consultant's Business manager.
Once this sync has been done, the Business manager can manually approve or reject the Activity Report on LittleBig platform, and the Activity Report status will be updated accordingly:
When the Activity Report is approved by the Business Manager | When the Activity Report is rejected by the Business Manager | |
Status on LB platform | Validated by the Business Manager | Rejected by the Business Manager |
Status in the API |
Status : notValidated Detail: validatedBySeller |
Status : notValidated Detail: refusedBySeller |
Follow-up actions | The Operational manager approves or rejects the AR | The consultant corrects and submits the AR once again |
.
AR validation by the Operational manager
After approval of the AR by the Business manager, the Operational Manager on the Client side will review it and either approve it or reject it, and the status will be updated accordingly:
When the AR is validated by the Operational manager | When the AR is rejected by the Operational manager | |
Status on LB platform | Validated by the Operational Manager | Rejected by the Operational Manager |
Status in the API |
Status : notValidated Detail: validatedByManager |
Status : notValidated Detail : refusedByManager |
Follow-up actions | The Service Reception can take place | The consultant must correct and submit their Activity Report again |
.
Using Service Receptions API
After the validation of the AR by the Operational manager, you may send a Service Reception update request to LittleBig's API to either confirm or reject the Activity Report, thanks to the API call operation UpdateServiceReception.
When the Activity Report is validated by your internal system | When the Activity Report is rejected by your internal system | |
Status on LB platform | Validated by your internal Information System |
Rejected by your internal Information System + pending Operational Manager |
Status in the API |
Status : Validated Detail: validatedByExternalSi |
Status : Rejected Detail : refusedByExternalSi |
Follow-up actions | None, the AR of the month is validated and the invoicing process starts | The Operational manager checks the AR and can resend a service reception or can reject the AR so that the consultant correct it |