Skip to main content
Sign in
Français

APIs Purchase Requests and Purchase Orders

  • Updated

Purchase request (PR) and Purchase order (PO) APIs are part of LittleBig Connection APIs and help you in the Procure stage of your project lifecycle. Let’s see in this article when and how you can use them, and which information they include.

 

Within this article

.

Presentation of Purchase Requests and Purchase Orders APIs

These APIs allow you to manage upcoming and ongoing projects in sync with your internal tools.

Indeed, once an Operational manager has selected an expert, they may need to create a Purchase Request and have it validated by your procurement department (optional). Instead of having to duplicate the information on LB platform to your internal tool, the PR API can connect LittleBig platform with your e-procurement tool so that the PR is created and validated/rejected only once in your tool. The decision is then reported into LB platform.

Then, after PR validation (if any) or directly after the profile selection, the corresponding PO is automatically generated to allow your procurement department to allocate the resources required for the project. Some information may need to be added to this PO, and instead of going back and forth between your tools and LittleBig platform, the PO API can streamline these actions.

 

Here is an example of when to use the two APIs when the PR feature is activated:

EN_PR_PO_API_with_PR.svg

 

Here is an example of when to use the PO API when the PR feature is not activated:

EN_PR_PO_API_without_PR.svg

.

Using Purchase Requests (PR) API

.

Search of ongoing PRs

With the API call operation SearchPurchaseRequest, you can filter the ongoing Purchase Requests. You may also be able to do a search for a specific period of dates/time, to narrow down the scope of the results. You may check the API documentation page to have more details on the topic of search criteria.

The response you will receive contains information of the Purchase Requests matching the criteria below:

.

Update of a PR (validation/rejection/external number addition)

After retrieving ongoing Purchase Requests, with the API call operation UpdatePurchaseRequest, you can update PRs' details (adding an external identifier) and either approve or reject them.

If your request is successful, the response will contain the updated information for the Purchase Request in question. Otherwise, an error message will be shown.

.

Using Purchase Orders (PO) API

Once the Purchase Order is generated, it will then be possible to access the data it contains via the API, with the purpose of synchronizing it to your internal systems.

It will also become possible for some of those details to be modified and to add attachments. 

.

Retrieval of ongoing POs

With the API call operation SearchPurchaseOrders, you can filter out the ongoing Purchase Orders. You may carry out searches, specifying a specific timeframe (date/time), in order to reduce the scope of the results shown. Have a look at the API Documentation page to have more details on the search criteria. 

The response you will receive contains the information of the Purchase Orders that matches the below criteria:

  • Purchase order ID
  • Project ID
  • Renewal ID
  • Issuing entity and Legal entity
  • Status
  • Ongoing request
  • Project title
  • Profile Code (if any) 
  • Project Codes (if any) 
  • Start and end dates
  • Work unit information (number type, and price) 
  • Attached file (Client PO)
  • Operational manager and Buyer information
  • Activity reports generated
  • Supplier information (Business manager and Consultant)
  • Daily fees (if any)
  • Spending lines
  • Custom fields (if any)

.

Update of a PO

With the API call operation UpdatePurchaseOrder, you may update the information of the Purchase Order (adding an identifier to the PO and/or the consultant), once it has been retrieved. 

If the request is successful, the response will contain the updated Purchase Order. Otherwise, an error message will be displayed.

.

Attach files to a PO

The API feature offers you the option of uploading and attaching documents to your Purchase order thanks to the API call operation UploadPurchaseOrderDocument.

If the request is successful, the response body will contain a message saying that the file has been added to the PO. Otherwise, an error message will be displayed.

Related articles