Introduction
This guide aims to walk you through the process of effectively utilizing the Chorus Pro integration with Cirrus Shield.
Prerequisites
Before you can start using the service, you will need to do the following steps:
In Chorus Pro
- Create a Chorus Pro Account
- Create a chorus pro account by signing in to the chorus pro portal, here is the link:https://portail.chorus-pro.gouv.fr/aife_csm?id=aife_index
- Create a Chorus Pro technical account
After successfully setting up your Chorus Pro account, it’s essential to establish a technical account if you haven’t already. This technical account will be used for making API calls on the Chorus Pro API to take advantage of its features. Follow these steps to create the technical account:
a. Navigate to the Home tab and select the “Connections” box. Click on the “Technical Account Access Service” button.
b. Within this service, you can perform various requests. For creating a technical account, click on the dropdown menu and choose “Creation of a technical account.” Next, go to the Structures dropdown and select the structure for which you want to create a technical account.
c. Retrieve the provided “Login” and “Password” credentials. Save this information locally for future use. Afterward, click the “Submit” button.
Upon successful creation of the technical account, allow 20-30 minutes for it to become ready for use.
3. Create a Piste Account
Create a piste account by signing in to the piste website, here is the link https://developer.aife.economie.gouv.fr/component/users/login When the creation of the account is successful, you will be able to see a sandbox application being automatically created for test cases by going to the “Applications” tab.
4. Create a production application on Piste
Create an application on piste so it will be linked to chorus pro so we can be able to use the chorus pro features, here are the steps to follow:
a. Navigate to the “Applications” tab
b. Click on the “Create Application” button
c. Enter the necessary information, then click on the “Save Application” button
d. Select the APIs below so you can use them: “Factures”, “Structures” and “Transverses”, then click on the “Apply Changes” button. This page can be accessed directly after you create the application
- Piste – Chorus Pro Connection
First, make sure to have the necessary permissions for the Piste-Chorus Pro connection to work. Here are the steps::
a. Go to the Chorus Pro portal and click on the “Organisation” box, then select the “Users” Domain, and then the “Manage user permissions access service”
b. Make sure to add the permissions “Raccordements modification” and “Raccordements consultation” to the user you want to log in with.
After successfully creating the application and technical account, proceed with connecting them to leverage Chorus Pro features. Here are the steps:
a. Go to the Chorus Pro portal and click on the “Connections” box, then select the “API” box to access the cpro portal
b. Click on the “Manage API connection” tab for the linking process. Ensure you have the exact name of the application created with the technical account’s “Login” credential.
N.B : You can have one active link only
c. Click on “Declaration API connection request by PISTE,” fill in the necessary information, and then click “Validate.”
The connection between Piste and Chorus Pro has been successfully established. Confirm the thoroughness of your Cirrus Shield configuration. For detailed guidance, please refer to the Chorus Pro Admin Guide.
Send Invoice to chorus pro
One of the features of the integration is to send an invoice to chorus pro. To do so, you have to create an invoice record so you access the send invoice button
Upon clicking the button, a popup will appear, displaying various fields based on the invoice. If the invoice is exonerated, an additional field will be presented
Exonerated:
In case of errors on the invoice:
If there are no issues, utilize the preview feature by selecting a document from the dropdown and clicking on the eye icon.
After confirming the correctness of the invoice, click on the “Send Invoice to Chorus Pro” button
The invoice is now placed in a queue, and after a specified period, it will be sent to Chorus Pro. Track the process using the Chorus Pro Status field within the specific invoice element in Cirrus Shield.
Recycle Invoice
In scenarios where an invoice was mistakenly sent to the wrong funder, you can utilize the “Recycle Invoice” feature.
Upon clicking on the button, it will open the popup to have the possibility to change the code service of the funder, and also to add a comment if needed.
After clicking the “Recycle Invoice” button, the invoice is placed in the queue. It will be resent to Chorus Pro after a specific period, allowing for the correction of the funder information.
