EXTERNAL SPECIFICATION CHORUS PRO API ...

1 / 557

[External Specification Folder Chorus Pro] [API Connection Mode Appendix] – [V4.10]

BERCY 3 10, RUE DU CENTRE 93464 NOISY-LE-GRAND CEDEX Standard: (+33) 1 57 33 F99 00

EXTERNAL SPECIFICATION

CHORUS PRO

API CONNECTION MODE APPENDIX

2 / 557


Version - Date Issuer Status/Track changes

V4.10

14/11/2018 AIFE

Modification of the services consulterFactureParFournisseur,

completerFacture, refuserFactureTravaux and recyclerFactureTravaux :

Update of the input data table (deletion of the attributes numeroFacture,

identifiantFournisseur and typeIdentifiantFournisseur)

Correction of the service recyclerFacture :

Addition of the following error messages : from 20004 to 20014

Correction of the service soumettreFacture :

The pieceJointePrincipaleId attribute can also be provided by the service

ajouterFichierDansSysteme

Update of the input data table (management rules and multiplicity of the

montantTtcTotal attribute, management rules of the montant RemiseGlobaleTtc

attribute)

Update of the error messages table (errors 20013, from 20303 to 20305)

Correction of the service soumettreFactureTravaux :

Update of the error messages table (addition of the following errors : from 20003

to 20005, 20042, 20064, 20065, from 20127 to 20129, from 20131 to 20134)

Correction of the service rechercherFactureParFournisseur :

Update of the input data table (addition of the attributes

periodeDateHeureEtatCourantDu and periodeDateHeureEtatCourantAu, deletion of

the attribute idUtilisateurCourant)

Update of the output data table (addition of the attributes dateHeureEtatCourant

and commentaireEtatCourant)

Update of the error messages table (addition of the error 20003)

Correction of the service rechercherFactureParRecipiendaire :


rechercheSirenDestinataire, periodeDateHeureEtatCourantDu and

periodeDateHeureEtatCourantAu)



Update of the error messages table (addition of the errors 200, 400 and 20001)

Correction of the service rechercherFactureTravaux :







Correction of the service rechercherDemandePaiement :

Update of the input data table (addition of the attributes rechercheSirenDestinataire

and rechercheSirenFournisseur)

Update of the output data table (addition of the attribute commentaireEtatCourant)


Correction of the service consulterSollicitation :

Update of the output data table (addition of the attribute historiqueDetaille and

update of the attribute historique)

Update of the services rechercherSollicitationsEmises,

rechercherSollicitationsRecues, repondreSollicitation:

Update of the input data table (addition of the enumeration of values of the

attribute statut)

Update of the service consulterSollicitation:


attribute statut)

3 / 557


V4.01

14/09/2018 AIFE

Modification of the management rule applied on the attribute

numeroFactureSaisi of the service soumettreFacture. The numeroFacture is

automatically generated by the Chorus Pro system (2.2.1.4)

Modification of the description of service deposerFluxFacture : the maximal

size of compressed flow is 30 Mo if and 10 Mo if the flow is not compressed

(2.2.1.1)

Modification of the calculation method for the field montantTtcTotal of the

service soumettreFacture (2.2.1.4)

V4.00

04/06/2018 AIFE

Addition of a summary table on API § 2.1

Addition of references to every API method for each API

Removal of the management rule G2.10 relating to the intra-community VAT

number

Transfer of Chapter 6 from External Specification Chorus Pro document

introducing API services and sequence charts (§ 1)

Correction of the service RechercherServicesStructures:

Removal of the attribute nbrResultatMaximum

Removal of part 1.2.2 User Assistance

Removal of part 1.2.5 Input and output tables of the API services

Removal of part 1.2.6 Flow monitoring

Removal of part 1.2.7 Commitment management

Removal of part 1.2.8 Input and output tables of referentials and transversal

services

Removal of the CII14B references

4 / 557


Foreword ................................................................................................................................................... 5 1 Presentation of the service mode ........................................................................................................... 6

1.1 The operating principle of the APIs ...................................................................................... 6 1.1.1 Presentation of the service offering ......................................................................... 6 1.1.2 API exchange formats ........................................................................................... 7 1.1.3 Content negotiation .............................................................................................. 7 1.1.4 Returned codes of API requests .............................................................................. 7 1.1.5 Documentation .................................................................................................... 7

1.2 The services offered in the API ............................................................................................ 7 1.2.1 Management of payment requests .......................................................................... 8 1.2.2 Management of users and structures .................................................................... 34

1.3 Qualification of services ................................................................................................... 48 2 Input, output and error tables of the services offered in the API .............................................................. 49

2.1 Summary table ............................................................................................................... 49 2.2 Simple invoice ................................................................................................................ 52

2.2.1 Invoice to issue ................................................................................................. 52 2.2.2 Process an issued invoice .................................................................................... 69 2.2.3 Process a received invoice ................................................................................. 110 2.2.4 Process an invoice to validate ............................................................................ 156 2.2.5 Retrieve invoice information .............................................................................. 210

2.3 Work invoice ................................................................................................................ 229 2.3.1 Initiate or complete an invoice file ...................................................................... 229 2.3.2 Process a work invoice ...................................................................................... 299 2.3.3 Process a work invoice in error ........................................................................... 307

2.4 User and structure management ..................................................................................... 317 2.4.1 Manage areas from my structure/service ............................................................. 317 2.4.2 Manage my structure ........................................................................................ 329 2.4.3 Manage my service .......................................................................................... 372 2.4.4 Manage my user account .................................................................................. 391 2.4.5 Manage connections and subscriptions ................................................................ 422

2.5 Data flow overview ....................................................................................................... 454 2.5.1 Consult account ............................................................................................... 454 2.5.2 Consult detailed account ................................................................................... 457

2.6 Commitment number management ................................................................................. 459 2.6.1 Consult the details of a commitment ................................................................... 459 2.6.2 Search for a commitment number ...................................................................... 464 2.6.3 Retrieve the status of a commitment .................................................................. 468 2.6.4 Retrieve the type of a commitment ..................................................................... 469

2.7 Request management .................................................................................................... 470 2.7.1 Common services of all requests ........................................................................ 470 2.7.2 Issued requests ............................................................................................... 487 2.7.3 Received requests ............................................................................................ 490

2.8 Cross-functional and reference services ............................................................................ 492 2.8.1 Manage the attachments ................................................................................... 492 2.8.2 Search for elements in the directory ................................................................... 511 2.8.3 Table of references........................................................................................... 523 2.8.4 References tables for processing received invoices ................................................ 546

3 Track Changes ................................................................................................................................. 551

5 / 557


FOREWORD

This appendix relative to the API connection introduces to the connection rules and opportunities offered by the API mode. In the first chapter, every offered service is described through clear sequence charts. In the second chapter, input and output tables as well as error tables available with the API specify the cardinality of the attributes, management rules and the formats linked to the attributes. They also define the usable referentials in order to make easier the right use of associated attributes.

Furthermore, the appendix delivers examples of JSON and WADL files. They are needed to develop the right connection mode for API. They are updated and published at every additional development of Chorus Pro. They respect the integration rules of the solution that are specified in the External Specifications Chorus Pro document.

6 / 557


1 PRESENTATION OF THE SERVICE MODE

1.1 The operating principle of the APIs

1.1.1 Presentation of the service offering

1 Issued invoices/Works invoices/Invoices to validate/Received invoices/Received requests/Issued requests/

Flow tracking and qualification/Users and structures/Account/ICT reimbursements/Memoranda on justice

costs/

Commitments

The Service mode (via the APIs) allows the use of all the functions available to the users of Chorus Pro in

Portal mode from the IT tools already deployed at the partner structures. There are two possible methods of

integration:

Integration into the information systems of the partner organisations: The APIs are integrated directly

into the information and management systems of the structures transmitting and receiving invoices.

Users benefit directly from the functionalities of the solution from their usual computing tools.

Integration into third party portals: certain public entities already use third party portals, offering

various value-added services to their suppliers (for example: merging with an order or delivery).

These portals can also offer features from Chorus Pro to their users. The authentication of users

connecting from a third party portal is done through France Connect Enterprises.

7 / 557


1.1.2 API exchange formats

The recommended formats for API exchanges are mainly XML and JSON formats. The documentation

relative to each API indicates the right format depending on the response sent. By using HTTP POST

method, the format of the content must be precisely detailed. It must correspond to the right format

expected by the matching API.

The language used in these exchanges is generally French in the back format and UTF-8 for encoding

content.

The request formats are:

- For JSON type: application/json;

- For XML: test/xml, application/xml, application/xhtml+xml.

1.1.3 Content negotiation

In the case of another format is required during an API exchange, by using headers Accept (ie: Accept,

Accept-Encoding, Accept-charset…), if the service is not able to produce this format, a code 406-Not

accepted format is returned.

1.1.4 Returned codes of API requests

The HTTP returned codes are following:

Code retour Description

200 Successful request

400 Badly formulated request

401 Authentification informations missing

403 Certificate missing or unknown

404 Page not found

406 Format not accepted

429 The customer has sent too much requests in a given delay

500 Server intern error

503 Unavailable service

504 Exceeded waiting time

Additional informations (mainly functional) appear in the detailed response depending on the API. More

informations in API technical documentation.

1.1.5 Documentation

API documentation is available by using the following address:

https://communaute.chorus-pro.gouv.fr/documentation/api/

1.2 The services offered in the API

All of the features available on the portal of Chorus Pro will also be available in Service mode. These features

have been grouped into six areas:

1. Management of payment requests

https://communaute.chorus-pro.gouv.fr/documentation/api/

8 / 557


2. User assistance1

3. Management of users and structures57

4. Qualification57

5. References and cross-services57

6. Management of commitments

The input and output tables presented below correspond to the state of development of the API at the

moment of the publication of this version of external specifications and are therefore likely to be modified in

order to take into account the reviews from our partners. They provide information concerning the

cardinality of the attributes, the management rules and the format of the attributes.

Furthermore, examples of JSON and WADL files are provided as annex of the external specifications. Those

examples are updated regularly.

1.2.1 Management of payment requests

Overview of the services

1 The features available in these areas will be described in a later version of the external specifications

9 / 557


1.2.1.1 Kinematics of use: Issued invoices

The services of the "Issued invoices" domain provide access to the features of the issued invoice area of

Chorus Pro. In particular, they allow a user to enter, submit or transmit an invoice flow. They also offer

assistance for the transmission of invoices offered on the portal: recycling of invoices, removal of rejected

invoices and modification of the validator of the invoice. They enable users to search for an invoice that was

previously issued to Chorus Pro, to view its data and history, and to download it.

10 / 557


1.2.1.1.1 Search for and view an invoice

11 / 557


Usage case 1.1.1: Search for one or more invoices

A supplier wants to search for an invoice submitted in Chorus Pro, download the invoices matching the search

parameters or view the details of one of those invoices.

12 / 557


Variant

A supplier wants to download n invoices submitted in Chorus Pro. It is possible, in order to respect the

limitations in terms of size of the request “telechargerGroupeFacture”, to call this request n times and

download the invoices on a unitary basis.

13 / 557


Usage case 1.1.2: View the details of an invoice

A supplier wants to view the information concerning an invoice submitted in Chorus Pro. From this screen,

they can download the invoice and/or its attachments, view the history of the actions pertaining to the invoice

or initiate the processes that allow them to complete or recycle the invoice.

1.2.1.1.2 Enter or submit an invoice

14 / 557


Usage case 1.1.3: Recover invoicing data of a recipient

A supplier wants to recover invoicing data of a recipient linked to the SIRET identifier of the French State by

using API from a third party information system or a value-added third party portal.

Variant

A supplier wants to recover invoicing data of a recipient not linked to the SIRET identifier of the French State

by using API from a third party information system or a value-added third party portal.

15 / 557


Usage case 1.1.4: Enter an invoice

A supplier wants to enter an invoice from a third party information system or a value-added third party portal.

Usage case 1.1.5: Submit an invoice in PDF format

A supplier submits an invoice on Chorus Pro from a PDF file previously created from their information system.

16 / 557


Usage case 1.1.6: Submit an invoice or a batch of invoices from a structured flow

A supplier submits a structured flow previously generated from their information system on Chorus Pro.

1.2.1.1.3 Perform an action on a transmitted invoice

17 / 557


Usage case 1.1.7: Process an invoice with a "suspended" status

A supplier wants to complete an invoice marked as "suspended" by adding additional attachments and/or by

filling in an additional comment.

Usage case 1.1.8: Process an invoice with a "rejected" (recipient error) status

A supplier wants to recycle an invoice marked as "rejetée" when the rejection arises from an "erreur dans les

données d’acheminement". For this, the supplier assigns a new recipient/recipient service.

Usage case 1.1.9: Process an invoice with a "rejected" (wrong validator error) status

A supplier wants to recycle an invoice marked as "rejetée" when the rejection arises from an "erreur dans les

données d’acheminement". For this, the supplier assigns a new validator/validator service.

18 / 557


1.2.1.2 Kinematics of use: work payment requests

The services of the "Work invoices" domain provide access to the features of the work invoice area of Chorus

Pro. In particular, they allow a user to transmit an invoice flow. They enable users to search for a work invoice

that was previously issued to Chorus Pro, to view its data and history, and to download it. They also offer

assistance for the transmission of invoices offered on the portal: recycling of invoices, removal of rejected

invoices and modification of the validator of the invoice.

19 / 557


1.2.1.2.1 Search for and view a work invoice

Usage case 1.2.1: Search for one or more work invoices

A user wants to search for a work invoice for which a validation or another action is awated from the user in

Chorus Pro. The user can perform a multicriteria search or view the details of one of those invoices.

20 / 557


Usage case 1.2.2: View the details of an invoice

A user wants to view the information concerning a work invoice in Chorus Pro. From this screen, the user can

download the invoice and/or its attachments, view the history of the actions pertaining to the invoice.

21 / 557


1.2.1.2.2 Initiate an invoicing file

22 / 557


Usage case 1.2.3: Submit a work invoice

A user submits on Chorus Pro a billing record by submiting a work invoice without previous invoicing document.

1.2.1.2.3 Perform an action on an existing invoicing file

23 / 557


Usage case 1.2.4: Associate a work invoice

The user completes an invoicing file by adding a new invoicing document

Usage case 1.2.5: Refuse a work invoice

The user refuses a work invoice.

Usage case 1.2.6: Take into account a work invoice

In the case of a monthly statement draft of a subcontractor, the project manager can end the actions on an

invoicing file by reporting that he or she took into account the work invoice.

24 / 557


1.2.1.2.4 Perform an action on an erroneous invoicing file

Usage case 1.2.7: Process a work invoice with the status « Suspendue » [Paused]

The user completes a work invoice with the status « suspendue » [Paused] by adding attachments and/or

adding a new comment.

25 / 557


Usage case 1.2.8: Process a work invoice with the status « Rejetée » (erreur

d’acheminement)

The user wants to recycle an invoice marked as "rejetée" when the rejection arises from an "erreur dans les

données d’acheminement". For this, the supplier assigns a new recipient/recipient service.

Usage case 1.2.9: Process a work invoice with the status « Rejetée » (erreur valideur)

If an invoice is rejected due to a routing error to the validator (non-existent validator in the database of Chorus

Pro or an error in the selection of a validator), the supplier may:

- Delete the invoice. The invoice is also removed from Supplier’s tax list.

- Change the indicated validator.

26 / 557


Usage case 1.2.10: Complete or correct the project manager of a work invoice

It is possible de correct the informations of a project manager if an invoice is rejected due to a routing error to

the project manager.

If the invoice is sent by a subcontractor or if the project manager is not designated in the invoice and the validator

did not proceed the invoice before the legal term, the subcontractor cas complete the invoice with the routing data

of the project manager

27 / 557


1.2.1.3 Kinematics of use: Received invoices

The received invoices services provide access to the received invoices area of Chorus Pro. This service

incorporates all of the functionalities offered by this area. In particular, it allows a user to search for and view

an invoice for which the user is the recipient and to process the received invoices. The number of invoices thus

transmitted by Chorus Pro is unlimited and depends on the call parameters of the public entity.

28 / 557


Usage case 1.3.1: Research invoices

A recipient wants to search for a received invoice in Chorus Pro, download invoices matching the search

parameters or view the details of one of the invoices found.

Variant

A recipient wants to download n invoices submitted in Chorus Pro. It is possible, in order to respect the



29 / 557


Usage case 1.3.2: Consult invoice details

A recipient wants to view the information concerning a received invoice in Chorus Pro. From this screen, they

can download the invoice and/or its attachments, view the history of the actions pertaining to the invoice or

initiate the process that allows them to process the invoice.

Usage case 1.3.3: Process received invoice

A recipient wants to update the status of a received invoice according to the treatment that has been conducted.

The recipient can, after viewing a received invoice, change the status of the received invoice:

- “Mise en paiement” [Payment]

- “Suspension, et attente de nouveaux éléments” [Paused]

- “Rejet” [Rejected]

- “Mise à disposition du service comptable” [Available to accountant]

- “Mandatée” [Mandated]

30 / 557


1.2.1.4 Kinematics of use: Invoices to be validated

The services of the "invoices to be validated" domain provide access to the features of the invoice to be

validated area of Chorus Pro. They enable users to search for an invoice that was previously issued to Chorus

Pro, to view its data and history, to download it and to treat invoices of which they are validators.

31 / 557


Usage case 1.4.1: Search for one or more invoices

A validator wants to search for an invoice to be validated in Chorus Pro, download the invoices matching the

search parameters or view the details of one of those invoices.

32 / 557


Variant

A supplier wants to download n invoices submitted in Chorus Pro. It is possible, in order to respect the



Usage case 1.4.2: View the details of an invoice to be validated

A supplier wants to view the information concerning an invoice to be validated in Chorus Pro. From this screen,

they can download the invoice and/or its attachments, view the history of the actions pertaining to the invoice

or initiate the processes that allow them to validate or not the invoice.

33 / 557


Usage case 1.4.3: Process an invoice to be validated

A validator want to udpate the status os an invoice to be validated depending on the way it was processed.

He can, from the detailed view of the invoice, modify its status:

- Validated

- Refused

In case of a refusal from the validator, a ground for refusal must be informed.

34 / 557


1.2.2 Management of users and structures

1.2.2.1 Kinematics of use

Global view of the services

1.2.2.1.1 Structure management

35 / 557


Usage case 2.1.1: Create a structure

A manager wants to create a new structure with its informations, telephone numbers et parameters.

Usage case 2.1.2: View the details of the structure

A user wants to view the informations, telephone numbers and parameters of a structure.

36 / 557


Usage case 2.1.3: Search for the services and the users of the structure

A manager wants to search and view the services of one or many structure(s).

Usage case 2.1.4: Modify the details of the structure

A manager wants to modify the informations of one or many structure(s) or give rights of principal manager

upon it/them to another user.

37 / 557


1.2.2.1.2 Service management

Usage case 2.2.1: Create a service

A manager wants to create a new service and configure it in a structure he manages.

38 / 557


Usage case 2.2.2: View the details of the service

A manager wants to view the informations and configurations of the service which belongs to one of his

structures.

Usage case 2.2.3: Modify the details of the service

A manager wants to modify the informations and configurations of the service which belongs to one of his

structures.

39 / 557


Usage case 2.2.4: Delete a service

A manager wants to delete a service which belongs to one of his structures.

40 / 557


1.2.2.1.3 User management in a structure

Usage case 2.3.1: Validate or refuse connection requests

A manager wants to validate the connection requests to his structure. He can also activate or desactivate

connections previously validated.

41 / 557


Usage case 2.3.2: Validate or refuse subscription requests

A manager wants to validate the subscription requests from users to areas in his structure.

Usage case 2.3.3: Delete a connection

A manager wants to delete user connection to his structure.

42 / 557


Usage case 2.3.4: Search for users managed by manager

A manager wants to search for users connected to structures whose manager is him.

Usage case 2.3.5: Modify the details of a user

A manager wants to modify the informations of an user account connected to a structure whose manager is

him.

43 / 557


1.2.2.1.4 Area management in a structure/service

Usage case 2.4.1: Add an area

A manager wants to add an area in a structure whose manager is him.

44 / 557


Variant:

A manager wants to add an area in a service which belong to his structure.

Usage case 2.4.2: Search for areas in a structure/service

A manager wants to search for the areas of one of his structures/services.

45 / 557


Variant:

A manager wants to search for an area in a service which belong to his structure.

Usage case 2.4.3: Delete an area

A manager wants to delete an area of one of his structures/services.

Variant:

A manager wants to delete an area in a service which belong to his structure.

46 / 557


1.2.2.2 User account management

47 / 557


Usage case 2.1.1: Subscribe/unsubscribe to an area

A user wants to subscribe from an area in structures connected and unsubscribe from a connected area.

Usage case 2.1.2: Delete connection to a structure

A user wants to delete his connection to a structure.

48 / 557


1.3 Qualification of services

In the "production qualification" environment, a user connected to Chorus Pro can access an API Manager

(DMZ interface) which allows them to qualify the APIs they will call Chorus Pro.

The user can connect to the API Manager by entering a login and a password specific to the qualification area,

identifying the user on Chorus Pro.

Through the API Manager interface, the user can access the list of available services with a description of each

of these services. The user can perform, directly from this interface, usability tests of the services displayed:

- The user views and fills in the expected parameters for each of the services being tested;

- The API Manager returns a response to the user to confirm receipt of the request and the successful

integration of the solution's response into the information system used as API operator by the user.

The user will have a dataset available that is contextualised according to the user profile and kept updated

according to changes made to the solution, which can be mobilised during the qualification of the APIs.

49 / 557


2 INPUT, OUTPUT AND ERROR TABLES OF THE SERVICES OFFERED IN THE API

2.1 Summary table

The table sums up the different services offered in the API. It allows to directly click to the precise input, output or error table. They might be updated if new services are offered.

Simple invoice

Invoice to issue

Submit invoice flow

Submit PDF invoice

Submit invoice

Process an issued invoice

Complete invoice

Consult invoice by supplier

Correct validator invoice

Search invoice to be processed by supplier

Search invoice by supplier

Recycle invoice

Process a received invoice

Consult invoice by recipient

Search invoice to be processed by recipient

Search invoice by recipient

Process received invoice

Process an invoice to validate

Consult invoice by validator

Search invoice to be processed by validator

Search invoice by validator

Retrieve reasons to refuse invoice to be validated

Retrieve invoice statuses noticeable by the

validator

Process invoice to be validated

Retrieve invoice information

Search payment request

Consult invoice history

Download invoice group

Work invoice

Initiate or complete an invoice file

Consult invoice file

Consult work invoice

Search work invoice

Search work invoice to be processed

Submit work invoice

Process a work invoice

Ask to recycle previous attachment

Take a work invoice into account

Refuse work invoice

Suspend or ask to complete work invoice

Retrieve reasons to refuse work invoice

Process a work invoice in error

Complete work invoice

Complete Project Manager

Complete work invoice service Project Manager

Correct validator work invoice

Recycle work invoice

User and structure

management

Manage areas from my

structure/service

Add area

Search area

50 / 557


Delete area

Manage my structure

Consult SIRET information

Consult structure

Consult structure with intra-community VAT

Modify structure

Search structure services

Search structure

Search users connected to structure

Search users managed by manager

Retrieve structures managed by manager

Change primary manager

Enter structure general informations

Download recipient directory

Manage my service

Consult structure service

Modify structure service

Search users connected to service

Enter general information structure service

Delete structure service

Manage my user account

Consult user account

Ask my user account subscriptions

List structure connections user

Modify user by manager

Search for valid users

Retrieve my user account subscriptions

Retrieve my user account connections

Delete my user account subscriptions

Delete my user account structure connections

Manage connections and subscriptions

Activate or deactivate the user connection

to a structure

Search for standby subscription requests by manager

Search for the standby connection requests by manager

Delete user connected to structure

Validate subscription requests by manager

Validate user connection

Retrieve services for standby connection requests

Refuse subscription request by manager

Refuse user connection

Data flow overview Consult account Consult account

Consult detailed account Consult detailed account

Commitment number management

Consult the details of a commitment

Consult the details of a commitment

Search for a commitment number

Search for a commitment number

Retrieve the status of a commitment

Retrieve the status of a commitment

Retrieve the type of a commitment

Retrieve the type of a commitment

Request management Common services of all

requests Add complementary informations in the request

51 / 557


Search for issued requests

Search for received requests

Download requests

Consult requests

Issued requests Enter a request

Received requests Answer a request

Cross-functional and reference services

Manage the attachments

Add file in the system

Get attachment out

Bind an attachment to a structure

Bind an attachment to a user

Search for an attachment on My account

Search for an attachment in a structure

Download an attachment

Search for elements in the directory

Search for a recipient

Search for an executing service

Retrieve executing services of the State

Retrieve services by structure

Retrieve active structures for recipient

Retrieve active structures for work invoices

Retrieve active structures for supplier

Retrieve users of the service

Table of references

Retrieve the invoicing framework

Retrieve currencies

Retrieve flow syntax

Retrieve deposit mode

Retrieve payment means

Retrieve reason for VAT exemption

Retrieve country

Retrieve flow format

Retrieve flow statuses

Retrieve VAT rates

Retrieve types of payment request

Retrieve types of work invoices

Retrieve types of structure identifiers

Retrieve types of attachment

Retrieve types of structure

Retrieve valid bank details

Search for request category

Search for request subcategory

Retrieve structures for user

2.8.4References tables for processing received invoices

Retrieve the status by type of payment request

Retrieve possible statuses for processing

52 / 557


2.2 Simple invoice

2.2.1 Invoice to issue

This chapter shows input, output and error tables for the following methods:

- Submit invoice flow

- Submit PDF invoice

- Submit invoice

2.2.1.1 Submit invoice flow

The method deposerFluxFacture allows to submit a XML file or PDF/A3 giving the opportunity to fill in the data

needed for an invoice flow. The file for the flow must not exceed 120 Mo. If the file exceeds this size, the error

20001 will be sent.

Input table

Attribute Typing (tagger) Format Management rules

Service

providing the

data

Multiplicity

idUtilisateurCourant

Number: technical

id of the current

user in the Chorus

Pro system

integer

This identifier uniquely identifies

the user within the 2017 CPP

system

0-1

fichierFlux

String: file

corresponding to

the invoicing flow,

base64 encoded

file 1

nomFichier String: file name

with the extension

varchar(200

) 1

syntaxeFlux

String: choice of

the syntax of the

file to submit

varchar(24)

9 possible values:

- IN_DP_E1_UBL_INVOICE

- IN_DP_E1_CII_16B - IN_DP_E1_PES_FACTURE - IN_DP_E1_XCBL

- IN_DP_E2_UBL_INVOICE_MIN

- IN_DP_E2_CII_MIN_16B

- IN_DP_E2_CII_FACTURX

- IN_DP_E2_PES_FACTURE_MIN

- IN_DP_E2_CPP_FACTURE_MIN

recupererSynt

axeFlux 1

53 / 557


avecSignatu

re

Boolean:

Precise if the file

has been signed

or not

boolean true: the file is signed

false: the file isn’t signed 0-1

Output table

Attribute Typing (tagger) Format Management rules Multiplicity

numeroFluxDepot

String: deposit number

of the flow contening the

invoice

varchar(2

5)

This data allows the user to uniquely

identify a flow of invoices in the Chorus

Pro system

1

dateDepot String: deposit date of

the flow of invoices date Format: AAAA-MM-JJ 1

syntaxeFlux String: syntax of the flow varchar(2

4)

9 possible values:








1

Error table

Error code Description Associated error message

20000 The anti-virus control service rejected the

file GDP_MSG_11.036

20001

The size of the file must be less than or

equal to the maximum size allowed for a

deposit

GDP_MSG_11.022

20002 The file extension control service rejected

the file GDP_MSG_11.025

20004 The user does not have the necessary

clearances to perform this action. GDP_MSG_11.021

20005 The input data format does not conform to

the format expected by EDI processing. GDP_MSG_11.020

20006 An error occurred while loading the file into

the system GDP_MSG_11.023

20007 The input-supplied file encoding does not

conform to the encoding standard (base64) TRA_MSG_00.020

54 / 557


2.2.1.3 Submit PDF invoice

The method deposerPDFFacture allows to submit a PDF file and initiate character recognition. The interpreted invoice

is in status « INTERPRETEE_OCR ». She will be submitted with the method « soumettreFacture ». The PDF file must

not exceed 10 Mo. If the file exceeds this size, a 413 error will be sent.

Input table



Number: technical id of

the current user in the

Chorus Pro system

integer



system

0-1

fichierFacture

String: PDF file

corresponding to the

invoice base64 encoded

file 1

nomFichier

String: Name of the file

with extension (without

the path)

varchar(200) 1

formatDepot String: Choice of the

format of the file to submit varchar(15)

3 possible values:

- PDF_NON_SIGNE

- PDF_SIGNE_PADES

- PDF_SIGNE_XADES

1

Output table


numeroFacture String: invoice number varchar(20)

This ID is unique for each

supplier.

Alphanumeric value

The special characters in brackets

below are accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ +]

0-1

dateFacture String: Date of the invoice

shown on the PDF date Format: AAAA-MM-JJ 0-1

codeDestinataire String: identifier of the

invoice recipient varchar(14)

Alphanumeric value

This is the recipient’s SIRET. 0-1

codeServiceExecu

tant

String: service code of the

invoice recipient varchar(100) Alphanumeric value 0-1

codeFournisseur String: supplier ID varchar(80) 0-1

codeDeviseFactur

e

String: currency code of

the invoice varchar(3) 0-1

typeFacture String: invoice type varchar(50)

2 possible values:

- AVOIR

- FACTURE

0-1

55 / 557


Default value: FACTURE

typeTva String: VAT type varchar(50)

4 possible values:

- TVA_SUR_DEBIT

- TVA_SUR_ENCAISSEMENT

- EXONERATION

- SANS_TVA

0-1

numeroBonComm

ande

String: purchase order

number varchar(50) 0-1

montantTtcAvantR

emiseGlobalTTC

Number: Tax included

amount of the invoice

before discount

decimal(19,6) 0-1

montantAPayer Number: payable amount

of the invoice decimal(19,6) 0-1

montantHtTotal

Number: Tax-free amoount

of the invoice after

discount

decimal(19,6) 0-1

montantTVA Number: VAT amount of

the invoice after discount decimal(19,6) 0-1

pieceJointeId

Number: Technical ID of

the attachment in the

system

integer


the attachment within the 2017

CPP system

1

Error table


20000 The anti-Virus control service rejected the

file GDP_MSG_01.001

20001 The file format is not PDF GDP_MSG_01.002

20002 The signature of the PDF is incorrect GDP_MSG_01.003

20003 A technical error occurred: {0}

{0}= Technical error description TRA_MSG_01.001

20004

The length of file names to attach as

attachments must not exceed {0}

characters

{0}= Maximum length allowed

TRA_MSG_00.004

20005

The file size {0} rising to {1} is greater

than the maximum allowed size {2}

when attaching attachments

{0}=file name

{1}=file size

{2}= maximum size allowed

TRA_MSG_00.003

20007 The attachment name must be entered TRA_MSG_00.021

20008

The input-supplied file encoding does not

conform to the encoding standard

(base64)

TRA_MSG_00.020

56 / 557


20009 The name of the input file must have the

PDF extension TRA_MSG_00.023

20302

The date the invoice is issued must be

earlier than or equal to the date the

invoice was deposited in the system.

GFT_MSG_99.011

57 / 557


2.2.1.4 Submit invoice

The method soumettreFacture allows to submit an invoice to the solution CPP 2017 in filling the data needed for a

flow.

Input table

Attribute Subattribu

te Typing (tagger) Format Management rules

Service

providing the

data

Multiplicity


Number:

technical id of

the current

user in the

Chorus Pro

system

integer

This identifier

uniquely identifies the

user within the 2017

CPP system

0-1

modeDepot String: Deposit

mode code

varchar(

50)

3 possible values:

- SAISIE_API

- DEPOT_PDF_API

-

DEPOT_PDF_SIGNE_A

PI

If ModeDepot

= SAISIE_API:

recupererMode

Depot

If ModeDepot

=

DEPOT_PDF_A

PI or

DEPOT_PDF_SI

GNE_API:

deposerPdfFact

ure

1

numeroFactur

eSaisi

String: invoice

number

varchar(

20)

Required if the

deposit mode code is

"DEPOT_PDF_API" or

"DEPOT_PDF_SIGNE_

API".

This ID is unique for

each supplier. If the

deposit mode is

« SAISIE_API », then

the value is not taken

in account : it is

automatically

generated by the

Chorus Pro system.

Alphanumeric value

deposerPdfFact

ure 0-1

dateFacture

String: date of

the invoice

submited in

PDF or by EDI

date

Mandatory if the

deposit mode code is

"DEPOT_PDF_API" or

"DEPOT_PDF_SIGNE_

API".

Format: AAAA-MM-JJ

deposerPdfFact

ure 0-1

58 / 557


The date the invoice

is issued must be

earlier than or equal

to the date the

invoice was deposited

in the system.

Recipient

destinataire 1

codeDesti

nataire

String:

identifier of the

invoice

recipient

varchar(

14)

Alphanumeric value

This is the recipient’s

SIRET.

If ModeDepot

= SAISIE_API:

RechercherDes

tinataire

If ModeDepot

=

DEPOT_PDF_A

PI or

DEPOT_PDF_SI

GNE_API:

DeposerPdfFac

ture

1

codeServi

ceExecuta

nt

String: service

code of the

invoice

recipient

varchar(

100)

Alphanumeric value

Service code is

required if the

recipient structure

has set it as such

0-1

Supplier

fournisseur 1

idFourniss

eur

Number:

supplier

technical ID in

CPP system

integer

RecupererStru

cturesActivesP

ourFournisseur

1

idServiceF

ournisseur

Number:

technical ID of

the supplier’s

service

integer

RecupererServi

cesParStructur

e

0-1

codeCoord

onneesBa

ncairesFou

rnisseur

Number: ID of

the supplier’s

bank details

integer

RecupererCoor

donneesBancai

resValides

0-1

Invoicing framework

59 / 557


cadreDeFacturation

1

codeCadre

Facturatio

n

String:

Invoicing

frameworkinvoi

cing framework

code

varchar(

50)

4 possible values:

A1_FACTURE_FOURNI

SSEUR

A2_FACTURE_FOURNI

SSEUR_DEJA_PAYEE

A9_FACTURE_SOUST

RAITANT

A12_FACTURE_COTR

AITANT

RecupererCadr

eFacturation 1

codeStruct

ureValideu

r

String: code of

the validator

structure

varchar(

80)

Alphanumeric value

If the invoicing

framework is a

cocontracting or

subcontracting (A9,

A12) then the

validator must be

entered.Invoicing

frameworkInvoicing

framework

RechercherStr

ucture 0-1

codeServi

ceValideur

String: code of

the service of

the validator 1

structure

varchar(

100)

Alphanumeric value

If the invoicing

framework is a

cocontracting or

subcontracting (A9,

A12) then the

validator must be

entered.Invoicing

frameworkInvoicing

framework

RechercherSer

vicesStructure 0-1

References

references 1

deviseFact

ure

String:

currency code

of the invoice

varchar(

3)

RecupererDevi

ses 1

typeFactur

e

String: invoice

type

varchar(

50)

2 possible

valuespossible

values:

- AVOIR

- FACTURE

Default value:

FACTURE

1

60 / 557


typeTva String: VAT

type

varchar(

50)

4 possible

valuespossible

values:

- TVA_SUR_DEBIT

-

TVA_SUR_ENCAISSE

MENT

- EXONERATION

- SANS_TVA

The value to be

transmitted here is

deducted from the

data "Régime TVA "

and "Exonération"

from the E1 format,

according to the

following

management rule:

- If no tax summary

lines are entered, the

TypeTVA is

'SANS_TVA'

- Otherwise if the

RécapitulatifTaxes.

Exoneration tag is

filled, the TypeTVA is

'EXONERATION'

- Otherwise, the

TypeTVA is the same

as the RegimeTVA

tag.

(TVA_SUR_DEBIT or

TVA_SUR_ENCAISSE

MENT)

1

motifExon

erationTva

String: reason

for VAT

exemption

varchar(

5)

The selection of a

reason is only

possible and

mandatory if the VAT

type "Exonéré" is

selected.

RecupererMotif

sExonerationTv

a

0-1

numeroMa

rche

String:

contract

number

varchar(

50) 0-1

numeroBo

nComman

de

String:

purchase order

number

varchar(

50)

1) If the recipient is

the state, then the

system controls the

existence of the

purchase order (if

entered).

2) If the recipient

RechercherEng

agementJuridiq

ue

0-1

61 / 557


indicates, at the level

of its setup, that the

purchase order is

mandatory

(StructurePublique.ge

stionNumeroEj =

TRUE or

StructurePublique.ges

tionNumeroEJOuCode

Service and the

service code not

entered), then the

system checks that

the purchase order is

entered.

3) in all other cases,

these parameters are

not controlled.

numeroFa

ctureOrigi

ne

String: original

invoice number

varchar(

20)

This parameter is

only comprehensible

if the invoice type is

"Avoir".

Otherwise, the

parameter is ignored.

0-1

modePaie

ment

String:

payment mean

ID

varchar(

11)

6 possible values:

- ESPECE

- CHEQUE

- PRELEVEMENT

- VIREMENT

- AUTRE

- REPORT

recupererMode

Reglements 1

Invoicing lines

lignePoste List

If the deposit mode is

"SAISIE_API", there

must be at least one

line of post.

0-n

lignePoste

Numero

Number:

number of the

invoicing line

integer 1

lignePoste

Reference

String: label of

the invoicing

line’s reference

varchar(

40) 0-1

lignePoste

Denomina

tion

String: name

of the invoicing

line

varchar(

40) 1

lignePoste

Quantite

Number:

quantity of the

invoicing line

decimal(

19,6) 1

lignePoste

Unite

String: unit

code of the

invoicing line

Varchar

(20) 1

62 / 557


lignePoste

MontantU

nitaireHT

Number: tax-

free unit

amount of the

invoicing line

decimal(

19,6) 1

lignePoste

MontantRe

miseHT

Number: Tax-

free discount

amount of the

invoicing line

decimal(

19,6) 0-1

lignePoste

TauxTva

String: VAT

percent code of

the invoicing

line

varchar(

6)

If the VAT type of the

invoice is

"SANS_TVA" or

"EXONERATION",

these settings are

ignored.

Otherwise, one of the

two parameters

(TauxTva or

tauxTvaManuel) must

be entered.

RecupererTaux

Tva 0-1

lignePoste

TauxTvaM

anuel

Number: VAT

rate manually

entered in the

post line

decimal(

5,2) 0-1

VAT summary

ligneTva List 0-n

ligneTvaT

auxManue

l

Number: VAT

rate manually

entered

decimal(

5,2) If the VAT code is not

entered, the manual

VAT rate is obligatory

0-1

ligneTvaT

aux

String: post

line VAT rate

code

varchar(

6)

RecupererTaux

Tva 0-1

ligneTvaM

ontantBas

eHtParTau

x

Number: Tax-

free basic

amount by rate

decimal(

19,6)

Calculation of the tax-

free basic amount for

each rate applicable

to the invoice level:

Tax-free Basic

amount = SUM (Tax-

free amount after

global discount)

1

ligneTvaM

ontantTva

ParTaux

Number: VAT

total per VAT

rate

decimal(

19,6)

Calculation of the VAT

amount for each rate

applicable to the

invoice level:

VAT Amount = SUM

(Tax-free amount

after global discount)

x (100 + VAT

rate)/100

1

Total amount

montantTotal 1

montantHt

Total

Number: Tax-

free amoount

decimal(

19,6) 1

63 / 557


of the invoice

after discount

montantT

VA

Number: VAT

amount of the

invoice after

discount

decimal(

19,6) 1

montantTt

cTotal

Number: tax-

included global

amount of the

invoice after

allowance

decimal(

19,6)

This attribute is

automatically

calculated by Chorus

Pro (cf. GDP-CU-11-

RGD-64).

1

montantR

emiseGlob

aleTTC

Number: tax-

included global

allowance

amount

decimal(

19,6) 0-1

motifRemi

seGlobale

TTC

String: reason

for tax-

included global

allowance

amount

text(102

4) 0-1

montantA

Payer

Number:

payable

amount of the

invoice

decimal(

19,6)

The amount to be

paid can not exceed

the total tax included

amount

1

Main attachment

pieceJointePri

ncipale List

Attachable and

mandatory only if the

deposit mode is

"DEPOT_PDF_API" or

"DEPOT_PDF_SIGNE_

API".

0-1

pieceJoint

ePincipale

Designatio

n

String: free

description of

the attachment

varchar(

100) 1

pieceJoint

ePrincipal

eId

Number:

Technical ID of

the attachment

in the system

integer

This identifier


attachment within the

2017 CPP system

deposerPdfFact

ure

or

ajouterFichierD

ansSysteme

1

Pièces jointes complémentaires

pieceJointeComplementaire

List 0-n

pieceJoint

eComplem

entaireDe

signation

String: free

description of

the attachment

varchar(

100) 1

pieceJoint

eComplem

entaireTyp

e

String: the

type of the

additional

attachment to

varchar(

30)

RecupererType

sPieceJointe 1

64 / 557


add to the

invoice

pieceJoint

eComplem

entaireNu

meroLigne

Facture

Number:

number of the

invoicing line

to which the

additional

attachment

may refer

integer 0-1

pieceJoint

eComplem

entaireId

Number:

Technical ID of

the attachment

in the system

integer

This identifier



2017 CPP system

RechercherPiec

eJointeSurStru

cture

OR

RechercherPiec

eJointeSurMon

Compte

OR

AjouterFichier

DansSysteme

1

commentaire

commentaire String: free

comment field

text(200

0) 0-1

65 / 557


Output table


identifiantFactureCPP

Number: technical ID of the

invoice in the CPP 2017

system

integer

This ID allows to

uniquely identify the

invoice within the

system CPP 2017

1

identifiantStructure String: functional ID of the

supplier structure varchar(80) 1



each supplier.

Alphanumeric value.

The special characters

in brackets below are

accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

statutFacture String: current status of the

invoice varchar(50) 1

dateDepot String: Submission date of

the invoice date Format: AAAA-MM-JJ 1

Error table


User/ supplier authorization controls

20400

Verification of user authorization vendor

– creation:

The user does not have the necessary

clearances to submit the new

application.

GDP_MSG_11.005 GDP-CU-11-RGD-17:

If the payment request is new/or to perform a search as a provider, the user must be "ACTIF" and the connection between the user and the vendor service or the vendor structure must be "VALIDE". GDP-CU-11-RGD-20: If the payment request exists/or for a search or consultation, the user must be "ACTIF" and the connection between the user and the supplier service or the

supplier structure must be "VALIDE" and (the user must be the creator of the Request or the user is manager of the service or structure) In addition: In the case of a service, it must be in the state « ACTIF » In the case of a structure, it must be in the state « ACTIF »

Verifying the user authorization provider

– existing request:

The user does not have the necessary

clearances to submit the existing

application.

If the despostif mode is

"DEPOT_PDF_API" or

"DEPOT_PDF_SIGNE_API", the request

exists and the status of the payment

request (DemandePaiement.

etatCourant) must be equal to:- «

66 / 557


INTERPRETEE_OCR »

- « BROUILLON » [DRAFT]

- «

ERREUR_FOURNISSEUR_SUR_VALIDEUR

» [ERROR ON VALIDATOR BY SUPPLIER]

DemandePaiement

20001 The consistency checks on the payment

request are not valid.

GDP_MSG_11.002a

GDP-CU-11-RGD-01

20002 The attachment {0}, whose type is {1},

does not exist. GDP_MSG_11.044

20003 The recipient structure {0} is not a

public structure. GDP_MSG_11.068

20007 The recipient structure is not active; it

cannot receive any invoice. GDP_MSG_11.070

20008 The issuing structure is not active; it

cannot issue any invoice. GDP_MSG_11.071

20009

The invoice number is only composed by

figures, letters and the following special

characters: “-“, “_”, “+” and “/”.

GDP_MSG_11.076

GDP-CU-11-SER-12 (TDI-CU-03-RGD-

06)

20010 The designation of the main attachment

must be entered. GDP_MSG_11.073

20011 The designation of the complementary

attachment must be entered. GDP_MSG_11.074

20012

The structure {0} does not use the

application “Payment request”; then, it

cannot be linked to any payment

request.

GDP_MSG_01.014

{0}= functional identifier of the

structure (Cf. TRA-CU-00-RGD-40) " - "

designation of the structure (Cf. TRA-

CU-00-RGD-37)

GDP-CU-11-SER-01

20013

The tax-included rebate amount cannot

be negative or greater than the tax-

included amount before rebate.

GMJ_MSG_01.055

GDP-CU-11-RGD-01

Semantic controls: GDP-CU-11-RGD-02

DemandePaiement

20020

The currency must be in the Devise

repository

GDP_MSG_11.002b

The method of settlement must be in the

repository of ModeReglement

The invoicing framework must be located

in the CadreFacturation repository

The VAT type must be located in the

repository of TypeTva

Invoice

20020 The invoice type must be located in the

TypeFacture repository GDP_MSG_11.002b

For each LignePoste

20020

The VAT rate of each line must be in the

repository of the TauxTva GDP_MSG_11.002b

The unit of each line must be located in

the Unités repository

67 / 557


For each LigneTvaParTauxDemandePaiement

20020 The VAT rate of each line must be in the

repository of the TauxTva GDP_MSG_11.002b

Checking for mandatory invoice information

GDP-CU-11-RGD-09 - Controlling the synthesis of the header

20030

Mandatory field: The reason for VAT

exemption

(DemandePaiement.motifExonerationTva

.code) if TypeTva is equal to

« EXONERATION »

GDP_MSG_11.002d

If the recipient indicates, at the level of

its setting, that the market or purchase

order number is mandatory at the level

of the structure

(StructurePublique.gestionNumeroEj =

TRUE), Then the system checks that at

least the market or order number is

entered.


its setting, that the market or purchase

order number is mandatory at the

service level (Service.NumeroEj =

TRUE), then the system checks that at

least the market or order number is

entered.


its setting, that either the service code

or the commitment number is required

at the service level

(Structure.gestionNumeroEjOuCodeServi

ce = TRUE), then the system controls

the presence of the market number or

purchase order if the service has not

been entered.

Required field: service code running

(DemandePaiement.destinataire.codeSer

vice) ff the recipient requests it

20031

Private structures are not able to select

the recipient service

FACTURES_PUBLIQUES. Please modify

the entry.

GDP_MSG_11.072

GDP-CU-11-RGD-10 - Checking the lines of the invoice

20037

Mandatory field:: If the invoice has at

least one line, for each invoice line, the

following information is required:

- The number of the retail line

(LigneDemandePaiement.numero)

- The denomination

(LigneDemandePaiement.denomination)

- The quantity (LignePoste.quantite)

- The unit (LignePoste.unite.code)

GDP_MSG_11.002e

68 / 557


- The tax-free unit amount

(LignePoste.montantUnitaireHt)

- The VAT rate

(LignePoste.tauxTVA.code ou

LignePoste.tauxTVAManuel)

20038

Mandatory field: The validator if the

invoicing framework is "A9 or A12"

Invoicing

framework(DemandePaiement.valideur1.

identifiant)

GDP_MSG_11.002f

20300

Mandatory field: The number of the

payment request must be entered

(DemandePaiement.numero)

GDP_MSG_11.052

Only if the deposit mode is

"DEPOT_PDF_API" ou

"DEPOT_PDF_SIGNE_API"

20301

Uniqueness: An invoice for the same

supplier with the same number already

exists (DemandePaiement.numero,

DemandePaiement.fournisseur.structure.

idStructure)

GDP_MSG_11.051

Only if the deposit mode is

"DEPOT_PDF_API" ou

"DEPOT_PDF_SIGNE_API"

20302

The date the invoice is issued must be

earlier than or equal to the date the

invoice was deposited in the system.

GFT_MSG_99.011

20303

The recipient structure cannot be only a

Contracting Authority for the invoicing

framework {0}.

GFT_MSG_01.037

20304

The main attachment is required for the

deposit modes DEPOT_PDF_API and

DEPOT_PDF_SIGNE_API.

GDP_MSG_13.002

20305 The invoice must not be older than 4

years.

TRA_MSG_09.013

GDP-CU-11-SER-12

69 / 557


2.2.2 Process an issued invoice

This chapter shows input, output and error tables for the following methods: - Complete invoice

- Consult invoice by supplier

- Correct validator invoice

- Search invoice to be processed by supplier

- Search invoice by supplier

- Recycle invoice

2.2.2.1 Complete invoice

The method completerFacture allows to modify an invoice in status « SUSPENDUE » [PAUSED] in adding attachments

and/or modifying the field « commentary »

Input table

Attribute Subattribute Typing

(tagger) Format

Management

rules

Service

providing the

data

Multiplicity


Number:

technical id of

the current

user in the

Chorus Pro

system

integer

This identifier

uniquely

identifies the

user within

the 2017 CPP

system

0-1

identifiantFact

ureCPP

Number:

technical ID of

the invoice in

the CPP 2017

system

integer

This ID allows

to uniquely

identify the

invoice within

the system

CPP 2017

0-1

Complementary attachments to be added


List 0-n

pieceJointeCo

mplementaire

Designation

String: free

description of

the

complementar

y attachment

to be added to

the invoice

varchar(255) 1

pieceJointeCo

mplementaire

Type

String: type

of the

complemetary

attachment to

be added to

the invoice

varchar(30) recupererType

sPieceJointe 1

70 / 557


pieceJointeCo

mplementaire

NumeroLigneF

acture

Number:

number of the

invoicing line

to which the

additional

attachment

may refer

integer 0-1

pieceJointeCo

mplementaire

Id

Number:

Technical ID

of the

attachment in

the system

integer

rechercherPie

ceJointeSurStr

ucture

OR

rechercherPie

ceJointeSurMo

nCompte

OR

ajouterFichier

DansSysteme

1

commentaire

commentaire String = free

comment field text(2000) 0-1

Output table

Attribute Typing (tagger) Format Management rules Multi

plicity


Number: technical ID of

the invoice in the CPP

2017 system

integer

This ID allows to


invoice within the system

CPP 2017

1



each supplier.

Alphanumeric value

1

dateTraitement String: date of the

invoicing process date

Date field: AAAA-MM-JJ

HH:MI 1

Error table


20000 The invoicing request does not exist GDP_MSG_11.008

20001 The user has no required authorizations

in order to submit the request GDP_MSG_11.005

20002 The status of the invoicing request is not

« Suspendue » [Paused] GDP_MSG_11.033

20003 The attachment’s type does not exist or

does not match with the invoicing context GDP_MSG_11.060

20004 The file extensions are not allowed in the

invoicing request GDP_MSG_11.045

20005 The maximum size of attachments is

reached. GDP_MSG_11.039

20006 There is already a principal attachment

in the invoicing request GDP_MSG_11.046

71 / 557


20007 Returning an error or no response from

the SMA TRA_MSG_ 00.007

20008 The attachment does not exist GDP_MSG_ 11.044

20009 The type of attachment is not referenced TRA_MSG_00.021

20010 The type of attachment is not referenced. TRA_MSG_00.022

2.2.2.2 Consult invoice by supplier

The method consulterFactureParFournisseur allows to show the information from a previously issued invoice.

Input table

Attribute Subattribute Typing (tagger) Format Management rules Multiplicity


Number: technical

id of the current

user in the Chorus

Pro system

integer



system

0-1

identifiantFac

tureCPP

Number: technical

ID of the invoice in

the CPP 2017

system

integer

The technical identifier uniquely

identifies the invoice within the

CPP 2017 system.

0-1

codeLangue

String: code of the

language used in

the multilingual

descriptions

varchar(2

)

Without value, if no language is

chosen or supported by the

system, the descriptions are

written in french.

0-1

nbResultatsM

aximum

Number: Maximum

number of results

that can be seen

for a research

integer By default, the service returns no

more than 200 results. 0-1

Search parameters of VAT summary lines

pLigneRecapTva

0-1

pageResultat

DemandeeLis

teRecapitulati

fTVA

Number: number

of the results page.

Results of VAT

summary lines to

be displayed

integer By default, the page is the first

page. 0-1

nbResultatsP

arPageListeLi

steRecapitula

tifTVA

Number: number

of results per page

that can be

returned by the

research of VAT

summary lines

integer By default, the service returns 10

results per page. 0-1

72 / 557


triSensListeR

ecapitulatifTV

A

String: sorting

order

varchar(1

0)

Enumeration with 2 possible

values : - ascending sorting

- downward sorting

By default, the sorting is

downward.

0-1

triColonneList

eRecapitulatif

TVA

String: reference

column of the

sorting

-


values:

- ligneTvaTauxRefCode

- ligneTvaTauxRefLibelle

- ligneTvaTauxRefValeur

- ligneTvaTauxManuel

- ligneTvaMontantBaseHtParTaux

- ligneTvaMontantTvaParTaux


performed on the field

"ligneTvaMontantTvaParTaux".

0-1

Research parameters of the list of attachments

pListePiecesJointes

0-1

pageResultat

DemandeeLis

tePieceJointe

Number: number

of the page of

results to be

displayed from the

liste of

attachments

integer By default, the first page is

returned. 0-1

nbResultatsP

arPageListePi

eceJointe

Number: Number

of results per page

that can be

returned by the

search of

attachment list

integer

By default, there are ten results

per pageBy default, the service

returns 10 results per page.

0-1

triSensListePi

ecesJointes

String: sorting

order

varchar(1

0)

Enumeration with two possible

values:

- ascending sorting

- downward sorting


downward.

0-1

triColonneList

ePiecesJointe

s

String: reference

column of the

sorting

-

Enumeration with five possible

valuespossible values:

- pieceJointeTypeCode

- pieceJointeTypeLibelle

- pieceJointeDesignation

- pieceJointeNumeroLigneFacture

- pieceJointeExtension



"designation".

0-1

73 / 557


Research parameters of the invoicing lines

pLignesPoste 0-1

pageResultat

DemandeeLig

nesPoste

Number: number

of the page of

results to be

displayed from the

list of invoicing

lines

integer By default, the output is the first

page. 0-1

nbResultatsP

arPageLignes

Poste

Number: Number

of results per page

that can be

returned by the

search of invoice

lines

integer

By default, the service returns 10

results per page.

By default, there are ten results

per page

0-1

triSensListeLi

gnesPoste

String: sorting

order

varchar(1

0)


values:

- ascending sorting

- downward sorting


downward.

0-1

triColonneList

eLignesPoste

String: reference

column of the

sorting

-

possible valuesEnumeration with

thirteen possible values :

- lignePosteNumero

- lignePosteReference

- lignePosteDenomination

- lignePosteQuantite

- lignePosteUniteCode

- lignePosteUniteLibelle

- lignePosteMontantUnitaireHT

- lignePosteMontantRemiseHT

- lignePosteTauxTva

- lignePosteTauxTvaManuel

-

lignePosteMontantHtApresRemise

- lignePosteMontantTva

-

lignePosteMontantTtcApresRemis

e

By default, sorting is performed

on the field"lignePosteNumero".

0-1

74 / 557


75 / 557


Output table

Attribute Subattribut

e

Sous-

Subattribut

e

Sous-sous-

Subattribut

e

Typing (tagger) Format Management rules

Multi

plicit

y

facture 1


Number:

technical ID of

the invoice in

the CPP 2017

system

integer

This ID allows to

uniquely identify

the invoice within

the system CPP

2017

1

numeroFact

ure

String: invoice

number varchar(20)


each supplier.

Alphanumeric

value.

The special

characters in

brackets below are

accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

statutFactu

re

String: current

status of the

invoice

varchar(50)

'Enumeration with

twenty-two possible

values (for invoices

to be

issued)possible

values

- BROUILLON [DRAFT]

- A_VALIDER_1 [TO

VALIDATE 1]

-

ERREUR_FOURNISSEUR

_SUR_VALIDEUR

[ERROR ON VALIDATOR

BY SUPPLIER]

- REFUSEE_1 [REFUSED

1]

- VALIDEE_1

[VALIDATED 1]

-

ABSENCE_VALIDATION

_1_HORS_DELAI

[ABSENCE OF

VALIDATION 1 AFTER

DEADLINE]

- A_VALIDER_2 [TO

VALIDATE 2]

-

ERREUR_COTRAITANT_

SUR_VALIDEUR [ERROR

ON VALIDATOR BY

COCONTRACTOR]

- REFUSEE_2 [REFUSED

2]

- VALIDEE_2

[VALIDATED 2]

1

76 / 557


-

ABSENCE_VALIDATION

_2_HORS_DELAI

[ABSENCE OF

VALIDATION 2 AFTER

DEADLINE]

- DEPOSEE

[DEPOSITED]

-

EN_COURS_ACHEMINE

MENT [BEING

DELIVERED]

- MISE_A_DISPOSITION

[AVAILABLE TO

RECIPIENT]

- A_RECYCLER [TO

RECYCLE]

- SUSPENDUE

[PAUSED]

- COMPLETEE

[COMPLETED]

- REJETEE [REJECTED]

- MANDATEE

[MANDATED]

- MISE_EN_PAIEMENT

[PAYMENT]

- COMPTABILISEE

[ACCOUNTED]

-

MISE_A_DISPOSITION_

COMPTABLE

[AVAILABLE TO

ACCOUNTANT]

modeDepot

String: deposit

mode of the

invoice

varchar(50)

Enumeration with

ten possible

valuespossible

values:

- SAISIE_PORTAIL

- SAISIE_API

-

DEPOT_PDF_PORTA

IL

-

DEPOT_PDF_SIGNE

_PORTAIL

- DEPOT_PDF_API

-

DEPOT_PDF_SIGNE

_API

- EDI

- UPLOAD_PORTAIL

- UPLOAD_API

-

EDI_NUMERISATIO

N

1

Recipient

destinataire 0-1

77 / 557


idDestinatai

re

Number:

technical id of

the recipient in

CPP 2017

integer

This identifier

uniquely identifies

the structure within

the CPP 2017

system

1

codeDestin

ataire

String:

identifier of the

invoice

recipient

varchar(14)

Alphanumeric value

This is the

recipient’s SIRET.

1

libelleDesti

nataire

String:

description of

the recipient

varchar(20

1)

This data is a string

of characters which

corresponds to the

corporate name or

the concatenated

name and surname

of its deputy

1

idServiceEx

ecutant

Number:

technical id of

the recipient

service in CPP

2017

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

codeService

Executant

String: service

code of the

invoice

recipient

varchar(10

0)

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

libelleServic

eExecutant

String:

description of

the recipient

service

varchar(25

5)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

miseEnPaie

mentDestin

ataire

Boolean:

indicator, linked

to the recipient

service, which

allows to

display added

informations in

the invoice

boolean

true: the recipient

service give

payment

informations

false: the recipient

service does not

give payment

informations

0-1

adresseDes

tinataireId

Number:

technical

identifier of the

recipient

address in CPP

2017

integer

This identifier

uniquely identifies

the address within

the CPP 2017

system.

0-1

78 / 557


adresseDes

tinataireDet

ail

String: detail of

the recipient’s

address

varchar(10

0) 0-1

adresseDes

tinataireCo

mplement1

String: first

complement of

the recipient’s

address

varchar(10

0) 0-1

adresseDes

tinataireCo

mplement2

String: second

complement of

the recipient’s

address

varchar(10

0) 0-1

adresseDes

tinataireCo

dePostal

String: postal

code of the

recipient’s

address

varchar(10) 0-1

adresseDes

tinataireVill

e

String: city

(part of the

recipient’s

address)

varchar(50) 0-1

adresseDes

tinataireCo

dePays

String: country

code of the

recipient’s

address

varchar(2) 0-1

adresseDes

tinataireLib

ellePays

String: country

description of

the recipient’s

address

varchar(10

0) 0-1

Supplier

fournisseur 1

idFournisse

ur

Number:

technical id of

the supplier in

CPP 2017

integer

This identifier

uniquely identifies


the CPP 2017

system

1

typeIdentifi

antFourniss

eur

String:

identifier type

of the supplier

varchar(14)

possible

valuesEnumeration

with seven possible

values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

-

UE_HORS_FRANCE

- PARTICULIER

- AUTRE

1

codeFournis

seur

String: supplier

ID varchar(80) 1

79 / 557


raisonSocial

eFournisseu

r

String:

corporate name

of the supplier

varchar(20

1)

Entered if

typeIdentifiant <>

PARTICULIER

0-1

nomFournis

seur

String: name of

the supplier’s

deputy

varchar(10

0)

Entered if

typeIdentifiant =

PARTICULIER

0-1

prenomFou

rnisseur

String:

surname of the

supplier’s

deputy

varchar(10

0)

Entered if

typeIdentifiant =

PARTICULIER

0-1

idServiceFo

urnisseur

Number:

technical ID of

the supplier’s

service in CPP

2017

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system

0-1

codeService

Fournisseur

String:

supplier’s

service code

varchar(10

0) Alphanumeric value 0-1

libelleServic

eFournisseu

r

String:

supplier’s

service

description

varchar(25

5) 0-1

adresseFou

rnisseurId

Number:

technical id of

the supplier’s

address in CPP

2017

integer

This identifier

uniquely identifies

the address within

the CPP 2017

system

0-1

adresseFou

rnisseurDet

ail

String: detail

of the supplier’s

address

varchar(10

0) 0-1

adresseFou

rnisseurCo

mplement1

String: first

complement of

the supplier’s

address

varchar(10

0) 0-1

adresseFou

rnisseurCo

mplement2

String: second

complement of

the supplier’s

address

varchar(10

0) 0-1

adresseFou

rnisseurCod

ePostal

String: postal

code of the

supplier’s

address

varchar(10)

0-1

adresseFou

rnisseurVill

e

String: city of

the supplier’s

address

varchar(50)

0-1

adresseFou

rnisseurCod

ePays

String: country

code of the

supplier’s

address

varchar(2)

0-1

adresseFou

rnisseurLib

ellePays

String: country

description of

varchar(10

0)

0-1

80 / 557


the supplier’s

address

NumeroRcs

Fournisseur

String: RCS tax

identification of

the supplier

varchar(10


coordBanca

iresFourniss

eurCleIban

String: IBAN

key of the

supplier’s bank

details

varchar(2) Alphanumeric value 0-1

coordBanca

iresFourniss

eurCleRib

String: RIB key

of the supplier’s

bank details


coordBanca

iresFourniss

eurCodeBa

nque

String: bank

code of the

supplier’s bank

details


coordBanca

iresFourniss

eurCodePay

s

String: country

code of the

supplier’s bank

details

varchar(2) 0-1

coordBanca

iresFourniss

eurCompte

Bancaire

String: bank

account of the

supplier’s bank

details


coordBanca

iresFourniss

eurId

Number: ID of

the supplier’s

bank details

integer 0-1

coordBanca

iresFourniss

eurType

String: type of

the supplier’s

bank details

varchar(4)

possible

valuesEnumeration

with two possible

values:

- IBAN

- RIB

0-1

coordBanca

iresFourniss

eurLibelle

String: label of

the supplier’s

bank details

varchar(25


affactureur 0-1

affactureurI

d

Number:

technical

identifier of the

factor in CPP

2017

integer

This identifier

uniquely identifies


the CPP 2017

system.

0-1

affactureur

Code

String: factor’s

identifier varchar(80) 0-1

affactureur

TypeIdentifi

ant

String:

identifier’s type

of the factor

varchar(14)

possible values

Enumeration with

seven possible

values:

- SIRET

- RIDET

0-1

81 / 557


- TAHITI

- HORS_UE

-

UE_HORS_FRANCE

- PARTICULIER

- AUTRE

affactureur

RaisonSocia

le

String: factor’s

corporate name

varchar(20

1)


of characters which

corresponds to the

corporate name of

the structure or the

concatenated name

and surname of its

deputy.

0-1

affactureur

CodePays

String: factor’s

country code varchar(2) 0-1

Invoicing framework Invoicing framework

cadreDeFacturation

0-1

codeCadreF

acturation

String:

Invoicing

frameworkinvoi

cing framework

code

varchar(50)

Enumeration with

four possibe values

possible values:

-

A1_FACTURE_FOUR

NISSEUR

-

A2_FACTURE_FOUR

NISSEUR_DEJA_PA

YEE

-

A9_FACTURE_SOUS

TRAITANT

-

A12_FACTURE_COT

RAITANT

1

idValideur1

Number:

technical

identifier of the

first validator

integer

This technical

identifier unquely

identifies the

structure within the

CPP 2017 structure

0-1

typeIdentifi

antValideur

1

String: first

validator’s

identifier type

varchar(14)

possible

valuesEnumeration

with seven possible

values :

- SIRET

- RIDET

- TAHITI

- HORS_UE

0-1

82 / 557


-

UE_HORS_FRANCE

- PARTICULIER

- AUTRE

codeValideu

r1

String: first

validator’s

identifier

varchar(80) 0-1

raisonSocial

eValideur1

String: first

validator’s

corporate name

varchar(99)

Informed

iftypeIdentifiant <>

PARTICULIER

0-1

nomValideu

r1

String: name of

the first

validator’s

deputy

varchar(10

0)

Informed if

typeIdentifiant =

PARTICULIER

0-1

prenomVali

deur1

String:

surname of the

first validator’s

deputy

varchar(10

0)

Informed if

typeIdentifiant =

PARTICULIER

0-1

dateValidati

on1

String: date of

validation by

the first

validator

date Date field : AAAA-

MM-JJ 0-1

idValideur2

Number:

technical

identifier of the

second

validator in CPP

2017

integer

This technical

identifier unquely

identifies the


CPP 2017 structure

0-1

typeIdentifi

antValideur

2

String: second

validator’s id

type

varchar(14)

possible

valuesEnumeration

with seven possible

values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

-

UE_HORS_FRANCE

- PARTICULIER

- AUTRE

0-1

codeValideu

r2

String: second

validator’s

identifier

varchar(80) 0-1

raisonSocial

eValideur2

String: second

validator’s

corporate name

varchar(99)

Informed

iftypeIdentifiant <>

PARTICULIER

0-1

nomValideu

r2

String: name of

the second

validator’s

deputy

varchar(10

0)

Informed if

typeIdentifiant =

PARTICULIER

0-1

83 / 557


prenomVali

deur2

String:

surname of the

second

validator’s

deputy

varchar(10

0)

Informed if

typeIdentifiant =

PARTICULIER

0-1

dateValidati

on2

String: date of

validation by

the second

validator


MM-JJ 0-1

References

references 1

dateFacture

String:

invoicing date

in the supplier’s

IS

date Date field: AAAA-

MM-JJ 0-1

dateDepot

String:

Submission

date of the

invoice


MM-JJ 0-1

codeDevise

Facture

String:

currency code

of the invoice

varchar(3) 1

libelleDevis

eFacture

String:

currency

description of

the invoice

varchar(50)

Multilingual

description: the

description depends

on the language

required in

service’s

parameters

1

type

Facture

String: invoice

type varchar(50)

possible valuesEnumeration with two possible values: - AVOIR - FACTURE

0-1

typeTva String: VAT

type varchar(50)

Enumeration with

four possible

values:

- TVA_SUR_DEBIT

-

TVA_SUR_ENCAISS

EMENT

- EXONERATION

- SANS_TVA

0-1

motifExone

rationTva

String: reason

code for VAT

exemption

varchar(5)

Only entered if VAT

type is « Exonéré

».

0-1

libelleMotifE

xonerationT

va

String:

description of

the reason for

VAT exemption

varchar(50)

Only entered if VAT

type is « Exonéré

».

Multilingual

0-1

84 / 557


description : the

description depends

on the required

language in the

service’s

parameters.

numeroMar

che

String: contract


numeroBon

Commande

String:

purchase order

number

varchar(50) 0-1

numeroFact

ureOrigine

String: original

invoice number varchar(20)

If the attribute

typeFacture is not

entered "AVOIR",

then the criteria

numeroFactureOrigi

ne is not saved.

0-1

modePaiem

ent

String:

payment mean varchar(11)

Enumeration with

six possible values:

- ESPECE

- CHEQUE

- PRELEVEMENT

- VIREMENT

- AUTRE

- REPORT

0-1

dateCreatio

nFacture

String:

creation date of

the invoice


MM-JJ HH:MI 1

dateEchean

cePaiement

String:

payment date

of the invoice,

entered by the

supplier


MM-JJ 0-1

tailleTotale

PiecesJoint

es

String: sum of

attachments

sizes (unit :

Mo)

Decimal(10

,3) 0-1

VAT summary

recapitulatifDeTva

0-1

ligneTva List 0-n

ligneTvaTa

uxRefId

Number:

technical

identifier of the

referenced VAT

rate

integer

This identifier

uniquely identifies

the VAT rate within

the CPP 2017

system.

0-1

ligneTvaTa

uxRefCode

String:

Referenced VAT

rate’s code

varchar(6) 0-1

85 / 557


ligneTvaTa

uxRefLibell

e

String:

description of

the referenced

VAT rate

varchar(50) 0-1

ligneTvaTa

uxRefValeu

r

Number: value

of the

referenced VAT

rate

decimal(5,2

) 0-1

ligneTvaTa

uxManuel

Number:

manual data

entry of the

VAT rate

decimal(5,2

) 0-1

ligneTvaMo

ntantBaseH

tParTaux

Number: basis

amount without

tax per tax rate

decimal(19,

6) 1

ligneTvaMo

ntantTvaPa

rTaux

Number: total

tax amount per

tax rate

decimal(19,

6) 1

pageCouran

teLignesRec

apitulatives

TVA

Number:

number of the

current page

integer 0-1

pagesLigne

sRecapitula

tivesTVA

Number:

Number of

pages returned

by the research

integer 0-1

nbResultats

ParPageLig

nesRecapit

ulativesTVA

Number:

number of

results per

page

integer 0-1

totalLignes

Recapitulati

vesTVA

Number:

Number of

results returned

by the research

integer 0-1

Total amount

montantTotal

0-1

montantHtT

otal

Number: Tax-

free amoount

of the invoice

after discount

decimal(19,

6)

0-1

montantTV

A

Number: VAT

amount of the

invoice after

discount

decimal(19,

6)

0-1

montantTtc

AvantRemis

eGlobalTTC

Number: Tax

included

amount of the

invoice before

discount

decimal(19,

6)

0-1

86 / 557


montantRe

miseGlobal

eTTC

Number: tax-

included global

allowance

amount

decimal(19,

6)

0-1

motifRemis

eGlobaleTT

C

String: reason

for tax-included

global

allowance

amount

text(1024)

0-1

montantTtc

Total

Number: tax-

included global

amount of the

invoice after

allowance

decimal(19,

6)

0-1

montantAP

ayer

Number:

payable

amount of the

invoice

decimal(19,

6)

0-1

Main attachment

pieceJointePrincipale

0-1

idLiaisonPie

ceJointePrin

cipale

Number:

technical

identifier of the

link between

the invoice and

the main

attachment in

the system

integer

This identifier

uniquely identifies

the link between

the invoice and the

main attachment

within the CPP

2017 system.

1

idPieceJoint

ePrincipale

Number:

technical

identifier of the

main

attachment in

the system

integer

This identifier

uniquely identifies

the attachment

within the 2017

CPP system

1

List of attachments

listeDesPiecesJointes

0-1

pieceJointe Liste 0-n

pieceJointe

TypeCode

String: code of

attachment’s

type

varchar(30) 1

pieceJointe

TypeLibelle

String:

description of

the

attachment’s

type

varchar(50) 1

pieceJointe

Designation

String: Free

description of

the attachment

varchar(10

0) 1

87 / 557


pieceJointe

NumeroLig

neFacture

Number:

number of the

invoicing line to

which the

additional

attachment

may refer

integer 0-1

pieceJointeI

dLiaison

Number:

technical

identifier of the

link between

the invoice and

the attachment

in the system

integer 1

pieceJointeI

d

Number:

Technical ID of

the attachment

in the system

integer 1

pieceJointe

Extension

String:

extension of

the attachment

varchar(5) 1

pageCouran

teListePiece

sJointe

Number:

number of the

current page

integer 0-1

pagesListeP

iecesJointe

Number:

Number of

pages returned

by the research

integer 0-1

nbResultats

ParPageList

ePiecesJoin

te

Number:

Number of

results per

page

integer 0-1

totalListePi

ecesJointe

Number:

Number of

results returned

by the research

integer 0-1

Invoicing lines

lignesDePoste

0-1

lignePoste Liste 0-n

lignePosteN

umero

Number:

number of the

invoicing line

integer 1

lignePosteR

eference

String:

description of

the invoicing

line’s reference

varchar(40) 0-1

lignePosteD

enominatio

n

String:

designation of

the invoicing

line

varchar(40) 0-1

88 / 557


lignePosteQ

uantite

Number:

quantity of the

invoicing line

decimal(19,

6) 1

lignePosteU

nite

Number:

invoicing line’s

unit

Varchar(50

) 0-1

lignePosteM

ontantUnita

ireHT

Number: unit

tax-free

amount of the

invoicing line

decimal(19,

6) 1

lignePosteM

ontantRemi

seHT

Number: tax-

free

rebateamount

of the invoicing

line

decimal(19,

6) 0-1

lignePosteT

auxTva

String: VAT

rate code of the

invoicing line

varchar(6) 0-1

lignePosteT

auxTvaMan

uel

Number:

manual data

entry of the

invoicing line’s

VAT rate

decimal(5,2

) 0-1

lignePosteM

ontantHtAp

resRemise

Number: tax-

free amount

after rebate of

the invoicing

line

decimal(19,

6) 1

lignePosteM

ontantTva

Number: VAT

amount of the

invoicing line

decimal(19,

6) 1

lignePosteM

ontantTtcA

presRemise

Number: tax-

included

amount after

rebate of the

invoicing line

decimal(19,

6) 1

pageCouran

teLignesPos

te

Number:

number of the

current page

integer 0-1

pagesLigne

sPoste

Number:

Number of

pages returned

by the research

integer 0-1

nbResultats

ParPageLig

nesPoste

Number:

Number of

results per

page

integer 0-1

totalLignes

Poste

Number:

Number of

results returned

by the research

integer 0-1

89 / 557


Comments

commentaire

String: free


Error table


20000 Unknown payment request GDP_MSG_11.008

20001 The user {0} has not any required

authorization in order to process the

payment request {1}

{0} = Name and surname of the user

{1} = number of the payment request

DemandePaiement.numero

GDP_MSG_11.005

200002 The status of the invoice does not allow

the requested action GDP_MSG_01.010

90 / 557


2.2.2.3 Correct validator invoice

The method corrigerValideurFacture allows a supplier to correct the validator initially on a rejected invoice because

of wrong validator.

Input table

Attribute Subattribute Typing (tagger) Format Management

rules

Service providing

the data Multiplicity

idFacture

Technical

identifier of the

invoice in the

CPP system

Integer 1

idStructure

Technical

identifier of the

first validator’s

structure

integer

This technical

identifier

unquely

identifies the

structure

within the CPP

2017 structure

Required:

IdStructure

OR

TypeIdentifiant

Structure +

IdentifiantStruc

ture

RechercherStructu

re 0-1

typeIdentifiantStructur

e

possible

valuesEnumerati

on of the

validator’s id

type possible

values

varchar(5

0)

Enumeration

"TypeIdentifian

t"

Required:

IdStructure

OR

TypeIdentifiant

Structure +

IdentifiantStruc

ture

RechercherStructu

re 0-1

identifiantStructure

Functional

identifier of the

first validator’s

structure

varchar(8

0)

Alphanumeric

value

Required:

IdStructure

OR

TypeIdentifiant

Structure +

IdentifiantStruc

ture

RechercherStructu

re 0-1

91 / 557


Output table

Attribute Subattribute Typing (tagger) Format Manageme

nt rules Multiplicity

idFacture

Technical identifier of the invoice in the CPP system

Integer

This technical

identifier

uniquely

identifies the

current user

within the CPP

2017 system.

1

Error table

Error code Description Message d’erreur associé

20000

GDP_MSG_11.001: The status of the payment

request is {0}. The possible values are

following :possible values BROUILLON [DRAFT]

or ERREUR FOURNISSEUR SUR VALIDEUR

20001 GDP_MSG_11.008: The payment request {0}

has not be found

20002

GDP_MSG_11.065: The identifier {0} of the

payment request does not match with an Invoice

(Facture) type

20003

GDP_MSG_11.005: The user {0} has no

required authorization allowing him to process

the payment request {1}

20004 GDP_MSG_11.002f: The first validator is not

right.

20005 Please enter a technical identifier or a type and a

functional identifier of a structure. GCU_MSG_00.062

20006 There is no active structure matching with the

identifier {0}.

GCU_MSG_100.001 - Control required on the

sending and recipient structures

{0} = Technical identifier or functional identifier

of the sending or recipient structure

92 / 557


2.2.2.4 Search invoice to be processed by supplier

The method rechercherFactureATraiterParFournisseur allows to show invoices which can be processed by the supplier

because of their status (complete, recycle, delete, modify the validator).

Input table


e Typing (tagger) Format Management rules

Service

providing

the data

Multiplicity


Number:

technical id of

the current

user in the

Chorus Pro

system

integer

This identifier uniquely

identifies the user within the

2017 CPP system

0-1

idStructure

Number:

technical

identifier of the

structure

within the CPP

2017 system

integer

This technical identifier

unquely identifies the

structure within the CPP 2017

structure.

The system gets the list of

invoices :

- whose supplier corresponds

to the indicated structure (if

IdStructure is filled)

OR whose supplier of each

invoice corresponds to one of

the structures that the user is

linked to (if IdStructure is not

filled)

- whose status is :

- BROUILLON [DRAFT]

-

ERREUR_FOURNISSEUR_SUR

_VALIDEUR [ERROR ON

VALIDATOR BY SUPPLIER]

- REFUSEE_1 [REFUSED 1]


- A_RECYCLER [TO

RECYCLE]

- SUSPENDUE [PAUSED]


recupererSt

ructuresActi

vesPourFour

nisseur

0-1

masquerRej

etee

Boolean:

returns (or

not) all the

invoices

(rejected or

not for the

number of days

set in back

office)

Boolea

n

By default, the value is ‘false’.

false: returns all the invoices

true: returns all the invoices

without them which had

become ‘REJETEE’

[REJECTED] for a time period

greater than the number of

days

0-1

93 / 557


[DELAI_AFFICHAGE_REJET]

set in back office

Sorting and paging parameters

rechercheFactureATraiterParFournisseur

0-1

nbResultats

Maximum

Number:

maximal

number of

results

returned by

the research

that can be

seen

integer By default, the service returns

no more than 200 results. 0-1

pageResulta

tDemandee

Number:

number of

the displayed

result’s page

integer By default, the output is the

first page. 0-1

nbResultats

ParPage

Number:

Number of

results per

page that can

be returned

by the search


10 results per page. 0-1

triSens String:

sorting order

varchar(

10)

Enumeration with two

possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

String:

reference

column of the

sorting

-

Enumeration with twenty-one

possible valuespossible

values:

- typeDemandePaiement

- codeFournisseur

- typeIdentifiantFournisseur

- DesignationFournisseur

- codeServiceFournisseur

- nomServiceFournisseur

- codeDestinataire

- designationDestinataire

- codeServiceExecutant

- nomServiceExecutant

- typeFacture

- numeroFacture

- dateFacture

- dateDepot

- montantHT

0-1

94 / 557


- montantTTC

- montantAPayer

- Devise

- Statut

- numeroMarche

- numeroBonCommande



"dateDepot".

Output table

Attribute Subattribute Typing (tagger) Format Management rules Multiplicit

y

parametresRetour 0-1

pageCourante Number: number of

the current page integer 0-1

pages

Number: Number

of pages returned

by the research

integer 0-1

nbResultatsParPag

e

Number: Number

of results per page integer 0-1

total

Number: Number

of results returned

by the research

integer 0-1

List of invoices to be processed

listeFactures Liste 0-n

identifiantFacture

CPP

Number: technical

ID of the invoice in

the CPP 2017

system

integer

This ID allows to


invoice within the

system CPP 2017

1

typeDemandePaie

ment

String: type of

payment request varchar(50) 1

codeFournisseur String: supplier ID varchar(80) Functional identifier

of the supplier 1

typeIdentifiantFou

rnisseur

String: identifier

type of the supplier varchar(14)

Enumpossible

valueseration with

seven possible

values :

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

1

designationFourni

sseur

String: designation

of the supplier’s

structure

varchar(20

1)


of characters which

corresponds to the

corporate name of

the supplier or the

1

95 / 557


concatenated name

and surname of its

deputy.

codeServiceFourni

sseur

String: supplier’s

service code

varchar(10

0)

Alphanumeric value

If

Service.estPremierSe

rvice = true, then

this attribute is not

entered.

0-1

nomServiceFourni

sseur


service name

varchar(25

5)

If


rvice = true, then


entered.

0-1

idDestinataire

Number: technical

identifier of the

recipient structure

within the CPP

2017 system

integer

This technical

identifier unquely

identifies the


CPP 2017 structure

1

codeDestinataire

String: identifier of

the invoice

recipient

varchar(14)

Alphanumeric value


SIRET.

0-1

designationDestin

ataire

String: recipient’s

designation

varchar(20

1)

This string of

characters

corresponds to the

recipient’s corporate

name or the

concatenated name

and surname of its

deputy.

0-1

idServiceExecutan

t

Number: technical

identifier of the

executing service

within the CPP

2017 system

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If


rvice = true, then


entered.

0-1

codeServiceExecu

tant

String: executing

service’s code

varchar(10

0)

Alphanumeric value

If


rvice = true, then


entered.

0-1

nomServiceExecut

ant

String: executing

service’s name

varchar(25

5)

If


rvice = true, then


entered.

0-1

96 / 557


typeFacture String: invoicing

type varchar(50)

possible

valuesEnumeration

with two possible

values :

- AVOIR

- FACTURE

Default value (if not

entered): FACTURE

0-1

numeroFacture String: invoice

number varchar(20)


each supplier.

Alphanumeric value

The special

characters in

brackets below are

accepted:

- [ - ]

- [ _ ]

- [ / ]

1

dateFacture String: invoicing

date date

Date field : AAAA-

MM-JJ 0-1

dateDepot String: Submission

date of the invoice date

Date field : AAAA-

MM-JJ 0-1

montantHT

Number: amount

excluding tax of the

invoice

decimal(19,

6)

0-1

montantTTC

Number: tax-

included amount of

the invoice

decimal(19,

6)

0-1

montantAPayer

Number: payable

amount of the

invoice

decimal(19,

6)

0-1

devise String: currency of

the invoice varchar(3)

1

statut

String: current

status of the

invoice

varchar(50) 1

numeroMarche String: contract


numeroBonComm

ande

String: purchase

order number varchar(50) 0-1

Error table


20000 There is no result for this research GDP_MSG_11.046

20001 The user has no required authorization allowing him to process the payment request

GDP_MSG_11.021

2.2.2.5 Search invoice by supplier

97 / 557


The method rechercherFactureParFournisseur allows to show the issued invoices matching the search parameters

Input table



Service

providing

the data

Multiplicity

listeDestina

taire Liste 0-n

idDestinatai

re

Number:

technical

identifier of the

recipient in CPP

2017

integer

Rechercher

Destinataire 1

listeIdServic

eExecutant

Number: List of

technical

identifiers of

the recipient

service in CPP

2017

integer

(liste)

Rechercher

ServiceExec

utant

0-n

rechercheSi

renDestinat

aire

Research flag

on the

recipient SIREN

number

boolea

n

This boolean allows the

service to retrieve the SIREN

number when it is requested

by an API service.

0-1

numeroFact

ure

String: invoice

number

varchar

(20)


supplier.

Alphanumeric value

The special characters in

brackets below are accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

0-1

periodeDate

DepotDu

String: start

date of the

deposit’s

period

date Date format: AAAA-MM-JJ 0-1

periodeDate

DepotAu

String: end

date of the

deposit’s

period

date Date field : AAAA-MM-JJ 0-1

typeFacture String: List of

invoicing types

varchar

(50)

(liste)


possible values:

- AVOIR

- FACTURE

0-1

98 / 557


idFournisse

ur

Number:

technical

identifier of the

supplier in CPP

2017

integer




structure

RecupererSt

ructuresActi

vesPourFour

nisseur

0-1

idServiceFo

urnisseur

Number:

technical ID of

the supplier’s

service in CPP

2017

integer


identifies the service within

the CPP 2017 system.

RecupererS

ervicesParSt

ructure

0-1

idStructure

Valideur

Number:

technical

identifier of the

first (or

second)

validator’s

structure in

CPP 2017

integer


identifies the validator’s


system.

RecupererV

alideursPour

Fournisseur

0-1

cadreFactur

ation

String:

Invoicing

frameworkinvoi

cing framework

code

varchar

(50)

Enumeration with four

possible values :

-

A1_FACTURE_FOURNISSEUR

-


_DEJA_PAYEE

-

A9_FACTURE_SOUSTRAITANT

- A12_FACTURE_COTRAITANT

RecupererC

adreFactura

tion

0-1

statutCoura

nt

String: List of

researched

invoice’s status

varchar

(50)

(liste)

It is possible to precise one or

several status(es). If no

status is precised, there is no

filter on the statuses.

RecupererEt

atParTypeD

emandePaie

ment

0-n

PeriodeDate

HeureEtatC

ourantDu

Date : start

date of the

current status

period

date

Date field : AAAA-MM-JJ

or AAAA-MM-

JJTHH:MM:SS+HH:MM

0-1

PeriodeDate

HeureEtatC

ourantAu

Date : end

date of the

current status

period

date


or AAAA-MM-

JJTHH:MM:SS+HH:MM

0-1

periodeDate

FactureDu

String: start

date of the

invoicing

period


periodeDate

FactureAu

String: end

date of the

invoicing

period


montantHT

Min

Number:

minimum

amount

without tax

decimal

(19,6) 0-1

99 / 557


montantHT

Max

Number:

maximum

amount

without tax

decimal

(19,6) 0-1

montantTTC

Min

Number:

minimum

amount

including tax

decimal

(19,6) 0-1

montantTTC

Max

Number:

maximum

amount

including tax

decimal

(19,6) 0-1

montantApa

yerMin

Number:

minimum

payable

amount

decimal

(19,6) 0-1

montantApa

yerMax

Number:

maximum

payable

amount

decimal

(19,6) 0-1

coordonnee

Bancaire

Number: bank

details id integer

RecupererC

oordonnees

BancairesVa

lides

0-1

idUtilisateur

Createur

Number: List of

technical

identifiers of

the users who

created the

invoice in the

CPP system

integer

(liste)



2017 CPP system

Must comply with the rules,

relative to security, broadcast

by the AIFE.

RecupererU

tilisateursD

uService

0-n

numeroMar

che

String:

contract

number

varchar

(50) 0-1

numeroBon

Commande

String:

purchase order

number

varchar

(50)

Rechercher

Engagemen

tJuridique

0-1

numeroFact

ureOrigine

String: original

invoice number

varchar

(20)

If the attribute TypeFacture is

not "AVOIR", then the criteria

NumeroFactureOrigine is not

supported.

0-1

modeDepot String: Deposit

mode code

varchar

(50)

Enumeration with ten possible


- SAISIE_PORTAIL

- SAISIE_API

- DEPOT_PDF_PORTAIL

-

DEPOT_PDF_SIGNE_PORTAIL

- DEPOT_PDF_API

- DEPOT_PDF_SIGNE_API

- EDI

- UPLOAD_PORTAIL

RecupererM

odeDepot 0-1

100 / 557


- UPLOAD_API

- EDI_NUMERISATION"

numeroFlux

Depot

String: deposit

number of the

flow contening

the invoice

varchar

(25)

DeposerFlux

Facture 0-1


rechercheFa

ctureParFou

rnisseur

0-1

pageResulta

tDemandee

Number:

page’s number

of the

displayed

result


first page. 0-1

nbResultats

ParPage

Number:

Number of

results per

page that can

be returned by

the research

integer By default, the service

returns 10 results per page. 0-1

triSens String: sorting

order

varchar

(10)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

String:

reference

column of the

sorting

-


values:


- codeFournisseur


- designationFournisseur



- codeDestinataire




- typeFacture

- numeroFacture

- dateFacture

- dateDepot

- montantHT

- montantTTC

- montantAPayer

- Devise

- Statut

- numeroMarche

- numeroBonCommande

- NumeroFluxDepot

- typeIdentifiantValideur1

0-1

101 / 557


- codeValideur1

- raisonSocialeValideur1

- nomValideur1

- prenomValideur1

- DateValidation1

- typeIdentifiantValideur2

- codeValideur2

- raisonSocialeValideur2

- nomValideur2

- prenomValideur2

- DateValidation2

- numeroFactureOrigine

- modeDepot

-

coordBancairesFournisseurCleIb

an

-

coordBancairesFournisseurCleRi

b

-

coordBancairesFournisseurCode

Banque

-

coordBancairesFournisseurCode

Pays

-

coordBancairesFournisseurCom

pteBancaire

-

coordBancairesFournisseurNom

Cb

- affactureurCode

- affactureurTypeIdentifiant

- affactureurRaisonSociale

-

nomPrenomUtilisateurCreateur

Par défaut, le tri est effectué

sur le champ "dateDepot".

102 / 557


Output table



pageCourante

Number: number

of the current

page

integer 0-1

pages

Number: Number

of pages returned

by the research

integer 0-1

nbResultatsParPag

e

Number: Number

of results per

page

integer 0-1

total

Number: Number

of results returned

by the research

integer 0-1

List of invoices to be displayed


identifiantFacture

CPP

Number: technical

ID of the invoice

in the CPP 2017

system

integer

This ID allows to


invoice within the

system CPP 2017

1

typeDemandePaie

ment

String: payment

request’s type varchar(50)

Enumeration with 1

possible value:

- FACTURE

1

codeFournisseur String: supplier ID varchar(80) Functional identifier

of the supplier 1

typeIdentifiantFou

rnisseur

String: identifier

type of the

supplier

varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

1

designationFournis

seur

String:

designation of the

supplier’s

structure

varchar(201)

This string of

characters

corresponds to the

structure’s corporate

name or the

concatenated name

and surname of its

deputy.

1

codeServiceFourni

sseur


service code varchar(100)

Alphanumeric value

If

Service.estPremierSer

vice = true, then this

attribute is not

entered.

0-1

103 / 557


nomServiceFourni

sseur


service name varchar(255)

If



attribute is not

entered.

0-1

idDestinataire

Number: technical

identifier of the

recipient structure

within the CPP

2017 system

integer

This technical

identifier unquely

identifies the


CPP 2017 structure

Default value (if

empty): "0" (invoicing

cas, whose status is

BROUILLON [DRAFT]

without recipient)

1

codeDestinataire

String: identifier

of the invoice

recipient

varchar(14)

Alphanumeric value


SIRET.

Default value (if

empty): "non

renseigné" (invoicing


BROUILLON [DRAFT]

without recipient)

0-1

designationDestin

ataire


designation varchar(201)


of characters which

corresponds to the

corporate name of


concatenated name

and surname of its

deputy.

Default value (if

empty): "non

renseigné" (invoicing


BROUILLON [DRAFT]

without recipient)

0-1

idServiceExecutan

t

Number: technical

identifier of the

executing service

within the CPP

2017 system

integer

This identifier


service within the CPP

2017 system.

If



attribute is not

entered.

0-1

codeServiceExecut

ant

String: executing

service’s code varchar(100)

Alphanumeric value

If 0-1

104 / 557




attribute is not

entered.

nomServiceExecut

ant

String: executing

service’s name varchar(255)

If



attribute is not

entered.

0-1

typeFacture String: invoicing

type varchar(50)

Enumeration with 2

possible values:

- AVOIR

- FACTURE

Default value (if not

available): FACTURE

0-1

numeroFacture String: invoice

number varchar(20)


each supplier.

Alphanumeric value



accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

dateFacture String: invoicing

date date

Date field : AAAA-

MM-JJ 0-1

dateDepot

String:

Submission date

of the invoice


MM-JJ 0-1

montantHT

Number: amount

excluding tax of

the invoice

decimal(19,6) 0-1

montantTTC

Number: tax-

included amount

of the invoice

decimal(19,6) 0-1

montantAPayer

Number: payable

amount of the

invoice

decimal(19,6) 0-1

devise String: currency

of the invoice varchar(3) 1

statut

String: current

status of the

invoice

varchar(50) 1

dateHeureEtatCou

rant

Date : date of the

invoice current

status

date

Date field : AAAA-

MM-

JJTHH:MM:SS+HH:M

M

0-1

105 / 557


commentaireEtatC

ourant

String : comment

on the current

status

varchar(255) 0-1



numeroBonComm

ande

String: purchase


numeroFluxDepot

String: deposit

number of the

flow contening the

invoice

varchar(25)

This data is available

only if the invoice was

issued by flow.

0-1

typeIdentifiantVali

deur1

String: id type of

the first validator varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

0-1

codeValideur1 String: first

validator’s id varchar(80) Alphanumeric value 0-1

raisonSocialeValid

eur1

String: first

validator’s

corporate name

varchar(99)

Informed if

TypeIdentifiant <>

PARTICULIER

0-1

nomValideur1

String: name of

the first

validator’s deputy

varchar(100)

Informed if

TypeIdentifiant =

PARTICULIER

0-1

prenomValideur1

String: surname

of the first


varchar(100)

Informed if

TypeIdentifiant =

PARTICULIER

0-1

dateValidation1

String: date of

validation by the

first validator

date Date field: AAAA-MM-

JJ 0-1

typeIdentifiantVali

deur2

String: id type of

the second

validator

varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

0-1

codeValideur2

String: second

validator’s

identifier


raisonSocialeValid

eur2

String: second

validator’s

corporate name

varchar(99)

Informed if

TypeIdentifiant <>

PARTICULIER

0-1

nomValideur2

String: name of

the second


varchar(100)

Informed if

TypeIdentifiant =

PARTICULIER

0-1

106 / 557


prenomValideur2

String: surname

of the second


varchar(100)

Informed if

TypeIdentifiant =

PARTICULIER

0-1

dateValidation2

String: date of

validation by the

second validator


MM-JJ 0-1

numeroFactureOri

gine

String: original


If the attribute

TypeFacture is not

"AVOIR", then the

criteria

NumeroFactureOrigin

e is not saved.

0-1

modeDepot

String: deposit

mode of the

invoice

varchar(50)

Enumeration with 10

possible values :

- SAISIE_PORTAIL

- SAISIE_API

- DEPOT_PDF_PORTAIL

-

DEPOT_PDF_SIGNE_PO

RTAIL

- DEPOT_PDF_API

-

DEPOT_PDF_SIGNE_AP

I

- EDI

- UPLOAD_PORTAIL

- UPLOAD_API

- EDI_NUMERISATION

1

coordBancairesFou

rnisseurCleIban

String: IBAN key

of the supplier’s

bank details


coordBancairesFou

rnisseurCleRib

String: RIB key of

the supplier’s

bank detailsRIB

key of the

supplier’s bank

details


coordBancairesFou

rnisseurCodeBanq

ue

String: bank code

of the supplier’s

bank details


coordBancairesFou

rnisseurCodePays

String: country

code of the

supplier’s bank

details

varchar(2) 0-1

coordBancairesFou

rnisseurCompteBa

ncaire

String: bank

account of the

supplier’s bank

details


coordBancairesFou

rnisseurNomCb

String: name of

the supplier’s

bank details

varchar(255) Uniquely identifies the

bank details 0-1

affactureurCode String: factor’s

identifier varchar(80) 0-1

107 / 557


affactureurTypeId

entifiant

String: factor’s id

type varchar(14)

Enumeration with 7

possible values :

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

0-1

affactureurRaison

Sociale

String: factor’s

corporate name varchar(201)


of characters which

corresponds to the

corporate name of


concatenated name

and surname of its

deputy.

0-1

nomPrenomUtilisa

teurCreateur

String: description

of the user who

created the

invoice

varchar(201)

This is the

concatenated name

and surname of the

user who created the

invoice. The name

and surname are

separated by a space.

0-1

Error table


20000 Error on one (at least) transmitted setting

20001 The user is not « ACTIF » or not

connected with the supplier’s entity GDP_MSG_11.006

20002 The research does not return any result GDP_MSG_11.046

20003 The start date must be previous than the

end date.

TRA_MSG_09.007

GFT-CU-01-SER-22 – Rechercher des

factures de travaux [Search for work

invoices]

108 / 557


2.2.2.6 Recycle invoice

The method recyclerFacture allows to modify the routing data from an invoice in the status « A_Recycler » [To

recycle].

Input table



Service

providing the

data

Multiplicity

idUtilisateurC

ourant

Number: technical

identifier of the

user in the CPP

system

integer

This identifier



CPP system

0-1

identifiantFac

tureCPP

Number: technical

ID of the invoice

in the CPP 2017

system

integer

This ID allows to


invoice within the

system CPP 2017

1

destinataire

destinataire 1

codeDestina

taire

String: identifier

of the invoice

recipient

varchar(

14)

Alphanumeric value


SIRET.

rechercherDe

stinataire 1

codeService

Executant

String: Service

code of the invoice

recipient

varchar(

100) Alphanumeric value

rechercherSe

rviceExecutan

t

0-1

Reference

reference 0-1

numeroBon

Commande

String: purchase

order number

varchar(

50)


the State, then the

system controls that

the purchase order

exists (if available).

2) If the recipient

indicates, in the

settings, that the

purchase order is

required


stionNumeroEj =

TRUE or


tionNumeroEJOuCode

Service and service

code not informed),

then the system

controls that the

rechercherEn

gagementJuri

dique

0-1

109 / 557


purchase order is

informed.

3) In other case,

thses settings are not

controlled.

Comments

commentaire String: free

comment field

text(200

0) 0-1

Output table



Number: technical ID of

the invoice in the CPP

2017 system

integer

This ID allows to uniquely

identify the invoice within the

system CPP 2017

1



supplier.

Alphanumeric value.



- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

statutFacture String: current status of

the invoice varchar(50) 1

dateDepot String: Submission date

of the invoice date Date field : AAAA-MM-JJ 1

Error table


20000 The payment request does not exist. GDP_MSG_11.008

20001

The user has not any required

authorization in order to submit the

request.

GDP_MSG_11.005

20002 The status of the payment request must

be "A_RECYCLER" [TO RECYCLE] GDP_MSG_01.006

20003

The recipient service {0} does not exist.

{0} = recipient service code, informed in

the settings

GFT_MSG_01.032

20004 Commitment number required for the

recipient structure. GFT_MSG_01.042

20005 Commitment number required for the

recipient service. GFT_MSG_01.041

110 / 557


20006 Recipient service or commitment number

required for the recipient structure. GFT_MSG_01.039

20007 Recipient service required for the

recipient structure. GFT_MSG_01.038

20008 The commitment number {0} does not

exist.

GFT_MSG_01.043

{0} = numeroEngagement [commitment

number]

20009

Private structures are not able to select

the recipient service

FACTURES_PUBLIQUES. Please modify

the entry.

GDP_MSG_11.072

20010

The identifier {0} of the payment request

does not correspond to a type Facture

[Invoice].

GDP_MSG_11.065

{0} = supplied identifier of the structure

20011

The structure {0} does not use the

application « Demandes de paiement »

[Payment request], it cannot be linked to

a payment request.

GDP_MSG_01.014

{0} = identifier (Cf. TRA-CU-00-RGD-40)

« – » designation of the structure (Cf.

TRA-CU-00-RGD-37)

20012 The recipient service {0} does not

correspond to the recipient structure {1}.

GFT_MSG_01.033

{0} = idTechniqueServiceDestinataire

[technical identifier of the recipient

service]

{1} = idTechniqueStructureDestinataire


structure]

20013 The recipient structure is not active ;

then, it cannot receive any invoice. GDP_MSG_11.070

20014 The recipient service {0} is not active.

GFT_MSG_01.036

{0} = idTechniqueServiceDestinataire


service]

2.2.3 Process a received invoice


- Consult invoice by recipient

- Search invoice to be processed by recipient

- Search invoice by recipient

- Process received invoice

2.2.3.1 Consult invoice by recipient

The method consulterFactureParRecipiendaire allows to consult data from a received invoice.

Input table



Number: technical

id of the current integer



system

0-1

111 / 557


user in the Chorus

Pro system

identifiantFac

tureCPP

String: technical ID

of the invoice in

the CPP 2017

system

integer


identify the invoice within the

system CPP 2017

1

codeLangue

String: code of the

language used in

the multilingual

descriptions

varchar(5

)




written in french.

0-1

nbResultatsM

aximum

Number: Maximum

number of results

that can be seen

for a research

integer By default, the service returns no

more than 200 results. 0-1

Search parameters of VAT summary lines

rechercheligneTvaRecap

0-1

pageResultat

DemandeeLis

teRecapitulati

fTVA

Number: number

of the page of the

VAT summary lines

results to be

displayed


page. 0-1

nbResultatsP

arPageListeLi

steRecapitula

tifTVA

Number: Number

of results per page

that can be

returned by the

research of VAT

summary lines



triSensListeR

ecapitulatifTV

A

String: sorting

order

varchar(1

0)


values:

- ascending sorting

- downward sorting


downward.

0-1

triColonneList

eRecapitulatif

TVA

String: reference

column of the

sorting

-


values:

- ligneTvaTauxRefCode

- ligneTvaTauxRefLibelle

- ligneTvaTauxRefValeur

- ligneTvaTauxManuel

- ligneTvaMontantBaseHtParTaux

- ligneTvaMontantTvaParTaux



"ligneTvaMontantTvaParTaux".

0-1


recherchePj 0-1

112 / 557


pageResultat

DemandeeLis

tePieceJointe

Number: number

of the attachment’s

list results page to

be displayed


page. 0-1

nbResultatsP

arPageListePi

eceJointe

Number: Number

of results per page

that can be

returned by the

research of

attachment list



triSensListePi

ecesJointes

String: sorting

order

varchar(1

0)


values:

- ascending sorting

- downward sorting


downward.

0-1

triColonneList

ePiecesJointe

s

String: reference

column of sorting


values:



- pieceJointeDesignation

- pieceJointeNumeroLigneFacture




"designation".

0-1

Research parameters of invoicing lines

rechercheLignePoste

0-1

pageResultat

DemandeeLig

nesPoste

Number: number

of the invoicing

lines’ list results

page to be

displayed


page. 0-1

nbResultatsP

arPageLignes

Poste

Number: Number

of results per page

that can be

returned by the

research of invoice

lines



triSensListeLi

gnesPoste

String: sorting

order

varchar(1

0)


values:

- ascending sorting

- downward sorting


downward.

0-1

113 / 557


triColonneList

eLignesPoste

String: reference

column of the

sorting

-



- lignePosteNumero

- lignePosteReference

- lignePosteDenomination

- lignePosteQuantite

- lignePosteCode

- lignePosteLibelle

- lignePosteMontantUnitaireHT

- lignePosteMontantRemiseHT

- lignePosteTauxTva

- lignePosteTauxTvaManuel

-

lignePosteMontantHtApresRemise

- lignePosteMontantTva

-

lignePosteMontantTtcApresRemis

e



"lignePosteNumero".

0-1

114 / 557


Output table


te

Sous-

Subattribut

e

Sous-sous-

Subattribut

e

Typing (tagger) Format Management rules Multipli

city

facture 1


Number: technical

ID of the invoice

in the CPP 2017

system

integer

This ID allows to

uniquely identify

the invoice within

the system CPP

2017

1

numeroFac

ture

String: invoice

number varchar(20)

This ID is unique

for each supplier.

Alphanumeric

value.

The special

characters in

brackets below

are accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

statutFactu

re

String: current

status of the

invoice

varchar(50)

'Enumeration with

11 possible values

(for the received

invoices)

-

EN_COURS_ACHEMIN

EMENT [BEING

DELIVERED]

-

MISE_A_DISPOSITIO

N [AVAILABLE TO

RECIPIENT]

- A_RECYCLER [TO

RECYCLE]

- SUSPENDUE

[PAUSED]

- REJETEE

[REJECTED]

- MANDATEE

[MANDATED]

- MISE_EN_PAIEMENT

[PAYMENT]

- COMPTABILISEE

[ACCOUNTED]

-

MISE_A_DISPOSITIO

N_COMPTABLE

[AVAILABLE TO

ACCOUNTANT]

- DEPOSEE

[DEPOSITED]

- COMPLETEE

[COMPLETED]

1

115 / 557


modeDepo

t

String: deposit

mode of the

invoice

varchar(15)

Enumeration with

10 possible

values:

- SAISIE_PORTAIL

- SAISIE_API

-

DEPOT_PDF_PORTAIL

-

DEPOT_PDF_SIGNE_P

ORTAIL

- DEPOT_PDF_API

-

DEPOT_PDF_SIGNE_A

PI

- EDI

- UPLOAD_PORTAIL

- UPLOAD_API

- EDI_NUMERISATION

1

Recipient

destinatair

e 1

idDestinata

ire

Number:

technical identifier

of the recipient in

CPP 2017

integer 1

codeDestin

ataire

String: identifier

of the invoice

recipient

varchar(14)

Alphanumeric

value

This is the


1

libelleDesti

nataire

String:

description of the

recipient

varchar(20

1)

This data is a

string of

characters which

corresponds to

the corporate

name of the

structure or the

concatenated

name and

surname of its

deputy.

1

idServiceE

xecutant

Number:


of the recipient

service in the CPP

2017 system

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremie

rService = true,

then this attribute

is not entered.

0-1

116 / 557


codeServic

eExecutant

String: Service

code of the

invoice recipient

varchar(10

0)

Alphanumeric

value

If

Service.estPremie

rService = true,

then this attribute

is not entered.

0-1

libelleServi

ceExecuta

nt

String:

description of the

recipient service

varchar(25

5)

If

Service.estPremie

rService = true,

then this attribute

is not entered.

0-1

adresseDe

stinataireI

d

Number:


of the address of

the recipient or its

executing service

in the CPP 2017

system

integer

If an executing

service is entered

in the invoice,

then the system

gets the

informations

about the address

of the executing

service.

Otherwise, if a

recipient (except

the State) is

entered in the

invoice, then the

system gets the

informations of

the recipient

address.

Otherwise, the

address is empty.

0-1

adresseDe

stinataireD

etail

String: detail of

the recipient’s (or

its executing

service’s) address

varchar(10

0) 0-1

adresseDe

stinataireC

omplement

1

String: address’

first complement

about the

recipient or its

executing service

varchar(10

0) 0-1

adresseDe

stinataireC

omplement

2

String: address’

second

complement

about the

recipient or its

executing service

varchar(10

0) 0-1

adresseDe

stinataireC

odePostal

String: postal

code of the

recipient or its

executing service

varchar(10) 0-1

adresseDe

stinataireVi

lle

String: city of the

recipient or its

executing service

varchar(50) 0-1

adresseDe

stinataireC

odePays

String: country

code of the

recipient or its

executing service

varchar(2) 0-1

adresseDe

stinataireLi

bellePays

String: country

description of the

recipient or the

executing service

varchar(10

0) 0-1

fournisseur

fournisseur 1

117 / 557


idFourniss

eur

Number: technical

identifier of the

supplier in the

CPP 2017 system

integer 1

typeIdentif

iantFournis

seur

String: identifier

type of the

supplier

varchar(14)

Enumeration with

7 possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

-

UE_HORS_FRANC

E

- PARTICULIER

- AUTRE

1

codeFourni

sseur


identifier varchar(80)

Alphanumeric

value 1

designatio

nFournisse

ur

String:

designation of the

supplier’s

structure

varchar(20

1)

This data is a

string of

characters which

corresponds to

the corporate

name of the

structure or the

concatenated

name and

surname of its

deputy.

1

idServiceF

ournisseur

Number: technical

ID of the

supplier’s service

in the CPP 2017

system

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremie

rService = true,

then this attribute

is not entered.

0-1

codeServic

eFournisse

ur


service code

varchar(10

0)

Alphanumeric

value

If

Service.estPremie

rService = true,

then this attribute

is not entered.

0-1

libelleServi

ceFourniss

eur


service

description

varchar(25

5)

If

Service.estPremie

rService = true,

0-1

118 / 557


then this attribute

is not entered.

adresseFo

urnisseurI

d

Number: technical

id of the supplier’s

address in CPP

2017

integer 1

adresseFo

urnisseurD

etail

String: detail of

the supplier’s

address

varchar(10

0) 1

adresseFo

urnisseurC

omplement

1

String: first

complement of

the supplier’s

address

varchar(10

0) 0-1

adresseFo

urnisseurC

omplement

2

String: second

complement of

the supplier’s

address

varchar(10

0) 0-1

adresseFo

urnisseurC

odePostal

String: postal

code of the

supplier’s address

varchar(10) 1

adresseFo

urnisseurVi

lle

String: city of the

supplier’s address varchar(50) 1

adresseFo

urnisseurC

odePays

String: country

code of the


varchar(2) 1

adresseFo

urnisseurLi

bellePays

String: country

description of the


varchar(10

0) 1

numeroRcs

Fournisseu

r

String: RCS tax

identification of

the supplier

varchar(10

0)

Alphanumeric

value 0-1

coordBanc

airesFourni

sseurCleIb

an

String: IBAN key

of the supplier’s

bank details

varchar(2) Alphanumeric

value 0-1

coordBanc

airesFourni

sseurCleRi

b

String: RIB key of

the supplier’s

bank details


value 0-1

coordBanc

airesFourni

sseurCode

Banque

String: bank code

of the supplier’s

bank details


value 0-1

coordBanc

airesCode

Guichet

String: sort code

of the supplier’s

bank details


value 0-1

coordBanc

airesBicSwi

ft

String:

BIC/SWIFT

number of the


value 0-1

119 / 557


supplier’s bank

details

coordBanc

airesFourni

sseurCode

Pays

String: country

code of the

supplier’s bank

details

varchar(2) 0-1

coordBanc

airesFourni

sseurComp

teBancaire

String: bank

account of the

supplier’s bank

details


value 0-1

coordBanc

airesFourni

sseurId

Number: ID of the

supplier’s bank

details

integer 0-1

coordBanc

airesFourni

sseurType

String: type of

the supplier’s

bank details

varchar(4)

Enumeration with

2 possible values:

- IBAN

- RIB

0-1

coordBanc

airesFourni

sseurLibell

e

String: label of

the supplier’s

bank details

varchar(25

5)

Alphanumeric

value 0-1

affactureur 0-1

affactureur

Id

Number:


of the factor in

the CPP 2017

system

integer 0-1

affactureur

Code

String: factor’s

identifier varchar(18)

Alphanumeric

value 0-1

affactureur

TypeIdenti

fiant


type varchar(14)

Enumeration with

7 possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

-

UE_HORS_FRANC

E

- PARTICULIER

- AUTRE

0-1

affactureur

RaisonSoci

ale

String: factor’s

corporate name

varchar(10

0) 0-1

affactureur

CodePays

String: factor’s

country code varchar(2) 0-1

Invoicing frameworkInvoicing framework

cadreDeFacturation

1

120 / 557


codeCadre

Facturation

String: Invoicing

frameworkinvoicin

g framework code

varchar(50)

Enumeration CadreFacturation (cf. Excel file Definition of the

messages, e-mails, labels, enumerations, parameters)

1

idValideur1

Number:


of the first

validator in the

CPP 2017 system

integer 0-1

typeIdentif

iantValideu

r1

String: first

validator’s

identifier type

varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

-

UE_HORS_FRANCE

- PARTICULIER

- AUTRE

0-1

codeValide

ur1

String: first

validator’s

identifier


raisonSoci

aleValideur

1

String: first

validator’s

corporate name

varchar(10

0)

Informed if

typeIdentifiant <>

PARTICULIER

0-1

nomValide

ur1

String: name of

the first


varchar(10

0)

Informed if

typeIdentifiant =

PARTICULIER

0-1

prenomVal

ideur1

String: surname

of the first


varchar(10

0)

Informed if

typeIdentifiant =

PARTICULIER

0-1

dateValidat

ion1

String: date of

the validation by

the first validator


MM-JJ 0-1

idValideur2

Number:


of the second

validator in the

CPP 2017 system

integer 0-1

typeIdentif

iantValideu

r2

String: second

validator’s id type varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

-

0-1

121 / 557


UE_HORS_FRANCE

- PARTICULIER

- AUTRE

codeValide

ur2

String: second

validator’s id varchar(80) Alphanumeric value 0-1

raisonSoci

aleValideur

2

String: second

validator’s

corporate name

varchar(10

0)

Informed if

typeIdentifiant <>

PARTICULIER

0-1

nomValide

ur2

String: name of

the second


varchar(10

0)

Informed if

typeIdentifiant =

PARTICULIER

0-1

prenomVal

ideur2

String: surname

of the second


varchar(10

0)

Informed if

typeIdentifiant =

PARTICULIER

0-1

dateValidat

ion2

String: date of

the validation by

the second

validator


MM-JJ 0-1

idMoe

Number: technical

identifier of the

Project Manager

in the CPP 2017

system

integer 0-1

typeIdentif

iantMoe

String: Project

Manager’s

identifier type


identifiant

Moe

String: Project

Manager’s

identifier

varchar(80) 0-1

raisonSoci

aleMoe

String: corporate

name of the

Project Manager

varchar(20

1)

Informed if

TypeIdentifiantMoe

= PARTICULIER

and

DemandePaiement.

etatCourant=BROUI

LLON [DRAFT]

0-1

nomMoe

String: name of

the Project

Manager’s deputy

varchar(10

0)

Informed if

TypeIdentifiantMoe

= PARTICULIER

and

DemandePaiement.

etatCourant=BROUI

LLON [DRAFT]

0-1

prenomMo

e

String: surname

of the Project

Manager’s deputy

varchar(10

0)

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremier

Service = true,

0-1

122 / 557


then this attribute

is not entered.

idServiceM

oe

Number:


of the Project

Manager’s service

in the CPP 2017

system

integer

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

codeServic

eMoe

String: code of

the Project

Manager’s service

varchar(10

0)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

nomServic

eMoe

String: label of

the Project

Manager’s service

varchar(10

0)

This technical

identifier unquely

identifies the


CPP 2017 structure

0-1

idMoa

Number: technical

identifier of the

Contracting

Authority in the

CPP 2017 system

integer Alphanumeric value 0-1

identifiant

Moa

String: identifier

of the Contracting

Authority

varchar(80) 0-1

raisonSoci

aleMoa

String: corporate

name of the

Contracting

Authority

varchar(20

1)

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

idServiceM

oa

Number:


of the Contracting

Authority’s

service in the CPP

2017 system

integer

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

codeServic

eMoa

String: service

code of the

Contracting

Authority

varchar(10

0)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

nomServic

eMoa

String:

Contracting

Authority’s

service

description

varchar(10

0) 0-1

123 / 557


Preceding piece

piecePrecedente

cadreFactu

rationPiece

Precedente

String: invoicing

framework of the

preceding piece

varchar(50)

This technical

identifier unquely

identifies the

structure within

the CPP 2017

structure

0-1

idPiecePrec

edente

Number: technical

identifier of the

preceding piece

integer 0-1

numeroPie

cePrecede

nte

String: number of

the preceding

piece


value 0-1

idDestinata

irePiecePre

cedente

Number: technical

identifier of the

recipient of the

preceding piece in

the CPP 2017

system

integer 0-1

identifiant

Destinatair

ePiecePrec

edente

String: identifier

of the recipient of

the preceding

piece in the CPP

2017 system

varchar(14)

Informed if

TypeIdentifiantMo

e = PARTICULIER

and

DemandePaiemen

t.etatCourant=BR

OUILLON [DRAFT]

0-1

raisonSoci

aleDestinat

airePiecePr

ecedente

String: corporate

name of the

recipient of the

preceding piece in

the CPP 2017

system

varchar(99)

Informed if

TypeIdentifiantMo

e = PARTICULIER

and

DemandePaiemen

t.etatCourant=BR

OUILLON [DRAFT]

0-1

idServiceE

xecutantPi

ecePrecede

nte

Number:


of the recipient

service of the

preceding piece in

the CPP 2017

system

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremie

rService = true,

then this attribute

is not entered.

0-1

codeServic

eExecutant

PiecePrece

dente

String: service

code of the

recipient of the

preceding piece

varchar(10

0)

Alphanumeric

value

If

Service.estPremie

rService = true,

then this attribute

is not entered.

0-1

124 / 557


nomServic

eExecutant

PiecePrece

dente

String:

description of the

recipient service

varchar(10

0)

If

Service.estPremie

rService = true,

then this attribute

is not entered.

0-1

Following piece

pieceSuivante

These parameters

are displayed only

if there is a

following piece,

linked to the

current work

invoice.

0-1

cadreFactu

rationPiece

Suivante

String: invoicing

framework mode

of the following

piece

varchar(50) 0-1

idPieceSuiv

ante

Number: technical

identifier of the

following piece in

the CPP 2017

system

integer 0-1

numeroPie

ceSuivante

String: number of

the following

piece

varchar(20) 0-1

Références

references 1

dateFactur

e

String: invoicing

date in the

supplier’s IS

date Date field:

AAAA-MM-JJ 0-1

dateDepot

String:

Submission date

of the invoice

date Date field:

AAAA-MM-JJ 0-1

codeDevis

eFacture

String: currency

code of the

invoice

varchar(5) 1

libelleDevis

eFacture

String: currency

description of the

invoice

varchar(50)

Multilingual

description:the

returned

description

depends on the

requested

language in the

service

parameters.

1

type

Facture

String: invoice

type varchar(50)

Enumeration

with 2 possible

values:

- AVOIR

1

125 / 557


- FACTURE

typeFactureTravaux

String: work invoice type

varchar(50)

Enumeration

with 11

possible

values:

-

DP_DE_SOUST

RAITANT_TRAV

AUX

-

PROJET_DECO

MPTE_MENSUE

L

-

ETAT_ACOMPT

E

-

ETAT_ACOMPT

E_VALIDE

-

PROJET_DECO

MPTE_FINAL

-

PROJET_DECO

MPTE_GENERA

L

-

PROJET_DECO

MPTE_GENERA

L_PROCEDURE

_TACITE

-

DECOMPTE_GE

NERAL

-

DECOMPTE_GE

NERAL_SIGNE

-

DECOMPTE_GE

NERAL_DEFINI

TIF_TACITE

-

DECOMPTE_GE

NERAL_DEFINI

TIF_PROCEDUR

E_TACITE

0-1

typeTva String: VAT type varchar(50)

Enumeration

with 4 possible

values:

-

1

126 / 557


TVA_SUR_DEBI

T

-

TVA_SUR_ENC

AISSEMENT

-

EXONERATION

- SANS_TVA

motifExone

rationTva

String: reason

code for VAT

exemption

varchar(5)

Entered only if

the VAT type is

«

EXONERATION

».

0-1

libelleMotif

Exoneratio

nTva

String:

description of the

reason for VAT

exemption

varchar(50)

Entered only if

the VAT type is

«

EXONERATION

».

Multilingual

description:the

returned

description

depends on the

requested

language in the

service

parameters.

0-1

numeroMa

rche

String: contract


numeroBo

nComman

de

String: purchase


numeroFac

tureOrigine

String: original

invoice number varchar(20) 0-1

modePaie

ment

String: payment

mean varchar(11)

Enumeration

with 6 possible

values:

- ESPECE

- CHEQUE

-

PRELEVEMENT

- VIREMENT

- AUTRE

- REPORT

0-1

dateCreati

onFacture

String: creation

date of the

invoice

date

Date field :

AAAA-MM-JJ

HH:MI

1

dateEchea

ncePaieme

nt

String: payment

date of the

invoice, entered

by the supplier

date Date field :

AAAA-MM-JJ 0-1

127 / 557


TailleTotal

ePiecesJoin

tes

String: sum of the

size of the

attachments of

the invoice (in

Mb)

decimal(10,3) 0-1

numeroDp

Mandat

String: number of the payment request in the Chorus/Helios

system

varchar(31) 0-1

Récapitulatif de TVA

recapitulatifDeTva

0-1

ligneTva List 0-n

ligneTvaTa

uxRefId

Number: identifier

of the referenced

VAT rate

integer 0-1

ligneTvaTa

uxRefCode

String:

Referenced VAT

rate’s code

varchar(6) 0-1

ligneTvaTa

uxRefLibell

e

String:

description of the

referenced VAT

rate

varchar(50) 0-1

ligneTvaTa

uxRefValeu

r

Number: value of

the referenced

VAT rate

decimal(5,2) 0-1

ligneTvaTa

uxManuel

Number: manual

data entry of the

VAT rate

decimal(5,2) 0-1

ligneTvaMo

ntantBase

HtParTaux

Number: basis

amount without

tax per tax rate

decimal(19,6) 1

ligneTvaMo

ntantTvaPa

rTaux

Number: total tax

amount per tax

rate

decimal(19,6) 1

pageCoura

nteLignesR

ecapitulati

vesTVA

Number: number

of the current

page

integer 0-1

pagesLigne

sRecapitul

ativesTVA

Number: Number

of pages returned

by the research

integer 0-1

nbResultat

sParPageLi

gnesRecap

itulativesT

VA

Number: Number

of results per

page

integer 0-1

totalLignes

Recapitulat

ivesTVA

Number: Number

of results

returned by the

research

integer 0-1

128 / 557


Montant Total

montantTotal

1

montantHt

Total

Number: Tax-free

amoount of the

invoice after

discount

decimal(19,6) 1

montantTV

A

Number: VAT

amount of the

invoice after

discount

decimal(19,6)

If the

registered

amount is nil

(ie in some

cases of work

invoices), then

the SXP

returns the

result of the

following

operation:

Facture.monta

ntTtcAvantRem

isePied -

DemandePaiem

ent.montantHt

Global

1

montantTt

cAvantRe

miseGlobal

TTC

Number: Tax

included amount

of the invoice

before discount

decimal(19,6)

If the

registered

amount is nil

(ie in some

cases of work

invoices), then

the SXP

returns the

result of the

following

operation :

DemandePaiem

ent.montantHt

Global +

DemandePaiem

ent.montantTv

aGlobal

1

montantRe

miseGlobal

eTTC

Number: tax-

included global

allowance amount

decimal(19,6) 0-1

motifRemis

eGlobaleTT

C

String: reason for

tax-included

global allowance

amount

text(1024) 0-1

montantTt

cTotal

Number: tax-

included global

amount of the

decimal(19,6)

If the

registered

amount is nil

(ie in some

1

129 / 557


invoice after

allowance

cases of work

invoices), then

the SXP

returns the

result of the

following

operation:

DemandePaiem

ent.montantHt

Global +

DemandePaiem

ent.montantTv

aGlobal -

Facture.monta

ntRemiseGlobal

eTtc

montantAP

ayer

Number: payable

amount of the

invoice

decimal(19,6)

If the

registered

amount is nil

(ie in some

cases of work

invoices), then

the SXP

returns the

following data:

DemandePaiem

ent.montantTtc

Global

1

Main attachment


0-1

idLiaisonPi

eceJointeP

rincipale

Number: technical

identifier of the

link between the

invoice and the

main attachment

in the system

integer 1

idPieceJoin

tePrincipal

e

Number: technical

identifier of the

main attachment

in the system

integer 1

List of attachments


0-1


pieceJointe

TypeCode

String: code of

the attachment’s

type

varchar(30) 1

pieceJointe

TypeLibelle

String:

description of the

attachment’s type

varchar(50) 1

130 / 557


pieceJointe

Designatio

n

String: free

description of the

attachment

varchar(100) 1

pieceJointe

NumeroLig

neFacture

Number: number

of the invoicing

line to which the

additional

attachment may

refer

integer 0-1

pieceJointe

IdLiaison

Number: technical

identifier of the

link between the

invoice and the

attachment in the

system

integer 1

pieceJointe

Id

Number:

Technical ID of

the attachment in

the system

integer 1

pieceJointe

Extension

String: extension

of the attachment varchar(5) 1

pageCoura

nteListePie

cesJointe

Number: number

of the current

page

integer 0-1

pagesListe

PiecesJoint

e

Number: Number

of pages returned

by the research

integer 0-1

nbResultat

sParPageLi

stePiecesJ

ointe

Number: Number

of results per

page

integer 0-1

totalListePi

ecesJointe

Number: Number

of results

returned by the

research

integer 0-1

Invoicing lines

lignesDePo

ste 0-1

lignePoste Liste 0-n

lignePoste

Numero

Number: number

of the invoicing

line

integer 1

lignePoste

Reference

String:

description of the

invoicing line’s

reference

varchar(40) 0-1

lignePoste

Denominat

ion

String:

designation of the

invoicing line

varchar(40) 0-1

131 / 557


lignePoste

Quantite

Number: quantity

of the invoicing

line

decimal(19,6) 1

lignePoste

Unite

Number: unit of

the invoicing line varchar(50) 0-1

lignePoste

MontantUn

itaireHT

Number: unit tax-

free amount of

the invoicing line

decimal(19,6) 1

lignePoste

MontantRe

miseHT

Number: tax-free

rebateamount of

the invoicing line

decimal(19,6) 0-1

lignePoste

TauxTva

String: VAT rate

code of the

invoicing line

varchar(6) 0-1

lignePoste

TauxTvaM

anuel

Number: manual

data entry of the

invoicing line’s

VAT rate

decimal(5,2) 0-1

lignePoste

MontantHt

ApresRemi

se

Number: tax-free

amount after

rebate of the

invoicing line

decimal(19,6) 1

lignePoste

MontantTv

a

Number: VAT

amount of the

invoicing line

decimal(19,6) 1

lignePoste

MontantTtc

ApresRemi

se

Number: tax-

included amount

after rebate of the

invoicing line

decimal(19,6) 1

pageCoura

nteLignesP

oste

Number: number

of the current

page

integer 0-1

pagesLigne

sPoste

Number: Number

of pages returned

by the research

integer 0-1

nbResultat

sParPageLi

gnesPoste

Number: Number

of results per

page

integer 0-1

totalLignes

Poste

Number: Number

of results

returned by the

research

integer 0-1

commentaire

commentaire

String: free


Error table



132 / 557


20001 To view an invoice from received invoices, the

attachment between the user and the recipient service

or the destination structure must be valid ("VALIDE").

In addition, the user must be active ("ACTIF").

GDP_MSG_11.005

133 / 557


2.2.3.2 Search invoice to be processed by recipient

The method rechercherFactureATraiterParRecipiendaire allows to display invoices which can be processed by the

recipient according to their statuses (modifiyng the invoice’s status).

Input table



Service

providing

the data

Multiplicity

idUtilisate

urCourant

Number:

technical id of

the current user

in the Chorus

Pro system

integer


identifies the user within

the 2017 CPP system

0-1

idStructur

e

Number:

technical

identifier of the

structure within

the CPP 2017

system

integer



structure within the CPP

2017 structure

If IdStructure is filled, the

system retrieves the

invoices list and the work

invoices list for which :

- the recipient

corresponds to the

filled structure

OR the recipient

corresponds to one

of the structures to

which the user is

attached

- the status is :

- MISE_

A_DISPOSITION

- COMPLETEE

[COMPLETED]

RecupererSt

ructuresActi

vesPourDes

tinataire

0-1


parametre

Recherche

FactureAT

raiterParR

ecipiendai

re

0-1

nbResultats

Maximum

Number:

Maximum

number of

results that can

be seen for a

research

integer

By default, the service

returns no more than 200

results.

0-1

134 / 557


pageResulta

tDemandee

Number: number

of the results

page to be

displayed

integer By default, the output is

the first page. 0-1

nbResultats

ParPage

Number:

Number of

results per page

that can be

returned by the

research

integer


returns 10 results per

page.

0-1


order

varchar(1

0)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

String: reference

column of the

sorting

-

Enumeration with 22 possible values: - typeDemandePaiement - codeFournisseur

- typeIdentifiantFournisseur - designationFournisseur - codeServiceFournisseur - nomServiceFournisseur - codeDestinataire - designationDestinataire - codeServiceExecutant - nomServiceExecutant - typeFacture - typeFactureTravaux - numeroFacture

- dateFacture - dateDepot - montantHT - montantTTC - montantAPayer - Devise - Statut - numeroMarche - numeroBonCommande By default, the sorting is performed on the field

"dateDepot".

0-1

135 / 557


Output table


pageCourante pageCourante Number: number of


pages pages

Number: Number of

pages returned by the

research

integer 0-1

nbResultatsPar

Page

nbResultatsParPa

ge

Number: number of

results per page integer 0-1

total total

Number: Number of

results returned by

the research

integer 0-1



idFacture

Number: technical

identifier of the

invoice/work invoice

within the CPP 2017

system

integer

This ID allows to


invoice within the

system CPP 2017

1

typeDemandePai

ement

String: type of

payment request varchar(50)

Enumeration with 2

possible values:

- FACTURE

- FACTURE_TRAVAUX

1

codeFournisseur String: supplier ID varchar(80) Supplier functional

identifier 1

typeIdentifiantFo

urnisseur

String: identifier type

of the supplier varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

1

designationFourn

isseur

String: designation of

the supplier’s

structure

varchar(201)

This data is a string of

characters which

corresponds to the

corporate name of the

supplier or the

concatenated name

and surname of its

deputy.

1

codeServiceFour

nisseur



Alphanumeric value

If

Service.estPremierServi

ce = true, then this

attribute is not entered.

0-1

nomServiceFour

nisseur



If

Service.estPremierServi0-1

136 / 557




idDestinataire

Number: technical

identifier of the

recipient within the

CPP 2017 system

integer




CPP 2017 structure

1

codeDestinataire String: identifier of

the invoice recipient varchar(14)

Alphanumeric value


SIRET.

1

designationDesti

nataire




characters which

corresponds to the


supplier or the

concatenated name

and surname of its

deputy.

1

idServiceExecuta

nt

Number: technical

identifier of the

executing service

within the CPP 2017

system

integer


identifies the service

within the CPP 2017

system.

If




0-1

codeServiceExec

utant

String: executing


Alphanumeric value

If




0-1

nomServiceExec

utant

String: executing


If




0-1

typeFacture String: invoice type varchar(50)

2 possible values:

- AVOIR

- FACTURE

Default value (if

unfilled): FACTURE

0-1

typeFactureTrav

aux

String: work invoice

type varchar(50)

8 possible values:

- ETAT_ACOMPTE

-

ETAT_ACOMPTE_VALID

E

-

PROJET_DECOMPTE_GE

NERAL

-

DECOMPTE_GENERAL_

SIGNE

0-1

137 / 557


- DP_SOUSTRAITANT

-

PROJET_DECOMPTE_GE

NERAL_CADRE_TACITE

-

DECOMPTE_GENERAL_

DEFINITIF_TACITE

-

DECOMPTE_GENERAL_

DEFINITIF_CADRE_TAC

ITE

numeroFacture

String: invoice

number of work

invoice number

varchar(20)


each supplier.

Alphanumeric value



accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

dateFacture

String: invoicing date

(invoice or work

invoice)

date Date format: AAAA-

MM-JJ 0-1

dateDepot String: Submission


Date format: AAAA-

MM-JJ 0-1

montantHT

Number: amount


invoice or the work

invoice

decimal(19,6) 1

montantTTC

Number: tax-included


or the work invoice

decimal(19,6) 1

montantAPayer

Number: payable


or the work invoice

decimal(19,6) 1

devise

String: currency of the

invoice or the work

invoice

varchar(5) 1

statut

String: current status

of the invoice or the

work invoice

varchar(50) 1



numeroBonCom

mande

String: purchase


factureTelecharg

eeParDestinatair

e

String: indicating if

the invoice is already

downloaded by a user

of the recipient

structure

varchar(5)

Two possible values:

- true

- false

If

1

138 / 557


FactureTelechargeePar

Destinataire = "true",

there is at least one

download action on the

invoice, performed by a

user attached to the

recipient structure of

the invoice.

If

FactureTelechargeePar

Destinataire = "false",

there is no download

action on the invoice,

performed by a user

who is attached to the

recipient structure of

the invoice.

codeMOE String: projet

manager identifier varchar(80)

Supplier functional

identifier 0-1

typeIdentifiantM

OE

String: projet

manager identifier

type

varchar(14)

7 possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

0-1

designationMOE


the project manager

structure

varchar(201)


characters which

corresponds to the


supplier or the

concatenated name

and surname of its

deputy.

0-1

codeMOA String: contracting

authority identifier varchar(80)

Supplier functional

identifier 0-1

typeIdentifiantM

OA

String: contracting

authority identifier

type

varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

0-1

designationMOA


the contracting

authority

varchar(201)


characters which

corresponds to the


supplier or the

concatenated name

0-1

139 / 557


and surname of its

deputy.

Error table


20000 No result found GDP_MSG_11.046

20001 The user does not have the necessary authorisations to act on the request for

GDP_MSG_11.005

140 / 557


2.2.3.3 Search invoice by recipient

The method rechercherFactureParRecipiendaire allows to display the received invoices matching the search

parameters. It is possible to display invoices according to their state (downloaded, undownloaded)

Input table



Service

providing

the data

Multiplicity


Number:

technical id of

the current

user in the

Chorus Pro

system

integer



2017 CPP system

0-1

typeDeman

dePaiement

String: type of

payment

request

varchar

(50)


values:

- FACTURE

- FACTURE_TRAVAUX

RecupererT

ypeDemand

ePaiement

0-1

idDestinatai

re

Number:

technical

identifier of the

recipient in the

CPP 2017

system

integer




structure

RecupererSt

ructuresActi

vesPourDes

tinataire

0-1

idServiceEx

ecutant

Number:

technical

identifier of the

recipient’s

service in the

CPP 2017

system

integer




RecupererS

ervicesParSt

ructure

0-1

numeroFact

ure

String: invoice

number or

work invoice

number

varchar

(20)


supplier.

Alphanumeric value



- [ - ]

- [ _ ]

- [ / ]

- [ + ]

0-1

periodeDate

DepotDu

String: start

date of the

submission

period


141 / 557


periodeDate

DepotAu

String: end

date of the

submission

period


listeTypeFac

ture

String: list of

invoicing types

varchar

(50)

(liste)

Available if Type

DemandePaiement =

FACTURE

2 possible values:

- AVOIR

- FACTURE

0-n

listeTypeFac

tureTravaux

String: list of

work invoicing

types

varchar

(50)

(liste)

Available if Type

DemandePaiement =

FACTURE_TRAVAUX

8 possible values:

- ETAT_ACOMPTE

- ETAT_ACOMPTE_VALIDE

-

PROJET_DECOMPTE_GENERA

L

- DECOMPTE_GENERAL

-

DECOMPTE_GENERAL_SIGNE

- DP_SOUSTRAITANT

-

PROJET_DECOMPTE_GENERA

L_CADRE_TACITE

-

DECOMPTE_GENERAL_DEFINI

TIF_TACITE

-


TIF_CADRE_TACITE

0-n

listeFournis

seurs list 0-n

idFournisse

ur

Number:

technical

identifier of the

supplier in CPP

2017

integer




structure

Rechercher

Structure 1

listeIdServic

e

Number: list of

technical

identifiers of

the supplier

service in CPP

2017

integer

(list)

Rechercher

ServiceStru

cture

0-n

rechercheSi

renFourniss

eur

Research flag

on the

recipient SIREN

number

boolea

n

This boolean allows the

service to retrieve the SIREN

number when it is requested

by an API service.

0-1

idStructure

Valideur

Number:

technical

identifier of the

integer Rechercher

Structure 0-1

142 / 557


first or second

validator’s

structure

cadreFactur

ation

String:

Invoicing

frameworkinvoi

cing framework

code

varchar

(50)

4 possible values (for

invoices):

-


-


_DEJA_PAYEE

-

A9_FACTURE_SOUSTRAITANT


12 possible values (for work

invoices):

-

A5_ETAT_ACOMPTE_FOURNI

SSEUR

-

A6_ETAT_ACOMPTE_VALIDE_

FOURNISSEUR

-

A8_DECOMPTE_GENERAL_SI

GNE_FOURNISSEUR

-

A10_DP_DE_SOUSTRAITANT_

TRAVAUX

- A15_ETAT_ACOMPTE_MOE

-

A16_ETAT_ACOMPTE_VALIDE

_MOE

-

A17_PROJET_DECOMPTE_GE

NERAL_MOE

-

A19_ETAT_ACOMPTE_VALIDE

_MOA

-

A22_PROJET_DECOMPTE_GE

NERAL_CADRE_TACITE

-

A23_DECOMPTE_GENERAL_D

EFINITIF_TACITE

-


EFINITIF_TACITE

-


EFINITIF_CADRE_TACITE

RecupererC

adreFactura

tion

0-1

143 / 557


statutCoura

nt

String: list of

statuses for

invoices or

works invoices,

to which the

search relates

varchar

(50)

(liste)

It is possible to precise one or

several status(es). If no

status is precised, there is no

filter on the statuses.The

status must be equal to one

of the following statuses :

MISE_A_DISPOSITION

[AVAILABLE TO RECIPIENT]

SUSPENDUE [PAUSED]

COMPLETEE [COMPLETED]

MANDATEE [MANDATED]

REJETEE [REJECTED]

MISE_EN_PAIEMENT

[PAYMENT]

COMPTABILISEE

[ACCOUNTED]

MISE_A_DISPOSITION_COMP

TABLE [AVAILABLE TO

ACCOUNTANT]

SERVICE_FAIT [SERVICE

RENDERED]

PRISE_EN_COMPTE_DESTINA

TAIRE

TRANSMISE_MOA

E • MISE_A_DISPOSITION

MOE

RecupererEt

atParTypeD

emandePaie

ment

0-n

PeriodeDate

HeureEtatC

ourantDu

Date : start

date of the

current status

period

date


or AAAA-MM-

JJTHH:MM:SS+HH:MM

0-1

PeriodeDate

HeureEtatC

ourantAu

Date : end

date of the

current status

period

date


or AAAA-MM-

JJTHH:MM:SS+HH:MM

0-1

periodeDate

FactureDu

String: start

date of the

invoicing

period


periodeDate

FactureAu

String: end

date of the

invoicing

period


montantHT

Min

Number:

minimum tax-

free amount

decimal

(19,6) 0-1

montantHT

Max

Number:

maximum tax-

free amount

decimal

(19,6) 0-1

montantTTC

Min

Number:

minimum tax

included

amount

decimal

(19,6) 0-1

144 / 557


montantTTC

Max

Number:

maximum ta

included

amount

decimal

(19,6) 0-1

montantApa

yerMin

Number:

minimum

payable

amount of the

invoice

decimal

(19,6) 0-1

montantApa

yerMax

Number:

maximum

payable

amount of the

invoice

decimal

(19,6) 0-1

numeroMar

che

String:

contract

number

varchar

(50) 0-1

numeroBon

Commande

String:

purchase order

number

varchar

(50)

Rechercher

Engagemen

tJuridique

0-1

factureTelec

hargeeParD

estinataire

String:

indicating if the

invoice is

already

downloaded by

a user of the

recipient

structure

boolea

n


values:

- true

- false

If

FactureTelechargeeParDestin

ataire = "true", there is at

least one download action on

the invoice, performed by a

user attached to the

recipient structure of the

invoice.

If


ataire = "false", there is no

download action on the

invoice, performed by a user

who is attached to the

recipient structure of the

invoice.

0-1


paramRech

erche 0-1

pageResulta

tDemandee

Number:

number of the

results page to

be displayed


first page. 0-1

145 / 557


nbResultats

ParPage

Number:

Number of

results per

page that can

be returned by

the research




order

varchar

(10)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

String:

reference

column of the

sorting

-


values:


- codeFournisseur


- fournisseur



- codeDestinataire

- destinataire



- typeFacture

- typeFactureTravaux

- numeroFacture

- dateFacture

- dateDepot

- montantHT

- montantTTC

- montantAPayer

- Devise

- Statut

- numeroMarche

- numeroBonCommande

-


ataire



"dateDepot".

0-1

146 / 557


147 / 557


Output table


pageCourante

Number: number

of the current

page

integer 0-1

pages

Number: Number

of pages returned

by the research

integer 0-1

nbResultatsParPag

e

Number: number

of results per

page

integer 0-1

total

Number: Number

of results returned

by the research

integer 0-1

List of invoices to display


idFacture

Number: technical

identifier of the

invoice/work

invoice within the

CPP 2017 system

integer

This ID allows to


invoice within the

system CPP 2017

1

typeDemandePaie

ment

String: type of


Enumeration with 2

possible values:

- FACTURE

- FACTURE_TRAVAUX

1

codeFournisseur String: supplier ID varchar(80) Supplier’s functional

ID 1

typeIdentifiantFou

rnisseur

String: identifier

type of the

supplier

varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

1

designationFournis

seur

String:

designation of the

supplier’s

structure

varchar(201)


of characters which

corresponds to the

corporate name of


concatenated name

and surname of its

deputy.

1

codeServiceFourni

sseur



Alphanumeric value

If



0-1

148 / 557


attribute is not

entered.

nomServiceFourni

sseur



If



attribute is not

entered.

0-1

idDestinataire

Number: technical

identifier of the

recipient within

the CPP 2017

system

integer

This technical

identifier unquely

identifies the


CPP 2017 structure

1

codeDestinataire

String: identifier

of the invoice

recipient

varchar(14)

Alphanumeric value


SIRET.

1

designationDestin

ataire




of characters which

corresponds to the

corporate name of


concatenated name

and surname of its

deputy.

1

idServiceExecutan

t

Number: technical

identifier of the

executing service

within the CPP

2017 system

integer

This identifier



2017 system.

If



attribute is not

entered.

0-1

codeServiceExecut

ant

String: executing


Alphanumeric value

If



attribute is not

entered.

0-1

nomServiceExecut

ant

String: executing


If



attribute is not

entered.

0-1

typeFacture String: invoice

type varchar(50)

Enumeration with 2

possible values:

- AVOIR

- FACTURE

0-1

typeFactureTravau

x

String: work

invoice type varchar(50)

Available if Type

DemandePaiement =

FACTURE_TRAVAUX

0-1

149 / 557


Enumeration with 8

possible values:

- ETAT_ACOMPTE

-

ETAT_ACOMPTE_VALI

DE

-

PROJET_DECOMPTE_

GENERAL

-

DECOMPTE_GENERAL

_SIGNE

- DP_SOUSTRAITANT

-

PROJET_DECOMPTE_

GENERAL_CADRE_TA

CITE

-

DECOMPTE_GENERAL

_DEFINITIF_TACITE

-

DECOMPTE_GENERAL

_DEFINITIF_CADRE_T

ACITE

numeroFacture

String: number of

the invoice/work

invoice

varchar(20)


each supplier.

Alphanumeric value.



accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

dateFacture

String: invoicing

date (invoice or

work invoice)

date Date format: AAAA-

MM-JJ 0-1

dateDepot String: submission


Date format: AAAA-

MM-JJ 0-1

montantHT

Number: Amount

excluding tax of

the invoice or the

work invoice

decimal(19,6) 1

montantTTC

Number: tax-

included amount

of the invoice or

the work invoice

decimal(19,6) 1

montantAPayer

Number: payable

amount of the

invoice or the

work invoice

decimal(19,6) 1

150 / 557


devise

String: currency

of the invoice or

the work invoice

varchar(5) 1

statut

String: current

status of the

invoice or the

work invoice

varchar(50)

The status should not

be equal to one of the

following statuses:

• BROUILLON

[DRAFT]

• A_VALIDER_1 [TO

VALIDATE 1]

•

ERREUR_FOURNISSE

UR_SUR_VALIDEUR

[ERROR ON

VALIDATOR BY

SUPPLIER]

•

ABSENCE_VALIDATIO

N_1_HORS_DELAI

[ABSENCE OF

VALIDATION 1 AFTER

DEADLINE]

• REFUSEE_1

[REFUSED 1]

• VALIDEE_1

[VALIDATED 1] –

• A_VALIDER_2 [TO

VALIDATE 2]

•

ERREUR_COTRAITAN

T_SUR_VALIDEUR

[ERROR ON

VALIDATOR BY

COCONTRACTOR]

•

ABSENCE_VALIDATIO

N_2_HORS_DELAI

[ABSENCE OF

VALIDATION 2 AFTER

DEADLINE]

• REFUSEE_2

[REFUSED 2]

• VALIDEE_2

[VALIDATED 2]

• A_ASSOCIER_MOE

[TO ASSOCIATE WITH

PROJECT MANAGER]

• ERREUR_DE_MOE

[ERROR ON PROJECT

MANAGER]

1

151 / 557


• REFUSEE_MOE

[REFUSED BY

PROJECT MANAGER]

•

MISE_A_DISPOSITIO

N_MOE [AVAILABLE

TO PROJECT

MANAGER]

•

PRISE_EN_COMPTE_

MOE [TAKEN IN

ACCOUNT BY

PROJECT MANAGER]

• A_ASSOCIER_MOA

[TO ASSOCIATE WITH

CONTRACTING

AUTHORITY]

• ERREUR_DE_MOA

[ERROR ON

CONTRACTING

AUTHORITY]

• REFUSEE_MOA

[REFUSED BY

CONTRACTING

AUTHORITY]

•

A_ASSOCIER_FOURNI

SSEUR [TO

ASSOCIATE WITH

SUPPLIER]

•

REFUSEE_FOURNISSE

UR [REFUSED BY

SUPPLIER]

• A_COMPLETER [TO

COMPLETE]

•

MISE_A_DISPOSITIO

N MOE

dateHeureEtatCou

rant

Date : date of the

invoice current

status

date

Date field : AAAA-

MM-

JJTHH:MM:SS+HH:M

M

0-1

commentaireEtatC

ourant

String : comment

on the current

status

varchar(255) 0-1



numeroBonComm

ande

String: purchase


factureTelecharge

eParDestinataire

Boolean:

indicating if the boolean

Enumeration avec 2

possible values: 1

152 / 557


invoice is already

downloaded by a

user of the

recipient structure

- true

- false

If

FactureTelechargeePa

rDestinataire =

"true", there is at

least one download

action on the invoice,

performed by a user

attached to the

recipient structure

of the invoice.

If

FactureTelechargeePa

rDestinataire =

"false", there is no

download action on

the invoice,

performed by a user

who is attached to

the recipient

structure of the

invoice.

codeMOE

String: Project

Manager’s

identifier

varchar(80) Supplier functional

identifier 0-1

typeIdentifiantMO

E

String: Project

Manager identifier

type

varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

0-1

designationMOE

String:

designation of the

Project Manager

varchar(201)


of characters which

corresponds to the

corporate name of

the supplier or the

concatenated name

and surname of its

deputy.

0-1

codeMOA

String:

Contracting

Authority’s

identifier

varchar(80) Functional identifier

of the supplier 0-1

typeIdentifiantMO

A

String:

Contracting

Authority’s

identifier type

varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

0-1

153 / 557


- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

designationMOA

String:

designation of the

Contracting

Authority

varchar(201)


of characters which

corresponds to the

corporate name of

the supplier or the

concatenated name

and surname of its

deputy.

0-1

Error table



400 Erroneous request



end date.

TRA_MSG_09.007

GFT-CU-01-SER-22 – Rechercher des

factures de travaux [Search for work

invoices]

154 / 557


2.2.3.4 Process received invoice

The method traiterFactureRecue allows to validate, reject or suspend a received invoice. When the recipient rejects

or suspends the invoice, he must justify his choice.

Input table


Service

providing

the data

Multiplicity

idFacture

Number: technical

identifier of the

invoice or of the

work invoice to be

process in CPP 2017

integer This ID allows to uniquely identify the

invoice within the system CPP 2017 1

nouveauSt

atut

String: new status

of the invoice or of

the works invoice

varcha

r(50)

- MISE_A_DISPOSITION [AVAILABLE TO

RECIPIENT]



- MANDATEE [MANDATED]

- MISE_EN_PAIEMENT [PAYMENT]

- COMPTABILISEE [ACCOUNTED]

- MISE_A_DISPOSITION_COMPTABLE

[AVAILABLE TO ACCOUNTANT]

- A_RECYCLER [TO RECYCLE]

RecupererEt

atsPossibles

PourTraitem

ent

1

motif

String: reason for

changing the status

of the invoice or the

works invoice

varcha

r(255)

The reason entry is mandatory if the new

status to be assigned to the invoice is:



0-1

numeroDP

Mandat

String: Payment

request number in

Chorus or Helios

varcha

r(31) TDI-CU-03-RGD-01Ter 0-1

155 / 557


Output table


idFacture

Number: technical identifier of

the invoice or the work invoice

to be processed within the CPP

2017 system

integer

This ID allows to uniquely identify

the invoice within the system CPP

2017

1

numeroFacture String: invoice number or work


This ID is unique for each supplier.

Alphanumeric value.

The special characters in brackets

below are accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

dateTraitement String: invoice or works invoice

processing date date Date field: AAAA-MM-JJ 1

nouveauStatut

String: new status of the

invoice or of the works invoice

after processing

varchar(50) 1

Error table


20000 The payment request is unkwown in the

system GDP_MSG_11.008

20001

Allowance: The user must be active and

rattached to the recipient structure of the

payment request.

GDP_MSG_11.021

20003

The reason entry is mandatory if the new

status to be assigned to the invoice is:



GDP_MSG_11.013

20004 Supplement information is required. GDP_MSG_11.055

20005 The state is not allowed in the invoicing

frameworkInvoicing framework GDP_MSG_11.024

156 / 557


2.2.4 Process an invoice to validate


- Consult invoice by validator

- Search invoice to be processed by validator

- Search invoice by validator

- Retrieve reasons to refuse invoice to be validated

- Retrieve invoice statuses noticeable by the validator

- Process invoice to be validated

2.2.4.1 Consult invoice by validator

The method consulterFactureParValideur allowd a validator to retrieve data from an invoice for a consultation

Input table


rules

Service providing


identifiantFa

ctureCPP

Technical ID of

the invoice in the

CPP 2017 system

integer

This ID allows

to uniquely

identify the

invoice within

the system CPP

2017

1

codeLangue

language code.

This language is

used in the

descriptions.

varchar(5)

Without value,

if no language

is chosen or

supported by

the system, the

descriptions

are written in

french.

0-1

recherchelig

neTvaRecap 0-1

pageResultatD

emandeeListeR

ecapitulatifTVA

number of the

VAT summary

lines results page

to be displayed

integer

By default, the

output is the

first page.

0-1

nbResultatsPar

PageListeListeR

ecapitulatifTVA

Number of

results per page

that can be

returned by the

research of VAT

summary lines

integer

By default, the

service returns

10 results per

page.

0-1

triSensListeRec

apitulatifTVA Sort order

varchar(1

0)

Enumeration

with two

possible

0-1

157 / 557


values:

- ascending

sorting

- downward

sorting

By default, the

sorting is

downward.

triColonneListe

RecapitulatifTV

A

reference column

of the sorting

Reference

column of the

sorting

Enumeration

with 6 possible

values:

-

ligneTvaTauxR

efCode

-

ligneTvaTauxR

efLibelle

-

ligneTvaTauxR

efValeur

-

ligneTvaTauxM

anuel

-

ligneTvaMonta

ntBaseHtParTa

ux

-

ligneTvaMonta

ntTvaParTaux

By default, the

sorting is

performed on

the field

"ligneTvaMonta

ntTvaParTaux".

0-1

recherchePj 0-1

pageResultatD

emandeeListePi

eceJointe

Number of the

attachment’s list

results page to

be displayed

integer

By default, the

output is the

first page.

0-1

triSensListePiec

esJointes Sort order

varchar(1

0)

Enumeration

with two

possible

values:

- ascending

0-1

158 / 557


sorting

- downward

sorting

By default, the

sorting is

downward.

triColonneListe

PiecesJointes

Reference

column of the

sorting

-

Enumeration

with 5 possible

values:

-

PieceJointeTyp

eCode

-

PieceJointeTyp

eLibelle

-

PieceJointeDesi

gnation

-

PieceJointeNu

meroLigneFact

ure

-

PieceJointeExte

nsion

By default, the

sorting is

performed on

the field

"Designation".

0-1

rechercheLi

gnePoste 0-1

pageResultatD

emandeeLignes

Poste

Number of the

invoicing lines

results page to

be displayed

integer

By default, the

output is the

first page.

0-1

nbResultatsPar

PageLignesPost

e

Number of

results per page

that can be

returned from

the search of

invoicing lines

integer

By default, the

service returns

10 results per

page.

0-1

triSensListeLig

nesPoste Sorting order

varchar(1

0)

Enumeration

with two

possible

values:

0-1

159 / 557


- ascending

sorting

- downward

sorting

By default, the

sorting is

downward.

triColonneListe

LignesPoste

Reference

column of the

sorting

-

Enumeration

with 13

possible

values:

-

LignePosteNum

ero

-

LignePosteRefe

rence

-

LignePosteDen

omination

-

LignePosteQua

ntite

-

LignePosteUnit

eCode

-

LignePosteMont

antUnitaireHT

-

LignePosteMont

antRemiseHT

-

LignePosteTaux

Tva

-

LignePosteTaux

TvaManuel

-

LignePosteMont

antHtApresRem

ise

-

LignePosteMont

antTva

-

LignePosteMont

antTtcApresRe

mise

0-1

160 / 557


By default, the

sorting is

performed on

the field

"LignePosteNu

mero".

Output table


te

Sous-

Subattribut

e

Sous-sous-

Subattribute Typing

(tagger) Format

Managemen

t rules Multiplicity

Facture à consulter

facture 1

identifiant

FactureCP

P

Technical ID

of the invoice

in the CPP

2017 system

integer

This ID

allows to

uniquely

identify the

invoice

within the

system CPP

2017

1

numeroFa

cture

Invoice

number varchar(20) 1

statutFact

ure

Current

status of the

invoice

varchar(50)

Enumeratio

n

EtatDemand

ePaiement

(cf. excel

file

Definition of

the

messages,

e-mails,

labels,

enumeratio

ns,

parameters)

1

modeDepo

t

Deposit mode

of the invoice varchar(15)

Enumeratio

nModeDepo

tDemandeP

aiement (cf.

Excel file

Definition of

the

1

161 / 557


messages,

e-mails,

labels,

enumeratio

ns,

parameters)

destinatair

e 1

idDestinatai

re

Technical

identifier of

the recipient

in the CPP

2017 system

integer 1

codeDestina

taire

Identifier of

the invoice

recipient

varchar(14)

This is the

recipient’s

SIRET.

1

libelleDestin

ataire

Description of

the recipient

varchar(201

)

In the case

of work

invoices, if

the object

does not

exist, the

service

returns

"Non

renseigné"

1

idServiceEx

ecutant

Technical

identifier of

the recipient

service in CPP

2017

integer

This

identifier

uniquely

identifies

the service

within the

CPP 2017

system.

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

codeService

Executant

Service code

of the invoice

recipient

varchar(100

)

Alphanumer

ic value

If

Service.estP

remierServi

0-1

162 / 557


ce = true,

then this

attribute is

not entered.

libelleServic

eExecutant

Description of

the recipient

service

varchar(255

)

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

adresseDest

inataireDeta

il

Detail of the

recipient’s (or

its executing

service’s)

address

varchar(100

) 0-1

adresseDest

inataireCom

plement1

Address’ first

complement

about the

recipient or

its executing

service

varchar(100

) 0-1

adresseDest

inataireCom

plement2

Address’

second

complement

about the

recipient or

its executing

service

varchar(100

) 0-1

adresseDest

inataireCod

ePostal

Postal code of

the recipient

or its

executing

service

varchar(10) 0-1

adresseDest

inataireVille

City of the

recipient or

its executing

service

varchar(50) 0-1

adresseDest

inataireCod

ePays

Country code

of the

recipient or

its executing

service

varchar(2) 0-1

163 / 557


adresseDest

inataireLibel

lePays

Country

description of

the recipient

or the

executing

service

varchar(100

) 0-1

fournisseu

r 1

idFournisse

ur

Technical

identifier of

the supplier in

the CPP 2017

system

integer 1

typeIdentifi

antFourniss

eur

Identifier type

of the

supplier

varchar(14)

Enumeratio

nTypeIdenti

fiant (cf.

Excel file

Definition of

the

messages,

e-mails,

labels,

enumeratio

ns,

parameters)

1

codeFournis

seur Supplier ID varchar(80)

Alphanumer

ic value 1

designation

Fournisseur

Designation

of the

supplier’s

structure

varchar(201

)

This data is

a string of

characters

which

corresponds

to the

corporate

name of the

structure or

the

concatenate

d name and

surname of

its deputy.

(cf. TRA-

CU-00-

RGD-37)

In case of

1

164 / 557


work

invoice, if

the data is

not entered,

the value is

"Non

renseigné"

idServiceFo

urnisseur

Technical ID

of the

supplier’s

service in the

CPP 2017

system

integer

This

identifier

uniquely

identifies

the service

within the

CPP 2017

system.

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

codeService

Fournisseur

Supplier’s

service code

varchar(100

)

Alphanumer

ic value

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

libelleServic

eFournisseu

r

Supplier’s

service

description

varchar(255

)

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

adresseFour

nisseurDeta

il

Detail of the

supplier’s

address

varchar(100

)

Default

value

"FACTURE"

(because

this data is

not

available in

the case of

work

invoices)

1

165 / 557


adresseFour

nisseurCom

plement1

First

complement

of the

supplier’s

address

varchar(100

) 0-1

adresseFour

nisseurCom

plement2

Second

complement

of the

supplier’s

address

varchar(100

) 0-1

adresseFour

nisseurCode

Postal

Postal code of

the supplier’s

address

varchar(10)

For works

invoices, fill

"Non

renseigné"

1

adresseFour

nisseurVille

City of the

supplier’s

address

varchar(50)

For works

invoices, fill

"Non

renseigné"

1

adresseFour

nisseurCode

Pays

Country’s

code of the

supplier’s

address

varchar(2)

For works

invoices, fill

"Non

renseigné"

1

adresseFour

nisseurLibell

ePays

Country’s

description of

the supplier’s

address

varchar(100

)

For works

invoices, fill

"Non

renseigné"

1

numeroRcsF

ournisseur

RCS tax

identification

of the

supplier

varchar(100

)

Alphanumer

ic value 0-1

coordBancai

resFourniss

eurCleIban

IBAN key of

the supplier’s

bank details

varchar(2) Alphanumer

ic value 0-1

coordBancai

resFourniss

eurCleRib

RIB key of

the supplier’s

bank details


ic value 0-1

coordBancai

resFourniss

eurCodeBan

que

Bank code of

the supplier’s

bank details


ic value 0-1

166 / 557


coordBancai

resCodeGui

chet

Sort code of

the supplier’s

bank details


ic value 0-1

coordBancai

resBicSwift

BIC/SWIFT

number of the

supplier’s

bank details


ic value 0-1

coordBancai

resFourniss

eurCodePay

s

Country code

of the

supplier’s

bank details

varchar(2) 0-1

coordBancai

resFourniss

eurCompteB

ancaire

Bank account

of the

supplier’s

bank details


ic value 0-1

coordBancai

resFourniss

eurId

ID of the

supplier’s

bank details

integer 0-1

coordBancai

resFourniss

eurType

Type of the

supplier’s

bank details

varchar(4)

Enumeratio

n TypeCb

(cf. Excel

file

Definition of

the

messages,

e-mails,

labels,

enumeratio

ns,

parameters)

0-1

coordBancai

resFourniss

eurLibelle

Label of the

supplier’s

bank details

varchar(255

)

Alphanumer

ic value 0-1

affactureur 0-1

affactureurId

Technical

identifier of

the factor in

the CPP 2017

system

integer 0-1

affactureurCod

e

Identifier of

the factor varchar(80)

Alphanumer

ic value 0-1

167 / 557


affactureurTyp

eIdentifiant

ID type of the

factor varchar(14)

Enumeratio

n

TypeIdentifi

ant (cf.

Excel file

Definition of

the

messages,

e-mails,

labels,

enumeratio

ns,

parameters)

0-1

affactureurRais

onSociale

Factor’s

corporate

name

varchar(100

) 0-1

affactureurCod

ePays

Factor’s

corporate

name

varchar(2) 0-1

cadreDeFa

cturation 1

codeCadreF

acturation

Invoicing

frameworkInv

oicing

framework

code

varchar(50)

Enumeratio

nCadreFact

uration (cf.

Excel file

Definition of

the

messages,

e-mails,

labels,

enumeratio

ns,

parameters)

1

idValideur1

Technical

identifier of

the first

validator’s in

the CPP 2017

system

integer 0-1

typeIdentifi

antValideur

1

First

validator’s

identifier type

varchar(14)

Enumeratio

n

TypeIdentifi

ant (cf.

Excel file

Definition of

0-1

168 / 557


the

messages,

e-mails,

labels,

enumeratio

ns,

parameters)

codeValideu

r1

First

validator’s

identifier

varchar(80) 0-1

raisonSocial

eValideur1

First

validator’s

designation

varchar(100

)

This data is

a string of

characters

which

corresponds

to the

corporate

name of the

structure or

the

concatenate

d name and

surname of

its deputy.

(cf. TRA-

CU-00-

RGD-37)

0-1

dateValidati

on1

Validation

date by the

first validator

date

Datefield:

AAAA-MM-

JJ

0-1

idValideur2

Technical

identifier of

the second

validator in

the CPP 2017

system

integer 0-1

typeIdentifi

antValideur

2

Second

validator’s ID

type

varchar(14)

Enumeratio

n

TypeIdentifi

ant (cf.

Excel file

Definition of

the

messages,

e-mails,

labels,

enumeratio

0-1

169 / 557


ns,

parameters)

codeValideu

r2

Second

validator’s

identifier

varchar(80) 0-1

designation

Valideur2

Second

validator’s

designation

varchar(100

)

This data is

a string of

characters

which

corresponds

to the

corporate

name of the

structure or

the

concatenate

d name and

surname of

its deputy.

(cf. TRA-

CU-00-

RGD-37)

0-1

dateValidati

on2

Validation

date by the

second

validator

date

Datefield:

AAAA-MM-

JJ

0-1

idMoe

Technical

identifier of

the Project

Manager in

the CPP 2017

system

integer

This

technical

identifier

unquely

identifies

the

structure

within the

CPP 2017

structure

0-1

typeIdentifi

antMoe

Identifier type

of the Project

Manager

varchar(30) 0-1

identifiantM

oe

Identifier of

the Project

Manager

varchar(80) 0-1

170 / 557


designation

Moe

Designation

of the Project

Manager

varchar(201

)

This data is

a string of

characters

which

corresponds

to the

corporate

name of the

structure or

the

concatenate

d name and

surname of

its deputy.

(cf. TRA-

CU-00-

RGD-37)

0-1

idServiceMo

e

Technical

identifier of

the Project

Manager’s

service in the

CPP 2017

system

integer

This

identifier

uniquely

identifies

the service

within the

CPP 2017

system.

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

codeService

Moe

Project

Manager’s

service code

varchar(100

)

Alphanumer

ic value

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

nomService

Moe

Label of the

Project

Manager’s

service

varchar(100

)

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

171 / 557


idMoa

Technical

identifier of

the

Contracting

Authority in

the CPP 2017

system

integer

This

technical

identifier

unquely

identifies

the

structure

within the

CPP 2017

structure

0-1

identifiantM

oa

Identifier of

the

Contracting

Authority

varchar(80) 0-1

designation

Moa

Designation

of the

Contracting

Authority

varchar(201

)

This data is

a string of

characters

which

corresponds

to the

corporate

name of the

structure or

the

concatenate

d name and

surname of

its deputy.

(cf. TRA-

CU-00-

RGD-37)

0-1

idServiceMo

a

Technical

identifier of

the

Contracting

Authority’s

service in the

CPP 2017

system

integer

This

identifier

uniquely

identifies

the service

within the

CPP 2017

system.

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

172 / 557


codeService

Moa

Service code

of the

Contracting

Authority

varchar(100

)

Alphanumer

ic value

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

nomService

Moa

Contracting

Authority’s

service label

varchar(100

)

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

piecePrece

dente

These

parameters

are only

displayed if

the current

works

invoice has

been

created

from a

previous

document.

0-1

cadreFactur

ationPiecePr

ecedente

Invoicing

framework of

the preceding

piece

varchar(50) 0-1

idPiecePrece

dente

Technical

identifier of

the preceding

piece in the

CPP 2017

system

integer 0-1

numeroPiec

ePrecedente

Number of

the preceding

piece

varchar(20) 0-1

idDestinatai

rePiecePrec

edente

Technical

identifier pf

the recipient

structure of

the previous

integer

This

technical

identifier

unquely

identifies

0-1

173 / 557


document in

CPP 2017

the

structure

within the

CPP 2017

structure

identifiantD

estinatairePi

ecePrecede

nte

Identifier pf

the recipient

structure of

the previous

document in

CPP 2017

varchar(14)

Alphanumer

ic value

SIRET of the

previous

document

recipient

0-1

raisonSocial

eDestinatair

ePiecePrece

dente

Corporate

name of the

recipient of

the preceding

piece in the

CPP 2017

system

varchar(99) 0-1

idServiceEx

ecutantPiec

ePrecedente

Technical

identifier of

the recipient

service of the

preceding

piece in the

CPP 2017

system

integer

This

identifier

uniquely

identifies

the service

within the

CPP 2017

system.

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

codeService

ExecutantPi

ecePrecede

nte

Service code

of the

recipient of

the preceding

piece

varchar(100

)

Alphanumer

ic value

If

Service.estP

remierServi

ce = true,

then this

attribute is

not entered.

0-1

nomService

ExecutantPi

ecePrecede

nte

Description of

the recipient

service of the

preceding

piece

varchar(100

)

If

Service.estP

remierServi

ce = true,

then this

0-1

174 / 557


attribute is

not entered.

pieceSuiva

nte

These

parameters

are

displayed

only if there

is a

following

piece, linked

to the

current

work

invoice.

0-1

cadreFactur

ationPieceS

uivante

Invoicing

framework

mode of the

following

piece

varchar(50) 0-1

idPieceSuiv

ante

Technical

identifier of

the following

piece in the

CPP 2017

system

integer 0-1

numeroPiec

eSuivante

Number of

the following

piece

varchar(20) 0-1

references 1

dateFacture

Invoicing date

in the

supplier’s IS

date

Datefield:

AAAA-MM-

JJ

0-1

dateDepot

Submission

date of the

invoice

date

Datefield:

AAAA-MM-

JJ

0-1

codeDevise

Facture

Currency

code of the

invoice

varchar(5) 1

libelleDevis

eFacture

Currency

description of

the invoice

varchar(50)

Multilingual

description:

the returned

1

175 / 557


description

depends on

the

requested

language in

the service

parameters.

typeFacture Invoice type varchar(50)

Enumeratio

nTypeFactur

e (cf. Excel

file

Definition of

the

messages,

e-mails,

labels,

enumeratio

ns,

parameters)

The value

by

default is"F

ACTURE"

(because

this data is

not

available in

the case of

work

invoices)

1

typeFacture

Travaux

Work invoice

type varchar(50)

Enumeratio

n"TypeFact

ureTravaux"

.The service

only returns

the values

of the

enumeratio

n

correspondi

ng to the

available

invoicing

frameworks

Invoicing

framework.

0-1

typeTva VAT type varchar(50) Enumeratio

nTypeTVA 1

176 / 557


(cf. Excel

file

Definition of

the

messages,

e-mails,

labels,

enumeratio

ns,

parameters)

The value

by default

is"SANS_TV

A" (because

this data is

not

available in

the case of

work

invoices)

motifExoner

ationTva

Reason code

for VAT

exemption

varchar(5)

Entered

only if

theVAT type

is «

EXONERATI

ON ».

0-1

libelleMotifE

xonerationT

va

Description of

the reason

for VAT

exemption

varchar(50)

Entered

only if the

VAT type is

«

EXONERATI

ON ».

Multilingual

description:

the returned

description

depends on

the

requested

language in

the service

parameters.

0-1

numeroMar

che

Contract


numeroBon

Commande

Purchase


177 / 557


numeroFact

ureOrigine

Original

invoice

number

varchar(20) 0-1

modePaiem

ent

Payment

mean varchar(11)

Enumeratio

nModeRegle

ments (cf.

Excel file

Definition of

the

messages,

e-mails,

labels,

enumeratio

ns,

parameters)

0-1

dateCreatio

nFacture

Creation date

of the invoice date

Datefield:

AAAA-MM-

JJ HH:MI

1

tailleTotaleP

iecesJointes

Sum of the

size of the

attachments

of the invoice

(in Mb)

decimal(10,

3) 0-1

numeroDpM

andat

Payment

request

number in

Chorus or

Helios

varchar(31) 0-1

recapitulat

ifDeTva 0-1

ligneTva Liste 0-n

ligneTvaTauxR

efId

Identifier of

the

referenced

VAT rate

integer 0-1

ligneTvaTauxR

efCode

Referenced

VAT rate’s

code

varchar(6) 0-1

ligneTvaTauxR

efLibelle

Description of

the varchar(50) 0-1

178 / 557


referenced

VAT rate

ligneTvaTauxR

efValeur

Value of the

referenced

VAT rate

decimal(5,2

) 0-1

ligneTvaTauxM

anuel

Manual data

entry of the

VAT rate

decimal(5,2

) 0-1

ligneTvaMonta

ntBaseHtParTa

ux

Basis amount

without tax

per tax rate

decimal(19,

6) 1

ligneTvaMonta

ntTvaParTaux

Total tax

amount per

tax rate

decimal(19,

6) 1

pageCouran

teLignesRec

apitulatives

TVA

Number of

the current

page

integer 0-1

pagesLignes

Recapitulati

vesTVA

Number of

pages

returned by

the research

integer 0-1

nbResultats

ParPageLign

esRecapitul

ativesTVA

Number of

results per

page

integer 0-1

totalLignesR

ecapitulativ

esTVA

Number of

results

returned by

the research

integer 0-1

montantT

otal 1

montantHtT

otal

Tax-free

amoount of

the invoice

after discount

decimal(19,

6) 1

montantTVA

VAT amount

of the invoice

after discount

decimal(19,

6)

If the

registered

amount is

nil (ie in

1

179 / 557


some cases

of work

invoices),

then the

SXP returns

the result of

the

following

operation :

Facture.mo

ntantTtcAva

ntRemisePie

d -

DemandePa

iement.mon

tantHtGloba

l

montantTtc

AvantRemis

eGlobalTTC

Tax included

amount of the

invoice before

discount

decimal(19,

6)

If the

registered

amount is

nil (ie in

some cases

of work

invoices),

then the

SXP returns

the result of

the

following

operation :

DemandePa

iement.mon

tantHtGloba

l +

DemandePa

iement.mon

tantTvaGlob

al

0-1

montantRe

miseGlobale

TTC

Tax-included

global

allowance

amount

decimal(19,

6) 0-1

motifRemis

eGlobaleTT

C

Reason for

tax-included

global

allowance

amount

text(1024) 0-1

180 / 557


montantTtc

Total

Tax-included

global

amount of the

invoice after

allowance

decimal(19,

6)

If the

registered

amount is

nil (ie in

some cases

of work

invoices),

then the

SXP returns

the result of

the

following

operation :

DemandePa

iement.mon

tantHtGloba

l +

DemandePa

iement.mon

tantTvaGlob

al -

Facture.mo

ntantRemis

eGlobaleTtc

0-1

montantAPa

yer

Payable

amount of the

invoice

decimal(19,

6)

If the

registered

amount is

nil (ie in

some cases

of work

invoices),

then the

SXP returns

the

following

data :

DemandePa

iement.mon

tantTtcGlob

al

1

pieceJoint

ePrincipal

e

0-1

idLiaisonPie

ceJointePrin

cipale

Technical

identifier of

the link

between the

invoice and

integer 1

181 / 557


the main

attachment in

the system

idPieceJoint

ePrincipale

Technical

identifier of

the main

attachment in

the system

integer 1

listeDesPi

ecesJointe

s

0-1


pieceJointeTyp

eCode

Code of

attachment’s

type

varchar(30) 1

pieceJointeTyp

eLibelle

description of

the

attachment’s

type

varchar(50) 1

pieceJointeDesi

gnation

Free

description of

the

attachment

varchar(255

) 1

pieceJointeNu

meroLigneFact

ure

Number of

the invoicing

line to which

the additional

attachment

may refer

integer 0-1

pieceJointeIdLi

aison

Technical

identifier of

the link

between the

invoice and

the

attachment in

the system

integer 1

pieceJointeId

Technical ID

of the

attachment in

the system

integer 1

182 / 557


pieceJointeExte

nsion

Extension of

the

attachment

varchar(5) 1

pageCouran

teListePiece

sJointe

Number of

the current

page

integer 0-1

pagesListePi

ecesJointe

Number of

pages

returned by

the research

integer 0-1

nbResultats

ParPageList

ePiecesJoint

e

Number of

results per

page

integer 0-1

totalListePie

cesJointe

Number of

results

returned by

the research

integer 0-1

lignesDeP

oste 0-1

lignePoste List 0-n

lignePosteNum

ero

Number of

the invoicing

line

integer

In case of

work

invoices, if

the object

does not

exist, return

"0"

1

lignePosteRefer

ence

Description of

the invoicing

line’s

reference

varchar(40) 0-1

lignePosteDeno

mination

Designation

of the

invoicing line

varchar(40) 0-1

lignePosteQuan

tite

Quantity of

the invoicing

line

decimal(19,

6)

In case of

work

invoices, if

the object

does not

1

183 / 557


exist, return

"0"

lignePosteUnite Unit of the

invoicing line varchar(50) 0-1

lignePosteMont

antUnitaireHT

Unit tax-free

amount of the

invoicing line

decimal(19,

6)

In case of

work

invoices, if

the object

does not

exist, return

"0"

1

lignePosteMont

antRemiseHT

Tax-free

rebateamoun

t of the

invoicing line

decimal(19,

6) 0-1

lignePosteTaux

Tva

VAT rate code

of the

invoicing line

varchar(6) 0-1

lignePosteTaux

TvaManuel

Manual data

entry of the

invoicing

line’s VAT

rate

decimal(5,2

) 0-1

lignePosteMont

antHtApresRem

ise

Tax-free

amount after

rebate of the

invoicing line

decimal(19,

6)

In case of

work

invoices, if

the object

does not

exist, return

"0"

1

lignePosteMont

antTva

VAT amount

of the

invoicing line

decimal(19,

6)

In case of

work

invoices, if

the object

does not

exist, return

"0"

1

lignePosteMont

antTtcApresRe

mise

Tax-included

amount after

rebate of the

invoicing line

decimal(19,

6)

In case of

work

invoices, if

the object

does not

1

184 / 557


exist, return

"0"

pageCouran

teLignesPos

te

Number of

the current

page

integer 0-1

pagesLignes

Poste

Number of

pages

returned by

the research

integer 0-1

nbResultats

ParPageLign

esPoste

Number of

results per

page

integer 0-1

totalLignesP

oste

Number of

results

returned by

the research

integer 0-1

commenta

ire

Free

comment

field

text(2000) 0-1

185 / 557


Error table



20001 The user {0} has not any required

authorization in order to process the

payment request {1}

{0} = Name and surname of the user {1} = DemandePaiement.numero GDP_MSG_11.005

20002 The status of the invoice does not allow the requested action

GDP_MSG_01.010

186 / 557


2.2.4.2 Search invoice to be processed by validator

The method rechercherFactureATraiterParValideur allows to show the list of invoices to be processed by a validator

Input table

Attribute Subattribute Typing (tagger) Format Management rules

Service

providing the

data

Multiplicity

idStructure

Technical

identifier of the

structure

within the CPP

2017 system

integer

Required:

IdStructure

OR

TypeIdentifiantStruct

ure +

IdentifiantStructure

RecupererStruct

uresPourValideu

r

0-1

typeIdentifiantStructure

Enumeration of

the possible

values for the

first validator’s

identifier type

varchar(50

)

Enumeration"TypeIde

ntifiant"

Required:

IdStructure

OR


ure +


RecupererStruct

uresPourValideu

r

0-1


Functional

identifier of the

first validator’s

structure

varchar(80

)

Required:

IdStructure

OR


ure +


RecupererStruct

uresPourValideu

r

0-1

pagination

pageResultatD

emandee

Number of the

results page to

be displayed

integer

By default, the

output is the first

page.

0-1

nbResultatsPa

rPage

Number of

results per

page that can

be returned

from the

research

integer

By default, the

service returns 10

results per page.

0-1

triSens Sorting order varchar(10

)

Enumeration with

two possible values:

- ascending sorting

- downward sorting

By default, the

sorting is

downward.

0-1

triColonne

Reference

column of the

sorting

-

Enumeration with the

names of attributes

from the list of

0-1

187 / 557


results. By default,

the sorting is

performed on the

first attribute of the

list of results.

Output table


parametresRetour

0-1

pageCourante Number of the

current page integer 0-1

pages

Number of pages

returned by the

research

integer 0-1

nbResultatsParPa

ge

Number of results

per page integer 0-1

total

Number of results

returned by the

research

integer 0-1


idFacture

Technical identifier

of the invoice/work

invoice within the

CPP 2017 system

integer


identify the invoice within

the system CPP 2017

1

typeDemandePaie

ment

Type of payment

request varchar(50)


values:

- FACTURE

- FACTURE_TRAVAUX

1

idFournisseur Technical identifier

of the supplier integer 1

typeIdentifiantFou

rnisseur

Identifier type of

the supplier varchar(50)

Enumeration"TypeIdentifiant

" 1

188 / 557


identifiantFourniss

eur Supplier identifier varchar(80) Supplier functional identifier 1

designationFourni

sseur

Designation of the

supplier’s

structure

varchar(201) cf. TRA-CU-00-RGD-37 1

codeServiceFourni

sseur

Supplier’s service

code varchar(100) Alphanumeric value 0-1

nomServiceFourni

sseur

Supplier’s service

name varchar(255) 0-1

idMoe


of the Project

Manager in the

CPP 2017 system

integer




2017 structure

0-1

typeIdentifiantMo

e

Identifier type of

the Project

Manager

varchar(30) 0-1

identifiantMoe Identifier of the

Project Manager varchar(80) 0-1

designationMoe Designation of the

Project Manager varchar(201) cf. TRA-CU-00-RGD-37 0-1

idServiceMoe


of the Project

Manager’s service

in the CPP 2017

system

integer



within the CPP 2017

system.

If

Service.estPremierService

= true, then this attribute

is not entered.

0-1

codeServiceMoe Project Manager’s


Alphanumeric value

If



is not entered.

0-1

nomServiceMoe

Label of the

Project Manager’s

service

varchar(100)

If



is not entered.

0-1

189 / 557


idMoa


of the Contracting

Authority in the

CPP 2017 system

integer




2017 structure

0-1

typeIdentifiantMo

a

Identifier type of

the Contracting

Authority

varchar(50) Enumération

"TypeIdentifiant"

identifiantMoa

Identifier of the

Contracting

Authority

varchar(80) 0-1

designationMoa

Designation of the

Contracting

Authority

varchar(201)


characters which

corresponds to the corporate

name of the structure or the

concatenated name and

surname of its deputy. (cf.

TRA-CU-00-RGD-37)

0-1

idServiceMoa


of the Contracting

Authority’s service

in the CPP 2017

system

integer



within the CPP 2017

system.

If



is not entered.

0-1

codeServiceMoa

Service code of

the Contracting

Authority

varchar(100)

Alphanumeric value

If



is not entered.

0-1

nomServiceMoa

Contracting


label

varchar(100)

If



is not entered.

0-1

idDestinataire


of the recipient

within the CPP 2017

system

integer




2017 structure

1

typeIdentifiantDe

stinataire

Identifier type of

the recipient varchar(50)

Enumeration"TypeIdentifiant

"

identifiantDestinat

aire

Identifier of the

invoice recipient varchar(14) Alphanumeric value 1

designationDestin

ataire

Recipient’s



characters which

corresponds to the corporate


1

190 / 557



surname of its deputy.

idServiceExecutan

t


of the executing

service within the

CPP 2017 system

integer



within the CPP 2017

system.

0-1

codeServiceExecu

tant Service code varchar(100) Alphanumeric value 0-1

nomServiceExecut

ant

Executing service’s


idValideur Technical identifier

of the validator integer




2017 systemcf. Service

Metier

1

typeIdentifiantVali

deur

Identifier type of

the validator varchar(50)

Enumeration

"TypeIdentifiant"

first or second validator cf.

Service Metier

identifiantValideur Identifier of the

validator varchar(80)

designationValide

ur

Designation of the

validator’s

structure

varchar(100)

cf. TRA-CU-00-RGD-37

valideur1 ou valideur2 cf.

Service Metier

1

typeFacture Invoice type varchar(50)


values:

- AVOIR

- FACTURE

0-1

typeFactureTrava

ux Work invoice type varchar(50)

Enumeration"TypeFactureTr

avaux".

The service only returns

the values of the

enumeration


available invoicing

frameworks.Invoicing

framework

0-1

numeroFacture

Invoice number or

work invoice

number

varchar(20)


supplier.

Alphanumeric value

1

191 / 557


dateFacture

Invoicing date

(invoice or work

invoice)

date Datefield: AAAA-MM-JJ 0-1

dateDepot Submission date of

the invoice date Datefield: AAAA-MM-JJ 0-1

montantHT

amount excluding

tax of the invoice

or the work

invoice

decimal(19,6

) 1

montantTTC

Amont including

tax of the invoice

or the work

invoice

decimal(19,6

) 0-1

montantAPayer

Payable amount of

the invoice or the

work invoice

decimal(19,6

) 0-1

devise

Currency of the

invoice or the work

invoice

varchar(5) 1

statut

Current status of

the invoice or the

work invoice

varchar(50) 1

numeroMarche Contract number varchar(50) 0-1

numeroEngageme

nt

Purchase order


Error table


20000 Please enter a technical identifier or a type

and a functional identifier of structure. GCU_MSG_00.062

20001 No structure found for identifier {0} GCU_MSG_00.014

20002 No result found TRA_MSG_00.012

192 / 557


2.2.4.3 Search invoice by validator

The method rechercherFactureParValideur allows to search invoices and/or work invoices which must be validated by

a validator

Input table



Service

providing

the data

Multiplicity

typeDemandePaiement

Type of payment

request

varchar

(50)

Enumeration with 2

possible values:

- FACTURE

- FACTURE_TRAVAUX

RecupererTy

peDemandeP

aiement

0-1

idDestinataire technical identifier of the

recipient integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

RechercherD

estinataire 0-1

rechercheSirenDestinataire

Research flag on the

recipient SIREN

number

boolea

n

This boolean allows

the service to

retrieve the SIREN

number when it is

requested by an API

service.

0-1

idServiceExecutant

Technical identifiers of

the recipient service integer

RechercherS

erviceExecut

ant

0-1

numeroFacture Invoice number or work

invoice number

varchar

(20) 0-1

periodeDateDepotDu

Start date of the

submission period date

Date format: AAAA-

MM-JJ 0-1

periodeDateDepotAu

End date of the

submission period date

Date format: AAAA-

MM-JJ 0-1

listeTypeFacture Invoice types list

varchar

(50)

(liste)

Enumeration with 2

possible values:

- AVOIR

- FACTURE

0-n

listeTypeFactureTravaux

List of the work invoice

types

varchar

(50)

(liste)

Enumeration"TypeFac

tureTravaux" with 3

possible values:

-

PROJET_DECOMPTE_

MENSUEL

-

PROJET_DECOMPTE_

FINAL

-

DP_DE_SOUSTRAITA

NT_TRAVAUX

0-n

193 / 557


idFournisseur Technical identifier of

the supplier integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

RecupererFo

urnisseursPo

urValideur

0-1

rechercheSirenFournisseur

Research flag on the

recipient SIREN

number

boolea

n

This boolean allows

the service to

retrieve the SIREN

number when it is

requested by an API

service.

0-1

idServiceFournisseur

Technical ID of the

supplier’s service integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

RecupererSe

rvicesParStr

ucture

0-1

idStructureValideur

Technical identifier of

the first or second

validator

integer

RecupererStr

ucturesPour

Valideur

0-1

idStructureMOE Technical identifier of the

Project Manager integer

RechercherS

tructure 0-1

idStructureMOA Technical identifier of the

Contracting Authority integer

RechercherD

estinataire 0-1

cadreFacturation

Invoicing

frameworkInvoicing

framework code

varchar

(50)

Enumeration (for the

invoices):

-

A9_FACTURE_SOUST

RAITANT

-

A12_FACTURE_COTR

AITANT

Available

enumeration (for the

work invoice):

-

A10_PROJET_DECOM

PTE_MENSUEL_SOUS

TRAITANT

-

A13_PROJET_DECOM

PTE_MENSUEL_COTR

AITANT

-

A14_PROJET_DECOM

PTE_FINAL_COTRAIT

ANT

RecupererCa

dreFacturati

on

0-1

statutCourant

List of the invoice/work

invoice status, on which

the research is

performed

varchar

(50)

(liste)

It is possible to

precise one or

several status(es).

If no status is

RecupererSt

atutsFacture

VisiblesParV

alideur

0-n

194 / 557


precised, there is no

filter on the

statuses.

Si FACTURE:

- A_VALIDER_1 [TO

VALIDATE 1]

- A_VALIDER_2 [TO

VALIDATE 2]

- REFUSEE_1

[REFUSED 1]

- REFUSEE_2

[REFUSED 2]

- DEPOSEE

[DEPOSITED]

-

ERREUR_COTRAITAN

T_SUR_VALIDEUR

[ERROR ON

VALIDATOR BY

COCONTRACTOR]

- SUSPENDUE

[PAUSED]

-

ABSENCE_VALIDATIO

N_1_HORS_DELAI

[ABSENCE OF

VALIDATION 1 AFTER

DEADLINE]

-

ABSENCE_VALIDATIO

N_2_HORS_DELAI

[ABSENCE OF

VALIDATION 2 AFTER

DEADLINE]

-

ERREUR_FOURNISSE

UR_SUR_VALIDEUR

[ERROR ON

VALIDATOR BY

SUPPLIER]

- A_ASSOCIER_MOE

[TO ASSOCIATE

WITH PROJECT

MANAGER]

-

MISE_A_DISPOSITIO

N_MOE [AVAILABLE

TO PROJECT

MANAGER]

-

PRISE_EN_COMPTE_

MOE [TAKEN IN

ACCOUNT BY

195 / 557


PROJECT MANAGER]

- REFUSEE_MOE

[REFUSED BY

PROJECT MANAGER]

Si

FACTURE_TRAVAUX:

- A_VALIDER_1 [TO

VALIDATE 1]

- VALIDEE_1

[VALIDATED 1]

- REFUSEE_1

[REFUSED 1]

- A_VALIDER_2 [TO

VALIDATE 2]

- VALIDEE_2

[VALIDATED 2]

- REFUSEE_2

[REFUSED 2]

-

ERREUR_COTRAITAN

T_SUR_VALIDEUR

[ERROR ON

VALIDATOR BY

COCONTRACTOR]

-

ABSENCE_VALIDATIO

N_1_HORS_DELAI

[ABSENCE OF

VALIDATION 1 AFTER

DEADLINE]

-

ABSENCE_VALIDATIO

N_2_HORS_DELAI

[ABSENCE OF

VALIDATION 2 AFTER

DEADLINE]

- DEPOSEE

[DEPOSITED]

-

EN_COURS_ACHEMIN

EMENT [BEING

DELIVERED]

-

MISE_A_DISPOSITIO

N [AVAILABLE TO

RECIPIENT]

- A_RECYCLER [TO

RECYCLE]

- ABANDONNEE

- SUSPENDUE

[PAUSED]

- COMPLETEE

[COMPLETED]

196 / 557


- REJETEE

[REJECTED]

- MANDATEE

[MANDATED]

-

MISE_EN_PAIEMENT

[PAYMENT]

- COMPTABILISEE

[ACCOUNTED]

-

MISE_A_DISPOSITIO

N_COMPTABLE

[AVAILABLE TO

ACCOUNTANT]

- ASSOCIEE

[ASSOCIATED]

-

EN_COURS_TRAITEM

ENT_PIVOT_S

- REFUSEE_MOE

[REFUSED BY

PROJECT MANAGER]

-

T_INTERPRETEE_OCR

- SERVICE_FAIT

[SERVICE

RENDERED]

periodeDateFactureDu

Start date of the

invoicing period date

Date format: AAAA-

MM-JJ 0-1

periodeDateFactureAu

End date of the invoicing

period date

Date format: AAAA-

MM-JJ 0-1

montantHTMin Minimum tax-free

amount

decimal

(19,6) 0-1

montantHTMax Maximum tax-free

amount

decimal

(19,6) 0-1

montantTTCMin Minimum tax-included

amount

decimal

(19,6) 0-1

montantTTCMax Maximum tax-included

amount

decimal

(19,6) 0-1

montantAPayerMin

Minimum payable

amount

decimal

(19,6) 0-1

montantAPayerMax

Maximum payable

amount

decimal

(19,6) 0-1

197 / 557


numeroMarche Contract number varchar

(50) 0-1

numeroEngagement

Purchase order number varchar

(50)

RechercherE

ngagementJ

uridique

0-1

Pagination

pagination

0-1

pageResult

atDemand

ee

Number of the results

page to be displayed integer

By default, the

output is the first

page.

0-1

nbResultat

sParPage

Number of results per

page that can be

returned from the

research

integer

By default, the

service returns 10

results per page.

0-1

triSens Sorting order varchar

(10)

Enumeration with


- ascending sorting

- downward sorting

By default, the

sorting is

downward.

0-1

triColonne Reference column of the

sorting -

Enumeration of the

possible values:

- IdFacture

-

TypeDemandePaieme

nt

- IdFournisseur

-

IdentifiantFournisseur

-

TypeIdentifiantFourni

sseur

-

DesignationFournisse

ur

-

CodeServiceFournisse

ur

-

NomServiceFournisse

ur

- IdDestinataire

-

IdentifiantDestinatair

e

-

0-1

198 / 557


DesignationDestinatai

re

- IdServiceExecutant

-

CodeServiceExecutan

t

-

NomServiceExecutant

- TypeFacture

- TypeFactureTravaux

- NumeroFacture

- DateFacture

- DateDepot

- MontantHT

- MontantTTC

- MontantAPayer

- Devise

- Statut

- NumeroMarche

-

NumeroEngagement

By default, the

sorting is performed

on the field

"DateDepot".

Output table


te Typing (tagger) Format Management rules Multiplicity

parametre

sRetour

0-1

pageCour

ante

Number: number of the


pages Number: Number of pages

returned by the research integer 0-1

nbResultat

sParpage

Number: number of results


total Number: of results returned

by the research integer 0-1

liste des factures

listeFactur

es liste 0-n

idFacture

Technical identifier of the

invoice/work invoice within

the CPP 2017 system

integer

This ID allows to uniquely identify


2017

1

typeDema

ndePaiem

ent

Type of payment request varcha

r(50)


values:

- FACTURE

- FACTURE_TRAVAUX

1

idFourniss

eur


supplier integer 1

199 / 557


identifiant

Fournisse

ur

Identifier of the supplier varcha

r(80) Supplier functional identifier 1

typeIdenti

fiantFourn

isseur

Identifier type of the

supplier

varcha

r(50) Enumeration"TypeIdentifiant" 1

designatio

nFourniss

eur

Designation of the supplier’s

structure

varcha

r(201)

This data is a string of characters

which corresponds to the corporate


concatenated name and surname

of its deputy. (cf. TRA-CU-00-RGD-

37)

1

codeServi

ceFourniss

eur

Supplier’s service code varcha

r(100) Alphanumeric value 0-1

nomServic

eFournisse

ur

Supplier’s service name varcha

r(255) 0-1

idMoe


Project Manager in the CPP

2017 system

integer

This technical identifier uniquely

identifies the structure within the

CPP 2017 structure

0-1

typeIdenti

fiantMoe

Identifier type of the Project

Manager

varcha

r(30) 0-1

identifiant

Moe

Identifier of the Project

Manager

varcha


designatio

nMoe

Corporate name of the

Project Manager

varcha

r(201)






37)

0-1

idService

Moe


Project Manager’s service in

the CPP 2017 system

integer


the service within the CPP 2017

system.

If Service.estPremierService =

true, then this attribute is not

entered.

0-1

codeServi

ceMoe

Project Manager’s service

code

varcha

r(100)

Alphanumeric value



entered.

0-1

nomServic

eMoe

Label of the Project

Manager’s service

varcha

r(100)



entered.

0-1

idMoa


Contracting Authority in the

CPP 2017 system

integer



CPP 2017 structure

0-1

identifiant

Moa

Identifier of the Contracting

Authority

varcha


designatio

nMoa

Corporate name of the

Contracting Authority

varcha

r(201)


which corresponds to the corporate 0-1

200 / 557





37)

idService

Moa


Contracting Authority’s

service in the CPP 2017

system

integer



system.



entered.

0-1

codeServi

ceMoa

Service code of the


varcha

r(100)

Alphanumeric value



entered.

0-1

nomServic

eMoa


service label

varcha

r(100)



entered.

0-1

idDestinat

aire


recipient within the CPP

2017 system

integer



CPP 2017 structure

1

identifiant

Destinatai

re

Identifier of the invoice

recipient

varcha

r(14)

Alphanumeric value

This is the recipient’s SIRET.

1

designatio

nDestinat

aire

Designation of the recipient varcha

r(201)





of its deputy.

1

idServiceE

xecutant


executing service within the

CPP 2017 system

integer



system.

0-1

codeServi

ceExecuta

nt

Service code varcha


nomServic

eExecutan

t

Executing service’s name varcha

r(255) 0-1

typeFactur

e Invoice type

varcha

r(50)


values:

- AVOIR

- FACTURE

0-1

typeFactur

eTravaux Work invoice type

varcha

r(50)

Enumeration"TypeFactureTravaux".

The service only returns the values

of the enumeration corresponding

to the available invoicing

frameworks.Invoicing framework

0-1

numeroFa

cture

Invoice number or work

invoice number

varcha

r(20)

This ID is unique for each supplier.

Alphanumeric value 1

dateFactur

e

Invoicing date (invoice or

work invoice) date Datefield: AAAA-MM-JJ 0-1

201 / 557


dateDepot Submission date of the

invoice date Datefield: AAAA-MM-JJ 0-1

montantH

T

Tax-free amount of the

invoice or the work invoice

decima

l(19,6) 1

montantT

TC

Tax-included amont of the


decima

l(19,6) 1

montantA

Payer

Payable amount of the


decima

l(19,6) 0-1

devise Currency of the invoice or the

work invoice

varcha

r(5) 1

statut Current status of the invoice

or the work invoice

varcha

r(50) 1

numeroMa

rche Contract number

varcha

r(50) 0-1

numeroEn

gagement Purchase order number

varcha

r(50) 0-1

202 / 557


Error table


20000 POQ_MSG_02.022 - You are not authorized on

the area "{0}"

{0} = EspaceFo.libelleEspaceFo.libelle

POQ-CU-04-SER-04 Search for authorized

structures on FO for User

20001 GDP_MSG_11.046 - "No result found" GFV-CU-11-SER-30 Search for payment

request as validator

203 / 557


2.2.4.4 Retrieve reasons to refuse invoice to be validated

The method recupererMotifsRefusFactureAValider allows to retrieve a referential of reasons to refuse an invoice to

be validated

Input table


codeCadreFacturationAValider

Invoicing

frameworkWork

invoicing framework

code

varchar(50)


values:

- A9_FACTURE_SOUSTRAITANT

-

A10_PROJET_DECOMPTE_MENSU

EL_SOUSTRAITANT


-

A13_PROJET_DECOMPTE_MENSU

EL_COTRAITANT

-

A14_PROJET_DECOMPTE_FINAL_

COTRAITANT

1

Output table


listeMotifRefusFacture

AValider

Liste

0-n

codeMotif Reason code for

the rejection

varchar(20)

1

idMotif Technical

identifier of the

rejection reason

integer

1

libelleMotif Label of the

rejection reason

varchar(25)

1

Error table


204 / 557


2.2.4.5 Retrieve invoice statuses noticeable by the validator

The method recupererStatutsFactureVisiblesParValideur allows a validator to retrieve the list of invoice statuses,

which concern the validator

Input table

Attribute Typing (tagger) Format Management

rules

Service providing the

data Multiplicity

Output table


listeStatutFactur

e

0-n

codeStatutFacture

String: possible

status of the

invoice

varchar(50)

Enumeration of the possible values (for the work invoices or the invoices to be validated)

- A_ASSOCIER_FOURNISSEUR [TO ASSOCIATE WITH SUPPLIER]

- A_ASSOCIER_MOA [TO ASSOCIATE WITH CONTRACTING AUTHORITY]

- A_ASSOCIER_MOE [TO ASSOCIATE WITH PROJECT MANAGER]

- A_COMPLETER [TO COMPLETE]

- A_RECYCLER [TO RECYCLE]

- A_VALIDER_1 [TO VALIDATE 1]

- A_VALIDER_2 [TO VALIDATE 2]

- ABANDONNEE

- ABSENCE_VALIDATION_1_HORS_DELAI [ABSENCE OF VALIDATION 1 AFTER DEADLINE]

- ABSENCE_VALIDATION_2_

HORS_DELAI [ABSENCE OF VALIDATION 2 AFTER DEADLINE]

- ASSOCIEE [ASSOCIATED]

- COMPLETEE [COMPLETED]


1

205 / 557


- DEPOSEE [DEPOSITED]

- EN_COURS_ACHEMINEMENT [BEING DELIVERED]

- EN_COURS_TRAITEMENT_PIVOT_S

- ERREUR_COTRAITANT_SUR_VALIDEUR [ERROR ON VALIDATOR BY COCONTRACTOR]

- ERREUR_DE_MOA [ERROR ON CONTRACTING AUTHORITY]

- ERREUR_DE_MOE

[ERROR ON PROJECT MANAGER]

- MISE_A_DISPOSITION [AVAILABLE TO RECIPIENT]

- MISE_A_DISPOSITION_COMPTABLE [AVAILABLE TO ACCOUNTANT]

- MISE_A_DISPOSITION_MOE [AVAILABLE TO

PROJECT MANAGER]

- MISE_A_DISPOSITION_MOA [AVAILABLE TO CONTRACTING AUTHORITY]


- PRISE_EN_COMPTE_DESTINATAIRE

- PRISE_EN_COMPTE_MOE [TAKEN IN ACCOUNT BY PROJECT MANAGER]

- PRISE_EN_COMPTE_MOA [TAKEN IN ACCOUNT BY CONTRACTING AUTHORITY]



- REFUSEE_FOURNISSEUR [REFUSED BY SUPPLIER]

- REFUSEE_MOA

[REFUSED BY CONTRACTING AUTHORITY]

- REFUSEE_MOE [REFUSED BY PROJECT MANAGER]

206 / 557



- REMPLACEE_PAR_A22

- SERVICE_FAIT [SERVICE RENDERED]


- TRANSMISE_MOA

- VALIDEE_1 [VALIDATED 1]

- VALIDEE_2 [VALIDATED 2]

Error table


207 / 557


2.2.4.6 Process invoice to be validated

The method traiterFactureAValider allows a validator to modify the status of an invoice to be validated in providing a

reason to refuse if it is refused.

Input table

Attribute Typing

(tagger) Format Management rules

Service providing


idFacture DemandePa

iement.id

integer This ID allows to uniquely identify


2017

1

action - varchar(10) Enumeration with 2 possible values:

- REFUS (REJECTION)

- VALIDATION (VALIDATION)

1

typeValideur - varchar(10) Enumeration with 2 possible values:

- TITULAIRE (CONTRACTOR)

- COTRAITANT (CO-CONTRACTOR)

If the service request is a validation or

a rejection whose reason is different

from « Mauvais valideur » (wrong

validator), then the entry of this

parameter is required if the following

properties are checked:

- the invoicing framework is A9

(Invoice deposit by a subcontractor) or

A10 (subcontracting in a work

invoicing framework) Invoicing

frameworkInvoicing framework

- the user is connected to the first

validator’s structure

0-1

idValideur DemandePai

ement.valide

ur2.idStruct

ure

integer The next validator is required and

must exist in the CPP 2017 system if:

- the action is a validation .

- the action is a rejection different

from "MAUVAIS_VALIDEUR"

(WRONG_VALIDATOR), Invoicing

frameworkthe invoicing framework is

A10 and the type of validator is

"COTRAITANT" (CO-CONTRACTOR)

RechercherStructure

s

0-1

motifRefus DemandePa

iement.code

Motif

varchar(20) If the request is "REFUS"

(« REJECTION »), then the rejection

reason must be filled.

RecupererMotifsRef

usFactureAValider

0-1

complement

Info

HistoEtatDe

mandePaie

ment.comm

entaire

varchar(255

)

In case of rejection of an invoice,

the system saves the concatenated

rejection reason and complement of

information in the

fieldHistoEtatDemandePaiement.com

mentaire

In case of validation or processing of

an invoice, the complement of

information is saved by the system

0-1

208 / 557


in the

fieldHistoEtatDemandePaiement.com

mentaire

If the rejection reason is « Autre »

(Other), the complement of

informationmust have more than

three characters (without blank)

Output table


idFacture Technical ID of the invoice

in the CPP 2017 system

integer This ID allows to uniquely identify the invoice within the system CPP 2017

1

numeroFacture Invoice number varchar(20) This ID is unique for each supplier Alphanumeric value

1

dateTraitement Invoice processing date date Datefield: AAAA-MM-JJ HH:MI 1

statutFacture Current status of the

invoice varchar(50)

1

209 / 557


Error table


20000 GDP_MSG_11.008 - The payment request

{0} has not been found

{0}= parametered identifier of the ayment

request

GFV-CU-11-SER-11 Validate or refuse an

invoice in the API mode

20001 GDP_MSG_11.048 - The parametered request

type is not known in the system



20002 GDP_MSG_11.013 - The rejection reason is

required in case of rejection



20003 GDP_MSG_11.054 - In case of rejection, the

validation framework "Titulaire" (contractor)

or "Cotraitant" (co-contractor) is required.



20004 GDP_MSG_11.028 - In case of validation, the

validation framework "Titulaire" (contractor)

or "Cotraitant" (co-contractor) is required.



20005 GDP_MSG_11.014 - In case of « cotraitant

(co-contractor) validation, the identifier of the

contractor is required.



20006 GDP_MSG_11.005 - The user {0} has not any

required authorization in order to process the

payment request {1}

{0}=Nom et prénom de l'utilisateur

{1}=DemandePaiement.numero

TRA-CU-00-SER-01 Ajouter fichier dans le

système (modes portail & service)

20007 GDP_MSG_11.015 - The status of the

payment request is {0}. In order to

validate/refuse a payment request, its status

must be A VALIDER (TO BE VALIDATED) or

ERREUR DU COTRAITANT SUR DESTINATAIRE

(ERROR OF THE CO-CONTRACTOR ON

RECIPIENT)

{0}=DemandePaiement.etatCourant



20008 GCU_MSG_05.001 - The connection request

does not exist



210 / 557


2.2.5 Retrieve invoice information


- Search payment request

- Consult invoice history

- Download invoice group

2.2.5.1 Search payment request

The method rechercherDemandePaiement allows to retrieve payment requests from archive base and living database

for the connected user according to specific parameters (exposed service will not work on the qualification

environment

Input table



Service providing


roleUtilisateur

varchar(20

)

Enumeration with 5

possible values:

- FOURNISSEUR

- MOE

- MOA

- VALIDEUR

- DESTINATAIRE

1

numeroFacture Invoice

number or

work invoice

number

varchar(20

)

0-1

typeDemandePaiement

Type of

payment

request

varchar(50

)

Enumeration with 2

possible values:

- FACTURE

-

FACTURE_TRAVAUX

If empty, the search

is done on paiment

requests with

« FACTURE » and

« FACTURE_TRAVA

UX » types

0-1

typeFacture Invoice

type

varchar(50

)

Enumeration

"TypeFacture "

0-1

typeFactureTravaux

Works invoice

typeWorks

invoice type

varchar(50

)

Enumeration

"TypeFactureTravau

x"

RecupererTypeFact

ureTravaux

0-1

cadreFacturation

Invoicing

frameworkInv

oicing

framework

varchar(50

)

Enumeration

"CadreFacturation"

RecupererCadreFac

turation

0-1

statutCourant Current status varchar(50

) (liste)

Enumeration

"EtatDemandePaiem

ent"

RecupererEtatParTy

peDemandePaieme

nt

0-1

211 / 557


periodeDateHeureEtatCourantDu

Last change

date, from

date 0-1

periodeDateHeureEtatCourantAu

Last change

date, to

date 0-1

periodeDateFournisseurDu

Supplier date,

from

date 0-1

periodeDateFournisseurAu

Supplier date,

to

date 0-1

periodeDateDepotDu

Submission

date of the

invoice, from

date 0-1

periodeDateDepotAu

Submission

date of the

invoice, to

date 0-1

montantHTMin Minimum tax-

free amount

decimal(19

,6)

0-1

montantHTMax Maximum tax-

free amount

decimal(19

,6)

0-1

montantTTCMi

n Minimum tax-

included

amount

decimal(19

,6)

0-1

montantTTCMax

Maximum tax-

included

amount

decimal(19

,6)

0-1

montantAPayerMin

Minimum

payable

amount

decimal(19

,6)

0-1

montantAPayerMax

Maximum

payable

amount

decimal(19

,6)

0-1

numeroMarche Contract

number

varchar(50

)

0-1

numeroBonCommande

Commitment

number

varchar(50

)

RechercherEngage

mentJuridique

0-1

numeroFactureOrigine

Original

invoice

number

varchar(20

)

0-1

structureFournisseur

0-1

212 / 557


idStructureFo

urnisseur

Technical

identifier of

the supplier

structure

integer RechercherStructur

e

0-1

typeIdentifian

tStructureFou

rnisseur

Enumeration

of possible

values for the

identifier type

of the supplier

structure

varchar(50

)

Enumeration

"TypeIdentifiant"

RechercherStructur

e

0-1

identifiantStru

ctureFourniss

eur

Funcionnal

identifier of

the supplier

structure

varchar(80

)

RechercherStructur

e

0-1

rechercheSirenFournisseur

Research flag

on the

recipient

SIREN

number

boolean

This boolean

allows the service

to retrieve the

SIREN number

when it is

requested by an

API service.

0-1


Technical ID

of the

supplier’s

service

integer RechercherServices

Structure

0-1

structureMoe 0-1

idStructureMo

e

Technical

identifier of

the projet

manager

structure


e

0-1

typeIdentifian

tStructureMoe

Enumeration

of possible

values for the

identfier type

of the preoject

manager

structure

varchar(50

)

Enumeration

"TypeIdentifiant"

RechercherStructur

e

0-1

identifiantStru

ctureMoe

Funcionnal

identifier of

the project

manager

varchar(80

)

RechercherStructur

e

0-1

idServiceMoe Technical

identifier of

the project

manager

service


Structure

0-1

structureMoa 0-1

213 / 557


idStructureMo

a

Technical

identifier of

the

contracting

authority

structure


e

0-1

typeIdentifian

tStructureMoa

Enumeration

of possible

values for the

identifier type

of the

contracting

authority

structure

varchar(50

)

RechercherStructur

e

0-1

identifiantStru

ctureMoa

Funcionnal

identifier of

the

contracting

authority

structure

varchar(80

)

RechercherStructur

e

0-1

idServiceMoa Technical

identifier of

the

contracting

authority

service


Structure

0-1

structureValideur

0-1

idStructureVal

ideur

Technical

identifier of

the validator


e

0-1

typeIdentifian

tStructureVali

deur

Enumeration

of the possible

values for the

identifier type

of the

validator

varchar(50

)

Enumeration

"TypeIdentifiant"

RechercherStructur

e

0-1

identifiantStru

ctureValideur

Functional

identifier of

the validator

structure

varchar(80

)

RechercherStructur

e

0-1

structureDestinataire

0-1

idStructureDe

stinataire

Technical

identifier of

the recipient

structure

integer RechercherDestinat

aire

0-1

typeIdentifian

tStructureDes

tinataire

Enumeration

des possible

values for the

identifier type

of the

varchar(50

)

Enumeration

"TypeIdentifiant"

RechercherDestinat

aire

0-1

214 / 557


recipient

structure

identifiantStru

ctureDestinat

aire

Funcionnal

identifier of

the recipient

structure

varchar(80

)

RechercherDestinat

aire

0-1


Research flag

on the

recipient

SIREN

number

boolean

This boolean

allows the service

to retrieve the

SIREN number

when it is

requested by an

API service.

0-1

idServiceDestinataire

Recipient

service


Structure

0-1

dpOuDpArchive

Database

where the

payment

request is

situated

varchar(50

)

Enumeration with 2

possible values:

-

DEMANDE_PAIEMEN

T

- DP_ARCHIVE

0-1

Output table


listeDemandePaiement

0-n

idDemandePai

ement


the payment request

in Chorus Pro

integer 1

numeroDeman

dePaiement

Invoice number or

work invoice number

varchar(20) 1

typeDemande

Paiement

Type of payment

request

varchar(50) Enumeration

"TypeDemandePaiement",

1

typeFacture Invoice typeInvoice

type

varchar(50) Enumeration "TypeFacture " 0-1

typeFactureTr

avaux

Works invoice type varchar(50) Enumeration

"TypeFactureTravaux"

0-1

215 / 557


cadreFacturati

on

Invoicing framework varchar(50) Enumeration

"CadreFacturation"

0-1

etatCourant Current state varchar(50) Enumeration

"EtatDemandePaiement"

1

dateHeureEtat

Courant

Last state change

date, from

date 1

commentaire

EtatCourant

String : comment

on the current

status

varchar(255) 0-1

dateFournisse

ur

Supplier date date 0-1

dateDepot Submission date of

the invoice

date 0-1

montantHT Tax-free amount decimal(19,6) 0-1

montantTTC Tax-included amount decimal(19,6) 0-1

montantAPaye

r

Payable amount of

the invoice

decimal(19,6) 0-1


numeroBonCo

mmande

Commitment number varchar(50) 0-1

numeroFactur

eOrigine

Original invoice

number

varchar(20) 0-1

idStructureFou

rnisseur


the supplier structure

integer 1

216 / 557


idServiceFourn

isseur

Technical ID of the

supplier’s service

integer 0-1

idStructureMo

e


the project manager

structure

integer 0-1

idServiceMoe Technical identifier of

the project manager

service

integer 0-1

idStructureMo

a


the contracting

authority structure

integer 0-1

idServiceMoa Technical identifier of

the contracting

authority service

integer 0-1

idStructureVali

deur1


the validator

structure

integer 0-1

idStructureVali

deur2


the validator 2

structure

integer 0-1

idStructureDes

tinataire


the recipient

structure

integer 0-1

idServiceDesti

nataire


the recipient service integer 0-1

dpOuDpArchiv

e

Database where the

payment request is

situated

varchar(50) Enumeration with 2 possible

values:

- DEMANDE_PAIEMENT

- DP_ARCHIVE

0-1

Error table



and a functional identifier of a structure.

GCU_MSG_00.062 - SXP

This message has an effect on all the

entered structures

20001 No payment request match the

criterias GDP_MSG_11.061

20002 Search returns more than {0} results.

Please input more criteria.

TRA_MSG_00.025

{0} = maximum number of results

allowed for the current search screen

217 / 557


20003 No structure found for the identifier

{0}.

GCU_MSG_00.014

{0} = identifier

This message intervenes on all

structures filled in

20004 The service {0} is unknown for the

structure {1}.

GCU_MSG_06.004

{0} = service identifier

{1} = structure identifier

20005 The beginning date must be earlier than

the end date.

TRA_MSG_09.007

This control is applied to every date in

input

20006

The minimum value of the amount

must be less than the maximum value

of the amount.

TRA_MSG_09.008

This control is applied to every amount

intervals in input

20007

Searching for archived payment

requests is currently not possible.

Please try again later.

GDP_MSG_01.027

Service métier GDP-CU-01-SER-35

218 / 557


2.2.5.2 Consult invoice history

The method consulterHistoriqueFacture allows to show the evenment history as well as the current status of a received

invoice, an invoice to be validated or an sent invoice.

Input table

Attribute Attribute Typing (tagger) Format Management rules Multiplicity

idUtilisateurCo

urant



Chorus Pro system

integer



the 2017 CPP system

0-1

idFacture

Number: technical

identifier of the

invoice/work invoice

within the CPP 2017

system

integer


identify the invoice within

the system CPP 2017

1

idEspace

Number: technical

identifier of the area in

the Chorus Pro system

integer


identify the area within the

system CPP 2017

Default value

(corresponding to the

received invoices area): 7

0-1

nbResultatsMa

ximum

Number: Maximum

number of results that

can be seen for a

research

integer



results.

0-1

Status history search parameters

paramRecherch

eHistoStatuts 0-1

pageResultat

DemandeeLis

teHistoStatut


status history’s results

page to be displayed


the first page. 0-1

nbResultatsP

arPageListeHi

stoStatut

Number: Number of

results per page that can

be returned from the

search of the status

history

integer



page.

0-1

triSensListeHi

stoStatut String: sorting order

varchar(1

0)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonneList

eHistoStatut

String: reference column

of the sorting reference

column of sorting

-

Enumeration with 7

possible values:

- HistoStatutCode

- HistoStatutDatePassage

- HistoStatutCommentaire

-

0-1

219 / 557


HistoStatutUtilisateurPreno

m

-

HistoStatutUtilisateurNom

-

HistoStatutUtilisateurEmail

-

HistoStatutUtilisateurTelep

hone


performed on the field By

default, the sorting is

performed on the

field"HistoStatutDatePassa

ge".

Research parameters for the history of the user’s actions

paramRecherch

eHistoEveneme

ntsComplemen

taires

0-1

pageResultat

DemandeeLis

teHistoEvene

ment


complementary events

list’s results page to be

displayed


the first page. 0-1

nbResultatsP

arPageListeHi

stoEvenemen

t

Number: Number of



search of the

complementary events’

history

integer



page.

0-1

triSensListeHi

stoEvenemen

t

String: sorting order varchar(1

0)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonneList

eHistoEvene

ment


of the sorting -

Enumeration with 3

possible values:

- EvenementLibelle

- EvenementQui

- EvenementDateHeure



"EvenementDateHeure".

0-1

Research parameters for the history of the user’s actions

220 / 557


paramRecherch

eHistoActionsUt

ilisateurs

0-1

pageResultat

DemandeeLis

teHistoAction


user’s action results page

to be displayed


the first page. 0-1

nbResultatsP

arPageListeHi

stoAction

Number: Number of



research of the history of

user’s actions



page

0-1

triSensListeHi

stoAction String: sorting order

varchar(1

0)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonneList

eHistoAction


of the sorting -

Enumeration with 6

possible valuespossible

values:

- histoActionDateHeure

- histoActionCode

-

histoActionUtilisateurPreno

m

-

histoActionUtilisateurNom

-

histoActionUtilisateurEmail

-

histoActionUtilisateurTelep

hone



"histoActionDateHeure".

0-1

221 / 557


Output table

Attribute Subattribute Sous-

Subattribute Typing (tagger) Format Management rules Multiplicity

idFacture

Number: technical

identifier of the

invoice/work

invoice within the

CPP 2017 system

integer

This identifier

uniquely identifies

the invoice or the

works invoice within

the 2017 CPP

system

1

numeroFact

ure

String: invoice

number or work

invoice number

varchar(20

)


each supplier.

Alphanumeric value

The special

characters in

brackets below are

accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

modeDepot

String: deposit

mode of the invoice

or the work invoice

varchar(15

)

Enumeration with

10 possible values:

- SAISIE_PORTAIL

- SAISIE_API

-

DEPOT_PDF_PORTA

IL

-

DEPOT_PDF_SIGNE

_PORTAIL

- DEPOT_PDF_API

-

DEPOT_PDF_SIGNE

_API

- EDI

- UPLOAD_PORTAIL

- UPLOAD_API

-

EDI_NUMERISATIO

N

1

statutCoura

ntCode

String: value of the

current status of

the invoice or of

the works invoice

varchar(50

) 1

Historiques des statuts

historiquesD

esStatuts 1

histoStatut Liste List sorted by date

of passage. 1-n

222 / 557


histoStatutI

d

Number: technical

identifier of the

state history of the

invoice or of the

works invoice in the

2017 CPP system

integer 1

histoStatutC

ode

String: value of the

status history of

the invoice or of

the works invoice

varchar(50

) 1

histoStatutD

atePassage

String: date of

transition to this

state

date Datefield: AAAA-

MM-JJ HH:MI 1

histoStatutC

ommentaire

String: comment

entered in case of

rejection /

validation

varchar(25

5) 0-1

histoStatutU

tilisateurPre

nom

String: first name

of the user at the

initiative of the

change of status

varchar(10

0) 0-1

histoStatutU

tilisateurNo

m

String: last name

of the user at the

initiative of the

change of status

varchar(10

0) 0-1

histoStatutU

tilisateurEm

ail

String: email of the

user at the

initiative of the

change of status

varchar(20

0) 0-1

histoStatutU

tilisateurTele

phone

String: phone

number of the user

at the initiative of

the change of

status

varchar(18

) 0-1

pageCourant

eHistoStatut

Number: number of


pagesHistoS

tatut

Number: number of

research returned

results of pages

returned by the

research

integer 0-1

nbResultatsP

arPageHisto

Statut

Number: Number


totalHistoSta

tut

Number: Number

of research

returned results

integer 0-1

Additional events history

historiquesDesEvenementsComplementaires

0-1

223 / 557


evenement Liste

List sorted in

chronological order

of date.

0-n

evenementI

d

Number: technical

identifier of the

event in the CPP

2017 system

integer 1

evenementLi

belle String: event name text(1024) 1

evenementQ

ui

String: structure

that is causing the

event

varchar(25

5) 1

evenementD

ateHeure

String: date of the

event date

Datefield: AAAA-

MM-JJ HH:MI 1

pageCourant

eEvenement

Number: number of


pagesEvene

ment

Number: Number

of research

returned pages

integer 0-1

nbResultatsP

arPageEvene

ment

Number: Number


totalEvenem

ent

Number: Number

of research

returned results

integer 0-1

Last action

derniereAction

1

derniereActi

onId

Number: technical

identifier of the last

action of the

invoice or of the


2017 CPP system

integer 0-1

derniereActi

onCode

String: last action

code

varchar(50

) 0-1

User actions history

historiquesDesActionsUtilisateurs

1

histoAction Liste

List sorted in

chronological order

of date.

0-n

histoActionI

d

Number: technical

identifier of actions

history of the

invoice or of the


2017 CPP system

integer 1

224 / 557


histoActionD

ateHeure

String: date of

completion of the

action


MM-JJ HH:MI 1

histoActionC

ode String: action code

varchar(50

)

Enumeration with 1

possible value:

-

TELECHARGEMENT_

FACTURE

1

histoActionU

tilisateurPre

nom

String: first name

of the user at the

initiative of the

action

varchar(10

0) 0-1

histoActionU

tilisateurNo

m

String: last name

of the user at the

initiative of the

action

varchar(10

0) 0-1

histoActionU

tilisateurEm

ail

String: email of the

user at the

initiative of the

action

varchar(20

0) 0-1

histoActionU

tilisateurTele

phone

String: phone

number of the user

at the initiative of

the action

varchar(18

) 0-1

pageCourant

eHistoAction

Number: number of


pagesHistoA

ction

Number: Number

of pages returned

by the research

integer 0-1

nbResultatsP

arPageHisto

Action

Number: Number


totalHistoAct

ion

Number: Number

of results returned

by the research

integer 0-1

225 / 557


Error table

Error code Description Associated error

message


20001 The user {0} is not allowed to perform this action GDP_MSG_11.005

226 / 557


2.2.5.3 Download invoice group

The method telechargerGroupeFacture allows to download one or several sent invoices, received invoices or invoices

to be validated in specifying the format (XML, PDF or ZIP) as well as the attachments. The downloaded file must not

exceed the maximum size of an invoice file (120 Mo), no matter how many downloaded invoices. If the file exceeds

this size, a 413 error code will be sent.

Input table

Attribute Subattr

ibute Typing (tagger) Format Management rules Multiplicity




Chorus Pro system

integer



2017 CPP system

0-1

idEspace

Number: technical

identifier of the area in

the 2017 CPP system

integer


identifies the area within the

2017 CPP system

Default value (corresponding

to the received invoices area

): 7

0-1

format

String: format under

which invoices or work

invoices must be

retrieved

varchar(

5)


values:

- PDF

- PIVOT

1

avecPiecesJointes

Complementaires

String: flag indicating

whether additional

attachments should be

retrieved (only if Format

= "PDF")

varchar(

3)

This parameter must be filled

in only if Format = "PDF".


values:

- Oui

- Non

If the format passed in

parameter is "PIVOT", the

attachments are

systematically downloaded.

0-1

Invoices list

listeFacture 1

idFactu

re

Number: list of technical

identifiers for invoices or

works invoices within

CPP 2017

integer

(liste)


identifies invoices or works

invoices within the 2017 CPP

system

1-n

Output table

227 / 557


Attribute Typing Format Management rules Multiplicity

fichierResultat String: binary file base

64 encoded file

The format of the file to be returned differs

according to the following cases:

1) If "Format" = "PIVOT":

The service only returns a single pivot format

file, which will contain one or more invoices with

their encoded attachments.

2.a) If "Format" = "PDF", and if there is only

one attachment to retrieved for a single

invoice : :

The service returns a single PDF format file.

2.b) If "Format" = "PDF", and there are multiple

attachments to return for a single invoice:

The service returns a ZIP archive containing PDF

attachments.

2.c) If "Format" = "PDF", and that there are

multiple attachments to return for multiple

invoices:

The service returns a ZIP archive containing PDF

attachments. The archive contains a repertory

per invoice.

1

228 / 557


Error table


20000 Mandatory field: « No payment request selected » GDP-CU-01-RGD-148

20001 Mandatory field: « The payment requests format is

mandatory » GDP-CU-01-RGD-76

20002

The maximum number of downloadable payment requests

in the same transaction is capped at XX payment

requests.

GDP_MSG_11.009

Maximum number of

downloadable payment

requests.

20003 The invoice or the works invoice has not been found GDP_MSG_11.008

20004

The user isn’t allowed for this downloading.

To download an invoice from issued invoices, the

connection between the user and one of the following

services or structures must be « VALIDE »:

- to the supplier service or the supplier structure,

To download an invoice from invoices to validate, the



- to the validator 1 structure,

- to the validator 2 structure,

To download an invoice from works invoices, the



- to the supplier service or the supplier structure,

- to the project manager structure or service, - to the

contracting authority structure or service,

To download an invoice from received invoices, the



- to the recipient structure or service,

Furthermore, the user must be “ACTIF”

GDP_MSG_11.005

20005

The status (DemandePaiement.etatCourant) of the payment request in the database must not be equal to: - « BROUILLON » [DRAFT] - « SUPPRIME » [DELETED]

GDP_MSG_11.010

20006 Returning an error or no response from the SMA

229 / 557


2.3 Work invoice

2.3.1 Initiate or complete an invoice file


- Consult invoice file

- Consult work invoice

- Search work invoice

- Search work invoice to be processed

- Submit work invoice

2.3.1.1 Consult invoice file

The method ConsulterDossierDeFacturation allows a user to consult the invoice file for works contract.

Input table


(tagger) Format

Management

rules

Service

providing the

data

Multiplicity

idFactureTravaux

Number:

technical

identifier of

the work

invoice within

the CPP 2017

system

integer

This technical

identifier

uniquely

identifies the

work invoice

within the CPP

2017 system.

1

codeLangue

String: code

of the

language used

in the

multilingual

descriptions

varchar(2)

Without value,

if no language

is chosen or

supported by

the system,

the

descriptions

are written in

french.

0-1


pListePiecesJointes

0-1

pageResultatD

emandeeListe

PieceJointe

Number:

number of the

attachment’s

list results

page to be

displayed

integer

By default,

the output is

the first page.

0-1

nbResultatsPa

rPageListePiec

eJointe

Number:

Number of

results per

page that can

be returned

integer

By default,

the service

returns 10

results per

page.

0-1

230 / 557


by the

research of

the

attachment’s

list

triSensListePie

cesJointes

String: sorting

order varchar(10)

Enumeration

with two

possible

values:

- ascending

sorting

- downward

sorting

By default,

the sorting is

downward.

0-1

triColonneList

ePiecesJointes

String:

reference

column of the

sorting

-

Enumeration

with 4

possible

values:

-

PieceJointeTy

peCode

-

PieceJointeTy

peLibelle

-

PieceJointeDe

signation

-

PieceJointeExt

ension

By default,

the sorting is

performed on

the field

"PieceJointeD

esignation".

0-1

231 / 557


Output table


e

Sous-

Subattribut

e

Sous-sous-

Subattribut

e

Typing


Multi

plicit

y

Liste de factures de travaux

listeFactureTravaux

0-n

typeDemandePaiement

String: type of

payment

request

varchar(50) 1

typeFactureTravaux

String: work


Enumeration with

11 possible values:

-

DP_DE_SOUSTRAIT

ANT_TRAVAUX

-

PROJET_DECOMPTE

_MENSUEL

- ETAT_ACOMPTE

-

ETAT_ACOMPTE_VA

LIDE

-

PROJET_DECOMPTE

_FINAL

-

PROJET_DECOMPTE

_GENERAL

-

PROJET_DECOMPTE

_GENERAL_PROCE

DURE_TACITE

-

DECOMPTE_GENER

AL

-

DECOMPTE_GENER

AL_SIGNE

-

DECOMPTE_GENER

AL_DEFINITIF_TACI

TE

-

DECOMPTE_GENER

AL_DEFINITIF_PRO

CEDURE_TACITE

0-1

idFactureTravaux

Number:

technical

identifier of the

work invoice

within the CPP

2017 system=

integer

This identifier

uniquely identifies

the work invoice

within the CPP

2017 system.

1

232 / 557


dateCreationFactureTravaux

String:

creation date

of the work

invoice

date

Date format: AAAA-

MM-

JJTHH:MM:SS+HH:

SS

1

numeroFactureTravaux

String: number

of the work

invoice

varchar(20)

This ID is unique

for each supplier.

Alphanumeric value

1

etatFactureTravaux

String: current

status of the

work invoice

varchar(50)

Enumeration with

37 possible values:

- BROUILLON

[DRAFT]

- A_VALIDER_1 [TO

VALIDATE 1]

-

ERREUR_FOURNISS

EUR_SUR_VALIDEU

R [ERROR ON

VALIDATOR BY

SUPPLIER]

-

ABSENCE_VALIDAT

ION_1_HORS_DELA

I [ABSENCE OF

VALIDATION 1

AFTER DEADLINE]

- REFUSEE_1

[REFUSED 1]

- VALIDEE_1

[VALIDATED 1]

- A_VALIDER_2 [TO

VALIDATE 2]

-

ERREUR_COTRAITA

NT_SUR_VALIDEUR

[ERROR ON

VALIDATOR BY

COCONTRACTOR]

-

ABSENCE_VALIDAT

ION_2_HORS_DELA

I [ABSENCE OF

VALIDATION 2

AFTER DEADLINE]

- REFUSEE_2

[REFUSED 2]

- VALIDEE_2

[VALIDATED 2]

-

A_ASSOCIER_MOE

[TO ASSOCIATE

WITH PROJECT

MANAGER]

1

233 / 557


- ERREUR_DE_MOE

[ERROR ON

PROJECT

MANAGER]

- REFUSEE_MOE

[REFUSED BY

PROJECT

MANAGER]

-

MISE_A_DISPOSITI

ON_MOE

[AVAILABLE TO

PROJECT

MANAGER]

-

PRISE_EN_COMPTE

_MOE [TAKEN IN

ACCOUNT BY

PROJECT

MANAGER]

-

A_ASSOCIER_MOA

[TO ASSOCIATE

WITH

CONTRACTING

AUTHORITY]

- ERREUR_DE_MOA

[ERROR ON

CONTRACTING

AUTHORITY]

- REFUSEE_MOA

[REFUSED BY

CONTRACTING

AUTHORITY]

-

A_ASSOCIER_FOUR

NISSEUR [TO

ASSOCIATE WITH

SUPPLIER]

-

REFUSEE_FOURNIS

SEUR [REFUSED BY

SUPPLIER]

- SUSPENDUE

[PAUSED]

- A_COMPLETER

[TO COMPLETE]

- ASSOCIEE

[ASSOCIATED]

- DEPOSEE

[DEPOSITED]

-

234 / 557


MISE_A_DISPOSITI

ON [AVAILABLE TO

RECIPIENT]

- A_RECYCLER [TO

RECYCLE]

- COMPLETEE

[COMPLETED]

- TRANSMISE_MOA

-

PRISE_EN_COMPTE

_DESTINATAIRE

- REJETEE

[REJECTED]

- SERVICE_FAIT

[SERVICE

RENDERED]

- MANDATEE

[MANDATED]

- COMPTABILISEE

[ACCOUNTED]

-

MISE_A_DISPOSITI

ON_COMPTABLE

[AVAILABLE TO

ACCOUNTANT]

-

MISE_EN_PAIEMEN

T [PAYMENT]

dateHeureEtatCourant

String: date of

getting to the

current status

of the work

invoice


MM-JJThh:mm:ss 1

modeDepot

String: deposit

mode of the

work invoice

varchar(50)

Enumeration with 7

possible values:

-

DEPOT_PDF_PORTA

IL

-

DEPOT_PDF_SIGNE

_PORTAIL

- DEPOT_PDF_API

-

DEPOT_PDF_SIGNE

_API

- EDI

- UPLOAD_PORTAIL

- UPLOAD_API

-

1

identifiantDestinataire

String:

identifier of the varchar(14)

Alphanumeric value

0-1

235 / 557


work invoice

recipient

This is the


designationDestinataire

String:

designation of

the work

invoice’s

recipient

varchar(201

)


of characters which

corresponds to the

corporate name of


concatenated name

and surname of its

deputy.

0-1

codeServiceExecutant

String: service

code of the

work invoice

recipient

varchar(100

)

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

nomServiceExecutant

String:

description of

the recipient

service of the

work invoice

varchar(100

)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

identifiantFournisseur

String:

supplier ID varchar(80) 1

raisonSocialeFournisseur

String:

corporate

name of the

supplier

varchar(255

) 1

codeService

Fournisseur

String:

supplier’s

service code

varchar(100

)

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

nomServiceFournisseur

String:

supplier’s

service name

varchar(100

)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

codeCadreFacturationT

ravaux

String:

Invoicing

frameworkwor

k invoicing

framework

code

varchar(50)

Enumeration avec

18 possible values:

-

A4_PROJET_DECOM

PTE_MENSUEL_FOU

RNISSEUR

-

A5_ETAT_ACOMPTE

_FOURNISSEUR

-

A6_ETAT_ACOMPTE

_VALIDE_FOURNIS

SEUR

-

1

236 / 557


A7_PROJET_DECOM

PTE_FINAL_FOURNI

SSEUR

-

A8_DECOMPTE_GE

NERAL_DEFINITIF_

FOURNISSEUR

- -

A10_DP_DE_SOUS

TRAITANT_TRAVAU

X

-

A13_PROJET_DECO

MPTE_MENSUEL_C

OTRAITANT

-

A14_PROJET_DECO

MPTE_FINAL_COTR

AITANT

-

A15_ETAT_ACOMPT

E_MOE

-

A16_ETAT_ACOMPT

E_VALIDE_MOE

-

A17_PROJET_DECO

MPTE_GENERAL_M

OE

-

A18_DECOMPTE_G

ENERAL_MOE

-

A19_ETAT_ACOMPT

E_VALIDE_MOA

-

A20_DECOMPTE_G

ENERAL_MOA

-

A22_PROJET_DECO

MPTE_GENERAL_FO

URNISSEUR_PROCE

DURE_TACITE

-

A23_DECOMPTE_G

ENERAL_DEFINITIF

_TACITE_FOURNIS

SEUR

-

A24_DECOMPTE_G

ENERAL_DEFINITIF

_TACITE_MOE

237 / 557


-

A25_DECOMPTE_G

ENERAL_DEFINITIF

_MOE_PROCEDURE

_TACITE

identifiantValideur1

String: first

validator’s

identifier

varchar(80) 0-1

raisonSocialeValideur1

String:

corporate

name of the

first validator

varchar(99)

Informed if

TypeIdentifiant <>

PARTICULIER

0-1

identifiantValideur2

String: second

validator’s

identifier

varchar(80) 0-1

raisonSocialeValideur2

String:

corporate

name of the

second

validator

varchar(99)

Informed if

TypeIdentifiant <>

PARTICULIER

0-1

identifiantMoe

String:

identifier of the

Project

Manager

varchar(80) 0-1

raisonSocialeMoe

String:

corporate

name of the

Project

Manager

varchar(201

) 0-1

codeService

Moe

String: Project

Manager’s

service code

varchar(100

)

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

nomServiceMoe

String: label of

the Project

Manager’s

service

varchar(100

)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

identifiantMoa

String:

identifier of the

Contracting

Authority

varchar(80) 0-1

raisonSocialeMoa

String:

corporate

name of the

Contracting

Authority

varchar(201

) 0-1

codeServiceMoa

String: service

code of the

varchar(100

)

Alphanumeric value

If

Service.estPremier

0-1

238 / 557


Contracting

Authority

Service = true,

then this attribute

is not entered.

nomServiceMoa

String:

Contracting

Authority’s

service label

varchar(100

)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

idPiecePrecedente

Number:

technical

identifier of the

recipient

service of the

preceding

piece in the

CPP 2017

system

integer 1

idPieceSuivante

Number:

technical

identifier of the

following piece

in the CPP

2017 system

integer 1

dateFactureTravaux

String: work

invoicing date date

Datefield: AAAA-

MM-

JJTHH:MM:SS+HH:

SS

0-1

dateDepot

String:

Submission

date of the

work invoice

date

Datefield: AAAA-

MM-

JJTHH:MM:SS+HH:

SS

0-1

numeroMarche

String:

contract

number

varchar(50) 0-1

numeroBoncommande

String:

purchase order

number

varchar(50) 0-1

modePaiement

String:

payment mean varchar(40) 0-1

montantHtTotal

Number: tax-

free amount of

the work

invoice after

rebate

decimal(19,

6) 0-1

montantTtcTotal

Number: tax-

included

amount of the

work invoice

after rebate

decimal(19,

6) 0-1

montantAPayer

Number:

payable

decimal(19,

6) 0-1

239 / 557


amount of the

invoice

History

historiqueDemandePaiement

Liste: history list of the work invoice status changes

0-n

dateHeure

String: date of getting to the historical status

Date

Datefield: AAAA-MM-JJTHH:MM:SS+HH:SS

1

etat

String: value of the history of the work invoice status

varchar(50) 1

commentaire

String: comment during the work invoice processing

varchar(255)

0-n

qui

String: identity of the changer of status:

corporate name of the structure + « » + name of the service which changed the status

varchar(255)

1

List of attachments

listeDesP

iecesJoin

tes

0-1


pieceJointe

Id

Number: Technical ID of the attachment in the system

integer 1

pieceJointe

Reference

String: reference of the attachment

varchar(50)

pieceJointe

Designatio

n

String: free description of the attachment

varchar(255)

1

pieceJointe

EstModifia

ble

Booleen: indicates if the attachment could be modified

boolean

pieceJointe

EstPrincipa

le

Booleen: indicates if the attachment is the main attachment or not

Boolean

pieceJointe

TypeCode

String: code of attachment’s type

varchar(30) 1

pieceJointe

IdLiaison

Number: technical identifier of the

integer 1

240 / 557


link between the invoice and the attachment in the system

pieceJointe

Reference

Sma

String: reference of the attachment in the SMA

varchar(255)

pieceJointe

Fichier

Number: technical identifier of the associated

binary file

integer

pageCouran

teListePiece

sJointe

Number: number of the current page

integer 0-1

pagesListeP

iecesJointe

Number: Number of pages returned by the research

integer 0-1

nbResultats

ParPageList

ePiecesJoin

te

Number: number of results per page

integer 0-1

totalListePi

ecesJointe

Number: number of results returned by the research

integer 0-1

Error table


20000 The invoicing file does not exist GFT_MSG_01.056

20001 The user cannot view the invoicing file GFT_MSG_01.103

20002 No result found GFT_MSG_01.075

241 / 557


2.3.1.2 Consult work invoice

The method consulterFactureTravaux allows to show the information from a work invoice.

Input table



Service

providing

the data

Multiplicity

idFactureTravaux

Number:

technical identifier of the work invoice within the CPP 2017 system

integer

The technical identifier uniquely identifies the work invoice within the CPP 2017 system.

1

codeLangue

String: code of the language used in the multilingual

descriptions

varchar(2)

Without value, if no language is chosen or supported by the system, the descriptions are written in french.

0-1


pListePiecesJointes 0-1

pageResultatDemandeeListePieceJointe

Number: number of the attachment’s list results page to be displayed

integer By default, the output is the first page. 0-1

nbResultatsParPageList

ePieceJointe

Number: Number of results per page that can be returned by

the research of the attachment’s list

integer By default, the service returns 10 results per page. 0-1

triSensListePiecesJointes

String: sorting order

varchar(10)


possible values: - ascending sorting - downward sorting By default, the sorting is downward.

0-1

triColonneListePiecesJointes

String:

reference column of the sorting

-

Enumeration with 4 possible values: - PieceJointeTypeCode - PieceJointeTypeLibelle

- PieceJointeDesignation - PieceJointeExtension By default, the sorting is performed on the field "PieceJointeDesignation".

0-1

242 / 557


Output table


e

Sous-

Subattribut

e

Sous-sous-

Subattribut

e


Multi

plicit

y

factureTravaux

1

idFactureTravaux

Number:

technical

identifier of the

work invoice

within the CPP

2017 system

integer

This identifier

uniquely identifies

the work invoice

within the CPP

2017 system.

1

numeroFact

ureTravaux

String: number

of the work

invoice

varchar(20)


each supplier.

Alphanumeric

value.

The special

characters in

brackets below are

accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

statutFactu

reTravaux

String: current

status of the

work invoice

varchar(50)

Enumeration with

37 possible values:

- BROUILLON

[DRAFT]

- A_VALIDER_1 [TO

VALIDATE 1]

-

ERREUR_FOURNISS

EUR_SUR_VALIDEU

R [ERROR ON

VALIDATOR BY

SUPPLIER]

-

ABSENCE_VALIDAT

ION_1_HORS_DELA

I [ABSENCE OF

VALIDATION 1

AFTER DEADLINE]

- REFUSEE_1

[REFUSED 1]

- VALIDEE_1

[VALIDATED 1]

- A_VALIDER_2 [TO

VALIDATE 2]

-

ERREUR_COTRAITA

NT_SUR_VALIDEUR

1

243 / 557


[ERROR ON

VALIDATOR BY

COCONTRACTOR]

-

ABSENCE_VALIDAT

ION_2_HORS_DELA

I [ABSENCE OF

VALIDATION 2

AFTER DEADLINE]

- REFUSEE_2

[REFUSED 2]

- VALIDEE_2

[VALIDATED 2]

-

A_ASSOCIER_MOE

[TO ASSOCIATE

WITH PROJECT

MANAGER]

- ERREUR_DE_MOE

[ERROR ON

PROJECT

MANAGER]

- REFUSEE_MOE

[REFUSED BY

PROJECT

MANAGER]

-

MISE_A_DISPOSITI

ON_MOE

[AVAILABLE TO

PROJECT

MANAGER]

-

PRISE_EN_COMPTE

_MOE [TAKEN IN

ACCOUNT BY

PROJECT

MANAGER]

-

A_ASSOCIER_MOA

[TO ASSOCIATE

WITH

CONTRACTING

AUTHORITY]

- ERREUR_DE_MOA

[ERROR ON

CONTRACTING

AUTHORITY]

- REFUSEE_MOA

[REFUSED BY

CONTRACTING

AUTHORITY]

244 / 557


-

A_ASSOCIER_FOUR

NISSEUR [TO

ASSOCIATE WITH

SUPPLIER]

-

REFUSEE_FOURNIS

SEUR [REFUSED BY

SUPPLIER]

- SUSPENDUE

[PAUSED]

- A_COMPLETER

[TO COMPLETE]

- ASSOCIEE

[ASSOCIATED]

- DEPOSEE

[DEPOSITED]

-

MISE_A_DISPOSITI

ON [AVAILABLE TO

RECIPIENT]

- A_RECYCLER [TO

RECYCLE]

- COMPLETEE

[COMPLETED]

- REJETEE

[REJECTED]

- SERVICE_FAIT

[SERVICE

RENDERED]

- MANDATEE

[MANDATED]

- COMPTABILISEE

[ACCOUNTED]

-

MISE_A_DISPOSITI

ON_COMPTABLE

[AVAILABLE TO

ACCOUNTANT]

-

MISE_EN_PAIEMEN

T [PAYMENT]

-

MISE_A_DISPOSITI

ON_MOE

[AVAILABLE TO

PROJECT

MANAGER]

-TRANSMISE_MOA

-

PRISE_EN_COMPTE

_DESTINATAIRE

245 / 557


modeDepot

String: deposit

mode of the

work invoice

varchar(50)

Enumeration with

les possible values:

- SAISIE_PORTAIL

- SAISIE_API

-

DEPOT_PDF_PORTA

IL

-

DEPOT_PDF_SIGNE

_PORTAIL

- DEPOT_PDF_API

-

DEPOT_PDF_SIGNE

_API

- EDI

- UPLOAD_PORTAIL

- UPLOAD_API

-

EDI_NUMERISATIO

N

1

Destinataire

destinataire 0-1

idDestinatai

re

Number:

technical

identifier of the

recipient in the

CPP 2017

system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

1

identifiantD

estinataire

String:

identifier of the

work invoice

recipient

varchar(14)

Alphanumeric value

This is the


1

designation

Destinatair

e

String:

designation of

the work

invoice’s

recipient

varchar(20

1)


of characters which

corresponds to the

corporate name of


concatenated name

and surname of its

deputy.

0-1

idServiceEx

ecutant

Number:

technical

identifier of the

recipient

service in CPP

2017

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

246 / 557


codeService

Executant

String: service

code of the

work invoice

recipient

varchar(10

0)

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

nomService

Executant

String:

description of

the recipient

service of the

work invoice

varchar(10

0)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

adresseDes

tinataireDet

ail

String: detail of

the recipient’s

address

varchar(10

0) 0-1

adresseDes

tinataireCo

mplement1

String: address’

first

complement

about the

recipient

varchar(10

0) 0-1

adresseDes

tinataireCo

mplement2

String: address’

second

complement

about the

recipient

varchar(10

0) 0-1

adresseDes

tinataireCo

dePostal

String: postal

code of the

recipient

varchar(10) 0-1

adresseDes

tinataireVill

e

String: city of

the recipient varchar(50) 0-1

adresseDes

tinataireCo

dePays

String: country

code of the

recipient

varchar(2) 0-1

adresseDes

tinataireLib

ellePays

String: country

description of

the recipient

varchar(10

0) 0-1

Fournisseur

fournisseur 1

idFournisse

ur

Number:

technical

identifier of the

supplier in the

CPP 2017

system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

The special

characters in

brackets below are

accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

247 / 557


typeIdentifi

antFourniss

eur

String:

identifier type

of the supplier

varchar(30) 1

identifiantF

ournisseur

String: supplier

ID varchar(80) 1

raisonSocial

eFournisseu

r

String:

corporate name

of the supplier

varchar(25

5) 0-1

nomFournis

seur

String: name of

the supplier’s

deputy

varchar(10

0)

Informed if

TypeIdentifiant =

PARTICULIER et

DemandePaiement.

etatCourant=BROUI

LLON [DRAFT]

0-1

prenomFou

rnisseur

String:

surname of the

supplier’s

deputy

varchar(10

0)

Informed if

TypeIdentifiantFour

nisseur =

PARTICULIER et

DemandePaiement.

etatCourant=BROUI

LLON [DRAFT]

0-1

idServiceFo

urnisseur

Number:

technical ID of

the supplier’s

service in the

CPP 2017

system

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

codeService

Fournisseur

String:

supplier’s

service code

varchar(10

0)

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

nomService

Fournisseur

String:

supplier’s

service name

varchar(10

0)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

adresseFou

rnisseurDet

ail

String: detail of

the supplier’s

address

varchar(10

0) 0-1

adresseFou

rnisseurCo

mplement1

String: first

complement of

the supplier’s

address

varchar(10

0) 0-1

248 / 557


adresseFou

rnisseurCo

mplement2

String: second

complement of

the supplier’s

address

varchar(10

0) 0-1

adresseFou

rnisseurCod

ePostal

String: postal

code of the

supplier’s

address

varchar(10) 0-1

adresseFou

rnisseurVill

e

String: city of

the supplier’s

address

varchar(50) 0-1

adresseFou

rnisseurCod

ePays

String:

country’s code

of the supplier’s

address

varchar(2) 0-1

adresseFou

rnisseurLib

ellePays

String:

country’s

description of

the supplier’s

address

varchar(10

0) 0-1

numeroRcs

Fournisseur

String: RCS tax

identification of

the supplier

varchar(10


coordBanca

iresCleIban

String: IBAN

key of the

supplier’s bank

details


coordBanca

iresCleRib

String: RIB key

of the supplier’s

bank details


coordBanca

iresCodeBa

nque

String: bank

code of the

supplier’s bank

details


coordBanca

iresCodeGui

chet

String: sort

code of the

supplier’s bank

details


coordBanca

iresBicSwift

String:

BIC/SWIFT

number of the

supplier’s bank

details


coordBanca

iresCodePa

ys

String: country

code of the

supplier’s bank

details

varchar(2) 0-1

coordBanca

iresCompte

Bancaire

String: bank

account of the

supplier’s bank

details


249 / 557


coordBanca

iresId

Number: ID of

the supplier’s

bank details

integer 0-1

coordBanca

iresType

String: type of

the supplier’s

bank details

varchar(4)

Enumeration with 2

possible values:

- IBAN

- RIB

0-1

coordBanca

iresLibelle

String: label of

the supplier’s

bank details

varchar(25


affactureur 0-1

affactureurI

d

Number:

technical

identifier of the

factor in the

CPP 2017

system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

0-1

affactureur

Code

String:

identifier of the

factor

varchar(80) 0-1

affactureur

TypeIdentifi

ant

String: factor’s

identifier type varchar(30) 0-1

affactureur

RaisonSocia

le

String:

corporate name

of the factor

varchar(25

5)


of characters which

corresponds to the

corporate name of


concatenated name

and surname of its

deputy.

0-1

affactureur

CodePays

String: country

code of the

factor

varchar(2) 0-1

Invoicing framework

cadreDeFacturation

1

codeCadreF

acturationT

ravaux

String:

Invoicing

frameworkwork

invoicing

framework

code

varchar(50)

Enumeration with

18 possible values:

-

A4_PROJET_DECOM

PTE_MENSUEL_FOU

RNISSEUR

-

1

250 / 557


A5_ETAT_ACOMPTE

_FOURNISSEUR

-

A6_ETAT_ACOMPTE

_VALIDE_FOURNIS

SEUR

-

A7_PROJET_DECOM

PTE_FINAL_FOURNI

SSEUR

-

A8_DECOMPTE_GE

NERAL_DEFINITIF_

FOURNISSEUR

-

A10_DP_DE_SOUS

TRAITANT_TRAVAU

X

-

A13_PROJET_DECO

MPTE_MENSUEL_C

OTRAITANT

-

A14_PROJET_DECO

MPTE_FINAL_COTR

AITANT

-

A15_ETAT_ACOMPT

E_MOE

-

A16_ETAT_ACOMPT

E_VALIDE_MOE

-

A17_PROJET_DECO

MPTE_GENERAL_M

OE

-

A18_DECOMPTE_G

ENERAL_MOE

-

A19_ETAT_ACOMPT

E_VALIDE_MOA

-

A20_DECOMPTE_G

ENERAL_MOA

-

A22_PROJET_DECO

MPTE_GENERAL_FO

URNISSEUR_PROCE

DURE_TACITE

-

A23_DECOMPTE_G

251 / 557


ENERAL_DEFINITIF

_TACITE_FOURNIS

SEUR

-

A24_DECOMPTE_G

ENERAL_DEFINITIF

_TACITE_MOE

-

A25_DECOMPTE_G

ENERAL_DEFINITIF

_MOE_PROCEDURE

_TACITE

idValideur1

Number:

technical

identifier of the

first validator in

the CPP 2017

system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

0-1

typeIdentifi

antValideur

1

String: first

validator’s

identifier type

varchar(30) 0-1

identifiantV

alideur1

String: first

validator’s

identifier

varchar(80) 0-1

raisonSocial

eValideur1

String:

corporate name

of the first

validator

varchar(99)

Informed if

TypeIdentifiant <>

PARTICULIER

0-1

nomValideu

r1

String: first

validator’s

corporate name

varchar(10

0)

Informed if

TypeIdentifiant =

PARTICULIER

0-1

prenomVali

deur1

String: name of

the first

validator’s

deputy

varchar(10

0)

Informed if

TypeIdentifiant =

PARTICULIER

0-1

dateValidati

on1

String:

validation date

by the first

validator

date

Date field: AAAA-

MM-

JJTHH:MM:SS+HH:

SS

0-1

idValideur2

Number:

technical

identifier of the

second

validator in CPP

2017

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

0-1

typeIdentifi

antValideur

2

String: second

validator’s

identifier type

varchar(30) 0-1

identifiantV

alideur2

String: second

validator’s

identifier

varchar(80) 0-1

252 / 557


raisonSocial

eValideur2

String:

corporate name

of the second

validator

varchar(99)

Informed if

TypeIdentifiant <>

PARTICULIER

0-1

nomValideu

r2

String: name of

the second

validator’s

deputy

varchar(10

0)

Informed if

TypeIdentifiant =

PARTICULIER

0-1

prenomVali

deur2

String:

surname of the

second

validator’s

deputy

varchar(10

0)

Informed if

TypeIdentifiant =

PARTICULIER

0-1

dateValidati

on2

String:

validation date

by the second

validator

date

Date field: AAAA-

MM-

JJTHH:MM:SS+HH:

SS

0-1

idMoe

Number:

technical

identifier of the

of the Project

Manager in the

CPP 2017

system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

0-1

typeIdentifi

antMoe

String:

identifier type

of the Project

Manager

varchar(30) 0-1

identifiantM

oe

String:

identifier of the

Project

Manager

varchar(80) 0-1

raisonSocial

eMoe

String:

corporate name

of the Project

Manager

varchar(20

1) 0-1

nomMoe

String: name of

the Project

Manager’s

deputy

varchar(10

0)

Informed if

TypeIdentifiantMoe

= PARTICULIER

and

DemandePaiement.

etatCourant=BROUI

LLON [DRAFT]

0-1

prenomMoe

String:

surname of the

Project

Manager

deputy

varchar(10

0)

Informed if

TypeIdentifiantMoe

= PARTICULIER

and

DemandePaiement.

etatCourant=BROUI

LLON [DRAFT]

0-1

idServiceMo

e

Number:

technical integer

This identifier

uniquely identifies 0-1

253 / 557


identifier of the

Project

Manager’s

service in the

CPP 2017

system

the service within

the CPP 2017

system.

If

Service.estPremier

Service = true,

then this attribute

is not entered.

codeService

Moe

String: Project

Manager’s

service code

varchar(10

0)

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

nomService

Moe

String: label of

the Project

Manager’s

service

varchar(10

0)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

idMoa

Number:

technical

identifier of the

Contracting

Authority in the

CPP 2017

system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

0-1

identifiantM

oa

String: identifier

of the

Contracting

Authority

varchar(80) 0-1

raisonSocial

eMoa

String:

corporate name

of the

Contracting

Authority

varchar(20

1) 0-1

idServiceMo

a

Number:

technical

identifier of the

Contracting

Authority’s

service in the

CPP 2017

system

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

codeService

Moa

String: service

code of the

Contracting

Authority

varchar(10

0)

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

254 / 557


nomService

Moa

String: label of

the Contracting

Authority’s

service

varchar(10

0)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

Preceding piece

piecePrecedente

These parameters

are only displayed

if the current works

invoice has been

created from a

previous document.

0-1

cadreFactur

ationPieceP

recedente

String:

invoicing

framework of

the preceding

piece

varchar(50) 1

idPiecePrec

edente

Number:

technical

identifier of the

preceding piece

in the CPP 2017

system

integer 1

numeroPiec

ePrecedent

e

String: number

of the

preceding piece

varchar(20) 1

idDestinatai

rePiecePrec

edente

Number:

technical

identifier of the

recipient

structure of the

preceding piece

in the CPP 2017

system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

1

identifiantD

estinataireP

iecePrecede

nte

String:

identifier of the

recipient

structure of the

preceding piece

in the CPP 2017

system

varchar(14)

Alphanumeric value

There is the SIRET

number of the

recipient of the

preceding piece.

1

raisonSocial

eDestinatai

rePiecePrec

edente

String:

corporate name

of the recipient

structure of the

preceding piece

in the CPP 2017

system

varchar(99) 1

255 / 557


idServiceEx

ecutantPiec

ePrecedent

e

Number:

technical

identifier of the

recipient

service of the

preceding piece

in the CPP 2017

system

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

codeService

ExecutantPi

ecePrecede

nte

String: service

code of the

recipient of the

preceding piece

varchar(10

0)

Alphanumeric value

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

nomService

ExecutantPi

ecePrecede

nte

String:

description of

the recipient

service of the

preceding piece

varchar(10

0)

If

Service.estPremier

Service = true,

then this attribute

is not entered.

0-1

Following piece

pieceSuivante

These parameters

are displayed only

if there is a

following piece,

linked to the

current work

invoice.

0-1

cadreFactur

ationPieceS

uivante

String:

invoicing

framework

code of the

following piece

varchar(50) 1

idPieceSuiv

ante

Number:

technical

identifier of the

following piece

in the CPP 2017

system

integer 1

numeroPiec

eSuivante

String: number

of the following

piece

varchar(20) 1

Références

references 1

dateFacture

Travaux

String: work

invoicing date date

Date field: AAAA-

MM-

JJTHH:MM:SS+HH:

SS

0-1

256 / 557


dateDepot

String:

Submission

date of the

work invoice

date

Date field: AAAA-

MM-

JJTHH:MM:SS+HH:

SS

0-1

codeDevise

FactureTrav

aux

String:

currency code

of the work

invoice

varchar(3) 1

libelleDevis

eFactureTra

vaux

String:

currency

description of

the work

invoice

varchar(50)

Multilingual

description:the

returned

description depends

on the requested

language in the

service parameters.

1

typeFacture

Travaux

String: work


Enumeration with

11 possible values:

-

DP_DE_SOUSTRAIT

ANT_TRAVAUX

-

PROJET_DECOMPTE

_MENSUEL

- ETAT_ACOMPTE

-

ETAT_ACOMPTE_VA

LIDE

-

PROJET_DECOMPTE

_FINAL

-

PROJET_DECOMPTE

_GENERAL

-

PROJET_DECOMPTE

_GENERAL_PROCE

DURE_TACITE

-

DECOMPTE_GENER

AL

-

DECOMPTE_GENER

AL_SIGNE

-

DECOMPTE_GENER

AL_DEFINITIF_TACI

TE

-

DECOMPTE_GENER

AL_DEFINITIF_PRO

CEDURE_TACITE

1

257 / 557


typeTva String: VAT

type varchar(50)

Enumeration with 4

possible values:

- TVA_SUR_DEBIT

-

TVA_SUR_ENCAISS

EMENT

- EXONERATION

- SANS_TVA

0-1

motifExone

rationTva

String: reason

code for VAT

exemption

varchar(5)

Entered only if the

VAT type is «

Exonéré ».

0-1

libelleMotifE

xonerationT

va

String: reason

label for VAT

exemption

varchar(50)

Entered only if the

VAT type is «

Exonéré ».

Multilingual

description: the

returned

description depends

on the requested

language in the

service parameters.

0-1

numeroMar

che

String: contract


numeroBon

Commande

String:

purchase order

number

varchar(50) 0-1

modePaiem

ent

String:

payment mean varchar(40) 0-1

dateCreatio

nFactureTra

vaux

String: creation

date of the

work invoice

date

Date field: AAAA-

MM-

JJTHH:MM:SS+HH:

SS

1

dateEchean

cePaiement

String:

payment date

of the invoice,

entered by the

supplier

date

Date field: AAAA-

MM-

JJTHH:MM:SS+HH:

SS

0-1

tailleTotale

PiecesJoint

es

String: sum of

the size of the

attachments of

the invoice (in

Mb)

decimal(10,

3) 0-1

numeroDp

Mandat

String:

Payment

request number

in Chorus or

Helios

varchar(31) 0-1

VAT summary

recapitulatifDeTva

0-1

258 / 557


ligneTva Liste 1-n

ligneTvaTa

uxRefId

Number:

identifier of the

referenced VAT

rate

integer

This identifier

uniquely identifies

the VAT rate within

the CPP 2017

system.

0-1

ligneTvaTa

uxRefCode

String:

referenced VAT

rate’s code

varchar(6) 0-1

ligneTvaTa

uxRefLibell

e

String:

description of

the referenced

VAT rate

varchar(50) 0-1

ligneTvaTa

uxRefValeu

r

Number: value

of the

referenced VAT

rate

decimal(5,2

) 0-1

ligneTvaTa

uxManuel

Number:

manual data

entry of the

VAT rate

decimal(5,2

) 0-1

ligneTvaMo

ntantBaseH

tParTaux

Number: basis

amount without

tax per tax rate

decimal(19,

6) 1

ligneTvaMo

ntantTvaPa

rTaux

Number: total

tax amount per

tax rate

decimal(19,

6) 1

pageCouran

teLignesRec

apitulatives

TVA

Number:

number of the

current page

integer 0-1

pagesLigne

sRecapitula

tivesTVA

Number:

Number of

pages returned

by the research

integer 0-1

nbResultats

ParPageLig

nesRecapit

ulativesTVA

Number:

number of

results per

page

integer 0-1

totalLignes

Recapitulati

vesTVA

Number:

Number of

results returned

by the research

integer 0-1

Global amounts

montantsTotaux

0-1

montantHtT

otal

Number: tax-

free amount of

the work

decimal(19,

6) 0-1

259 / 557


invoice after

rebate

montantTV

A

Number: global

VAT amount of

the work

invoice after

rebate

decimal(19,

6) 0-1

montantTtc

Total

Number: tax-

included

amount of the

work invoice

after rebate

decimal(19,

6) 0-1

montantAP

ayer

Number:

payable

amount of the

work invoice

decimal(19,

6) 0-1

Main attachment


0-1

idLiaisonPie

ceJointePrin

cipale

Number:

technical

identifier of the

link between

the work

invoice and the

attachment in

the system

integer

This identifier

uniquely identifies

the link between

the work invoice

and the main

attachment within

the CPP 2017

system.

1

idPieceJoint

ePrincipale

Number:

technical

identifier of the

main

attachment in

the system

integer

This identifier

uniquely identifies

the attachment

within the 2017

CPP system

1

List of attachments


0-1

pieceJointe List 1-n

pieceJointe

TypeCode

String: code of

attachment’s

type

varchar(30) 1

pieceJointe

TypeLibelle

String:

description of

the

attachment’s

type

varchar(50) 1

pieceJointe

Designation

String: free

description of

the attachment

varchar(25

5) 1

pieceJointeI

dLiaison

Number:

technical

identifier of the

integer 1

260 / 557


link between

the invoice and

the attachment

in the system

pieceJointeI

d

Number:

Technical ID of

the attachment

in the system

integer 1

pieceJointe

Extension

String:

extension of

the attachment

varchar(5) 1

pageCouran

teListePiece

sJointe

Number:

number of the

current page

integer 0-1

pagesListeP

iecesJointe

Number:

Number of

pages returned

by the research

integer 0-1

nbResultats

ParPageList

ePiecesJoin

te

Number:

number of

results per

page

integer 0-1

totalListePi

ecesJointe

Number:

Number of

results returned

by the research

integer 0-1

Error table


20000 The work invoice does not exist. GFT_MSG_01.029

20001 The user cannot view this work invoice GFT_MSG_01.076

261 / 557


2.3.1.3 Search work invoice

The method rechercherFactureTravaux allows to show a list of work invoices according to the specified criteria.

Input table



Service

providing

the data

Multiplicity

roleUtilisateur

String: user role for the research

varchar(20)


values: - FOURNISSEUR - MOE - MOA

1

idStructureF

ournisseur


supplier in the CPP 2017 system

integer

This identifier uniquely identifies the supplier’s

structure within the CPP 2017 system.

If RoleUtilisateur = 'FOURNISSEUR': RecupererSt

ructuresActivesPourFactureTravaux Else: RechercherStructure

0-1


Number: technical ID of the supplier’s service in the CPP 2017 system

integer

This identifier uniquely identifies the supplier’s service within the CPP 2017 system.

If RoleUtilisateur =

'FOURNISSEUR': RecupererServicesParStructure Else: RechercherServicesStructure

0-1

idStructureMoe

Number: technical identifier of the Project Manager’s structure in the CPP 2017 system

integer

This identifier uniquely identifies the Project Manager’s structure within the CPP 2017 system.

IfRoleUtilisateur = 'MOE': RecupererStructuresActivesPourFactureTravaux Else: RechercherStructure

0-1

idServiceMoe

Number: technical identifier of the Project Manager’s service in the CPP 2017 system

integer

This identifier uniquely identifies the Project Manager’s service within the CPP 2017 system.

IfRoleUtilisateur = 'MOE': RecupererServicesParStructure Else: RechercherServicesStr

ucture

0-1

idStructureMoa


integer This identifier uniquely identifies the Contracting

If RoleUtilisateur =

0-1

262 / 557


Contracting Authority in the CPP 2017 system

Authority within the CPP 2017 system.

'MOA': RecupererStructuresActivesPourFact

ureTravaux Else: RechercherStructure

idServiceMoa


Contracting Authority’s service in the CPP 2017 system

integer


identifies the Project Manager’s service within the CPP 2017 system.

If RoleUtilisateur = 'MOA': RecupererS

ervicesParStructure Else: RechercherServicesStructure

0-1

listeTypeFactureTravaux

String: list of the work invoicing types

varchar(50) (liste)

Enumeration with 11 possible values: -

DP_DE_SOUSTRAITANT_TRAVAUX - PROJET_DECOMPTE_MENSUEL - ETAT_ACOMPTE - ETAT_ACOMPTE_VALIDE - PROJET_DECOMPTE_FINAL - PROJET_DECOMPTE_GENERAL -

PROJET_DECOMPTE_GENERAL_PROCEDURE_TACITE - DECOMPTE_GENERAL - DECOMPTE_GENERAL_SIGNE - DECOMPTE_GENERAL_DEFINITIF_TACITE - DECOMPTE_GENERAL_DEFINITIF_PROCEDURE_TACITE

This field accept a value among the following: - no element - one element - several elements If there is no element entered, then the fiel dis ignored.

RecupererTypeFactureTravaux

0-n

idDestinataire

Number:

technical identifier of the recipient in the CPP 2017 system

integer

This identifier uniquely identifies the recipient structure within the CPP 2017 system.

RechercherDestinataire

0-1


Research flag on the recipient SIREN number

boolean

This boolean allows the service to retrieve the SIREN number when it is requested by an API service.

0-1

263 / 557


idServiceExecutant

Number: technical identifier of the recipient

service in the CPP 2017 system

integer This identifier uniquely identifies the recipient service

within the CPP 2017 system.

RechercherServiceExec

utant

0-1

periodeDateDepotDu

String: start date of the submission period

date Date field: AAAA-MM-JJ or AAAA-MM-JJTHH:MM:SS+HH:MM

0-1

periodeDateDepotAu

String: end

date of the submission period

date

Date field: AAAA-MM-JJ

or AAAA-MM-JJTHH:MM:SS+HH:MM

0-1

cadreFacturation

String: Invoicing frameworkinvoicing framework code

varchar(50)

Enumeration with the following possible values: - A4_PROJET_DECOMPTE_MENSUEL_FOURNISSEUR - A5_ETAT_ACOMPTE_FOURNIS

SEUR - A6_ETAT_ACOMPTE_VALIDE_FOURNISSEUR - A7_PROJET_DECOMPTE_FINAL_FOURNISSEUR - A8_DECOMPTE_GENERAL_DEFINITIF_FOURNISSEUR -

A10_PROJET_DECOMPTE_MENSUEL_SOUSTRAITANT - A13_PROJET_DECOMPTE_MENSUEL_COTRAITANT - A14_PROJET_DECOMPTE_FINAL_COTRAITANT - A15_ETAT_ACOMPTE_MOE - A16_ETAT_ACOMPTE_VALIDE_MOE

- A17_PROJET_DECOMPTE_GENERAL_MOE - A18_DECOMPTE_GENERAL_MOE - A19_ETAT_ACOMPTE_VALIDE_MOA - A20_DECOMPTE_GENERAL_MOA

- A22_PROJET_DECOMPTE_GENERAL_FOURNISSEUR_PROCEDURE_TACITE - A23_DECOMPTE_GENERAL_DEFINITIF_TACITE_FOURNISSEUR - A24_DECOMPTE_GENERAL_DEFINITIF_TACITE_MOE

RecupererCadreFacturation

0-1

264 / 557


- A25_DECOMPTE_GENERAL_DEFINITIF_MOE_PROCEDURE_TACITE

listeStatutCourant

String: list of the work invoice status on which the research is performed

varchar(50) (liste)

It is allowed to enter one or more status(es). If no statu sis entered, the research applies no filter on the work invoice status.

RecupererEtatParTypeDemandePaiement

0-n

PeriodeDateHeureEtatC

ourantDu

Date : start date of the

current status period

date



0-1

PeriodeDateHeureEtatCourantAu

Date : end date of the current status period

date



0-1

idStructureValideur

Number: technical

identifier of the first/second validator of the work invoice

integer


identifies the validator’s structure within the CPP 2017 system.

RecupererV

alideursPourFactureTravaux

0-1

periodeDateFactureTravauxDu

String: start date of the work invoicing period


0-1

periodeDateFactureTravauxAu

String: end date of the work invoicing date


0-1

montantHTMin

Number: minimum tax-free amount

decimal(19,6)

0-1

montantHT

Max

Number: maximum tax-free amount

decima

l(19,6) 0-1

montantTTCMin

Number: minimum tax-included amount

decimal(19,6)

0-1

montantTTCMax

Number: maximum tax-included amount

decimal(19,6)

0-1

montantAPayerMin

Number: minimum payable amount

decimal(19,6)

0-1

montantAPayerMax

Number: maximum payable amount

decimal(19,6)

0-1

idCoordonneeBancaire

Number: identifier of the supplier’s bank details

integer

RecupererCoordonneesBancairesValides

0-1


String: number of the work invoice

varchar(20)

This identifier is unique for each supplier. Alphanumeric value

0-1

numeroMarche

String: contract number

varchar(50)

0-1

numeroBonCommande

String: purchase order number

varchar(50)

RechercherEngagementJuridique

0-1

265 / 557


modeDepot String: Deposit mode code

varchar(50)

Enumeration with 7 possible values: - DEPOT_PDF_PORTAIL -

DEPOT_PDF_SIGNE_PORTAIL - DEPOT_PDF_API - DEPOT_PDF_SIGNE_API - EDI - UPLOAD_PORTAIL - UPLOAD_API

RecupererModeDepot

0-1

modePaiem

ent

String: payment mean

ID

varcha

r(40)

Enumeration with 6 possible values: - ESPECE - CHEQUE

- PRELEVEMENT - VIREMENT - AUTRE - REPORT

RecupererModeRegleme

nts

0-1

numeroFluxDepot

String: deposit number of the flow contening the invoice

varchar(25)

DeposerFluxFacture

0-1

uniquementSansPieceSuivante

Booléen: indicates if the work invoice is the last document of the invoicing file

Boolean

true: only looking for a work invoice without following document false: looking for work invoices with a following document or not

0-1

avecSansService

String: indicates if the researched work invoices are with or without the structure’s service of the user who is managing the research

varchar(30)

This parameter is only applied for the services associated to the structure of the user

managing the research (IdServiceFournisseur if RoleUtilisateur = FOURNISSEUR, IdServiceMoe if RoleUtilisateur = MOE and IdServiceMoa if RoleUtilisateur = MOA). 3 values are possible: - UNIQUEMENT_SANS_SERVIC

E - UNIQUEMENT_AVEC_SERVICE - AVEC_ET_SANS_SERVICE

0-1

flagTelecharge

Booléen: the invoice is downloaded by the following user of the deposit (ofr

example : the Project Manager downloads the DMS deposited by a supplier)

Booléen

true: only looking for the downloaded work invoices false: only looking for the work invoices that have not been downloaded

0-1


rechercheFactureTravaux

0-1

pageResulta

tDemandee

Number:

number of

the results


first page. 0-1

266 / 557


page to be

displayed

nbResultats

ParPage

Number:

Number of

results per

page that can

be returned

by the

research



triSens String:

sorting order

varchar(

10)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

String:

reference

column of the

sorting

-


values:

- TypeDemandePaiement

- IdentifiantFournisseur

- TypeIdentifiantFournisseur


- CodeServiceFournisseur

- NomServiceFournisseur

- IdentifiantMoe

- TypeIdentifiantMoe

- DesignationMoe

- CodeServiceMoe

- NomServiceMoe

- IdentifiantMoa

- DesignationMoa

- CodeServiceMoa

- NomServiceMoa

- IdentifiantDestinataire

- DesignationDestinataire

- CodeServiceExecutant

- NomServiceExecutant


- NumeroFactureTravaux

- DateFactureTravaux

- DateDepot

- MontantHT

- MontantTTC

- MontantAPayer

- DeviseFactureTravaux

- StatutFactureTravaux

- NumeroMarche

- NumeroBonCommande

- NumeroFluxDepot

- TypeIdentifiantValideur1

- IdentifantValideur1

- RaisonSocialeValideur1

0-1

267 / 557


- NomValideur1

- PrenomValideur1

-DateValidation1

- TypeIdentifiantValideur2

- IdentifantValideur2

- RaisonSocialeValideur2

- NomValideur2

- PrenomValideur2

-DateValidation2

- ModeDepot

- CoordBancairesCleIban

- CoordBancairesCleRib

- CoordBancairesCodeBanque

- CoordBancairesCodeGuichet

- CoordBancairesBicSwift

- CoordBancairesCodePays

-

CoordBancairesCompteBancai

re

- CoordBancairesNomCb

- AffactureurCode

- AffactureurTypeIdentifiant

- AffactureurRaisonSociale

- NumeroPiecePrecedente

- NumeroPieceSuivante



"DateDepot".

Output table


parametres

Retour 0-1



pages

Number: Number of

pages returned by

the research

integer 0-1

nbResultatsParPa

ge

Number: number of


total

Number: Number of

results returned by

the research

integer 0-1

List of work invoices to be displayed

listeFactures Travaux

List 0-n

268 / 557


idFactureTravaux

Number: technical

identifier of the

work invoice within

the CPP 2017

system

integer


identifies the work invoice

within the CPP 2017 system.

1

dossierFacturatio

n

Number: technical

identifier of the

invoicing file within

the CPP 2017

system. This

identifier is equal to

the identifier of the

first work invoice.

integer 1

typeDemandePai

ement

String: type of

payment request

varchar(5

0) 1

idFournisseur

Number: technical

identifier of the

supplier within the

CPP 2017 system

integer




structure

1

identifiantFournis

seur String: supplier ID

varchar(8

0) Supplier functional identifier 1

typeIdentifiantFo

urnisseur

String: identifier

type of the supplier

varchar(5

0) 1

designationFourn

isseur

String: designation

of the issuing

supplier

varchar(2

01)


characters which corresponds

to the corporate name of the

structure or the concatenated

name and surname of its

deputy.

1

codeServiceFour

nisseur


service code

varchar(1

00)

Alphanumeric value

If Service.estPremierService

= true, then this attribute is

not entered.

0-1

nomServiceFour

nisseur


service name

varchar(1

00)



not entered.

0-1

idMoe

Number: technical

identifier of the

Project Manager in

the CPP 2017

system

integer




structure

0-1

identifiantMoe String: identifier of

the Project Manager

varchar(8

0) 0-1

typeIdentifiantM

oe

String: identifier

type of the Project

Manager

varchar(3

0) 0-1

designationMoe

String: designation

of the Project

Manager

varchar(2

01) 0-1

269 / 557


idServiceMoe

Number: technical

identifier of the

Project Manager’s

service in the CPP

2017 system

integer






not entered.

0-1

codeServiceMoe

String: Project

Manager’s service

code

varchar(1

00)

Alphanumeric value



not entered.

0-1

nomServiceMoe

String: label of the

Project Manager’s

service

varchar(1

00)



not entered.

0-1

idMoa

Number: technical

identifier of the

Contracting

Authority in the CPP

2017 system

integer




structure

0-1

identifiantMoa


the Contracting

Authority

varchar(8

0) 0-1

designationMoa

String: designation

of the Contracting

Authority

varchar(2

01) 0-1

idServiceMoa

Number: technical

identifier of the

Contracting


in the CPP 2017

system

integer






not entered.

0-1

codeServiceMoa

String: service code

of the Contracting

Authority

varchar(1

00)

Alphanumeric value



not entered.

0-1

nomServiceMoa


Contracting


varchar(1

00)



not entered.

0-1

idDestinataire

Number: tehnical

identifier of the


CPP 2017 system

integer




structure

0-1

identifiantDestin

ataire


the work invoice

recipient

varchar(1

4)

Alphanumeric value

This is the recipient’s SIRET.

0-1

designationDesti

nataire


designation

varchar(2

01)






deputy.

0-1

idServiceExecuta

nt

Number: technical

identifier of the integer


identifies the service within 0-1

270 / 557


executing service

within the CPP 2017

system




not entered.

codeServiceExec

utant

String: executing

service’s code

varchar(1

00)

Alphanumeric value



not entered.

0-1

nomServiceExec

utant

String: executing

service’s name

varchar(1

00)



not entered.

0-1

typeFactureTrav

aux

String: Works

invoice type

varchar(5

0)


values:

-

DP_DE_SOUSTRAITANT_TRAV

AUX

-

PROJET_DECOMPTE_MENSUE

L

- ETAT_ACOMPTE


- PROJET_DECOMPTE_FINAL

-

PROJET_DECOMPTE_GENERAL

-

PROJET_DECOMPTE_GENERAL

_PROCEDURE_TACITE

- DECOMPTE_GENERAL

-

DECOMPTE_GENERAL_SIGNE

-


TIF_TACITE

-


TIF_PROCEDURE_TACITE

1

numeroFactureTr

avaux

String: number of

the work invoice

varchar(2

0)


supplier.

Alphanumeric value



- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

dateFactureTrav

aux

String: work

invoicing date date

Date field: AAAA-MM-

JJTHH:MM:SS+HH:MM 0-1

dateDepot

String: Submission

date of the work

invoice



271 / 557


montantHT

Number: amount


work invoice

decimal(1

9,6) 0-1

montantTTC

Number: amont

including tax of the

work invoice

decimal(1

9,6) 0-1

montantAPayer

Number: payable

amount of the work

invoice

decimal(1

9,6) 0-1

deviseFactureTra

vaux

String: currency of

the work invoice varchar(3) 1

statutFactureTra

vaux

String: current

status of the work

invoice

varchar(5

0) 1

dateHeureEtatCo

urant

Date : date of the

invoice current

status

date Date field : AAAA-MM-


commentaireEtat

Courant

String : comment

on the current

status

varchar(2

55) 0-1


number

varchar(5

0) 0-1

numeroBonCom

mande

String: purchase

order number

varchar(5

0) 0-1

numeroFluxDepo

t

String: deposit

number of the flow

contening the

invoice

varchar(2

5)

This data is available only if

the invoice was issued by

flow.

0-1

typeIdentifiantVa

lideur1

String: first

validator’s identifier

type

varchar(3

0) 0-1

identifiantValideu

r1

String: first


varchar(8

0) 0-1

raisonSocialeVali

deur1

String: first

validator’s corporate

name

varchar(9

9)

Entered if TypeIdentifiant <>

PARTICULIER 0-1

nomValideur1

String: name of the

first validator’s

deputy

varchar(1

00)

Entered if TypeIdentifiant =

PARTICULIER 0-1

prenomValideur1

String: surname of

the first validator’s

deputy

varchar(1

00)


PARTICULIER 0-1

dateValidation1

String: validation

date by the first

validator



typeIdentifiantVa

lideur2

String: second


type

varchar(3

0) 0-1

identifiantValideu

r2

String: second


varchar(8

0) 0-1

272 / 557


raisonSocialeVali

deur2

String: second

validator’s corporate

name

varchar(9

9)

Entered if TypeIdentifiant <>

PARTICULIER 0-1

nomValideur2

String: name of the

second validator’s

deputy

varchar(1

00)


PARTICULIER 0-1

prenomValideur2

String: surname of

the second


varchar(1

00)


PARTICULIER 0-1

dateValidation2

String: validation

date by the second

validator



modeDepot

String: deposit

mode of the work

invoice

varchar(5

0)


values:

DEPOT_PDF_PORTAIL

-

DEPOT_PDF_SIGNE_PORTAIL

- DEPOT_PDF_API


- EDI

- UPLOAD_PORTAIL

- UPLOAD_API

1

coordBancairesCl

eIban

String: IBAN key of

the supplier’s bank

details


coordBancairesCl

eRib

String: RIB key of


details


coordBancairesC

odeBanque

String: bank code of


details

varchar(1


coordBancairesC

odeGuichet

String: sort code of

the bank details varchar(5) Alphanumeric value 0-1

coordBancairesBi

cSwift

String: BIC/SWIFT

number of the bank

details

varchar(1


coordBancairesC

odePays

String: country code

of the bank details varchar(2) 0-1

coordBancairesC

ompteBancaire

String: bank

account of the

supplier’s bank

details

varchar(1


coordBancairesN

omCb

String: name of the

supplier’s bank

details

varchar(2

55)

Uniquely identifies the bank

detail 0-1

affactureurCode String: identifier of

the factor

varchar(8

0) 0-1

affactureurTypeI

dentifiant


type

varchar(1

4) 0-1

affactureurRaiso

nSociale

String: factor’s

corporate name

varchar(2

01)




0-1

273 / 557




deputy.

idPiecePrecedent

e

Number: technical

identifier of the

recipient service of

the preceding piece

in the CPP 2017

system

integer 0-1

numeroPiecePrec

edente

String: number of

the preceding

document

varchar(2

0) 0-1

idPieceSuivante

Number: technical

identifier of the

following piece in

the CPP 2017

system

integer 0-1

numeroPieceSuiv

ante

String: number of

the following piece

varchar(2

0) 0-1

flagTelecharge boolean

By default, all the invoices

flagged "true" ou "false" must

be returned.

1

Error table


GFT-CU-01-SER-22 – Rechercher des factures de travaux

20000 The user is not authorized on the work

invoices area GFT_MSG_01.050

20001

The user is not authorized on the work

invoices area of the selected supplier’s

structure or service

GFT_MSG_01.062

20002


invoices area of the selected supplier’s

structure

GFT_MSG_01.070

20003


invoices area of the selected Project

Manager’s structure or service

GFT_MSG_01.071

20004


invoices area of the selected Project

Manager’s structure

GFT_MSG_01.072

20005


invoices area of the selected Contracting

Authority’s structure or service

GFT_MSG_01.073

20006


invoices area of the selected Contracting

Authority’s structure

GFT_MSG_01.074

20007 No result found GFT_MSG_01.075


end date. TRA_MSG_09.007

274 / 557


275 / 557


2.3.1.4 Search work invoice to be processed

The method RechercherFactureTravauxATraiter allows to show the documents, according to the work invoice status,

to be processed by the one researching.

Input table



Service

providing

the data

Multiplicity

idStructure

Number: technical

identifier of the structure within the CPP 2017 system

integer This identifier uniquely identifies the structure within the CPP 2017 system.

RecupererSt

ructuresActivesPourFactureTravaux

0-1

roleUtilisateur

String: user role for the research

varchar(20)

Enumeration with 3 possible values: - FOURNISSEUR - MOE - MOA

1

masquerRejetee

Booleen: returns (or not) all the invoices (rejected or not since the number of days parametered in back office)

Boolean

The default value is false.false: returning all the invoices true: returning all the invoices, except those that have been passed to the REJECTED » status since a number of days strictly greater than the value [DELAI_AFFICHAGE_REJET]

parametered in back office

0-1


rechercheFactureTravauxATraiter

0-1

pageResulta

tDemandee

Number:

number of

the results

page to be

displayed


first page. 0-1

nbResultats

ParPage

Number:

Number of

results per

page that can

be returned

by the

research



triSens String:

sorting order

varchar(

10)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

276 / 557


triColonne

String:

reference

column of the

sorting

-


values:


- IdentifiantFournisseur

- TypeIdentifiantFournisseur


- CodeServiceFournisseur

- NomServiceFournisseur

- IdentifiantMoe


- DesignationMoe

- CodeServiceMoe

- NomServiceMoe

- IdentifiantMoa

- DesignationMoa

- CodeServiceMoa

- NomServiceMoa

- IdentifiantDestinataire




- CadreFacturation


- NumeroFactureTravaux

- DateFactureTravaux

- DateDepot

- MontantHT

- MontantTTC

- MontantAPayer

- DeviseFactureTravaux

- StatutFactureTravaux

- DateStatut

- NumeroMarche

- NumeroBonCommande



"DateStatut".

0-1

277 / 557


Output table


parametresRet

our 0-1



pages

Number: Number of


research

integer 0-1

nbResultatsParPa

ge

Number: number of


total

Number: Number of

results returned by

the research

integer 0-1


listeFacturesTr

avaux List 0-n

idFactureTravaux

Number: technical

identifier of the work

invoice within the CPP

2017 system

integer


identifies the work


2017 system.

1

typeDemandePai

ement

String: type of

payment request varchar(50) 1

identifiantFournis

seur String: supplier ID varchar(80)

Supplier functional

identifier 1

typeIdentifiantFo

urnisseur


of the supplier varchar(50) 1

designationFourn

isseur


the issuing supplier varchar(201)


characters which

corresponds to the


supplier or the

concatenated name

and surname of its

deputy.

0-1

codeServiceFour

nisseur



Alphanumeric value

If




0-1

nomServiceFour

nisseur



If




0-1

idMoe

Number: technical

identifier of the

Project Manager’s

integer This technical identifier

uniquely identifies the 0-1

278 / 557



CPP 2017 system


CPP 2017 structure

identifiantMoe String: identifier of

the Project Manager varchar(80)

Functional identifier of

the Project Manager 0-1

typeIdentifiantM

oe


of the Project

Manager

varchar(50) 0-1

designationMoe String: designation of

the Project Manager varchar(100)


characters which

corresponds to the


supplier or the

concatenated name

and surname of its

deputy.

0-1

idServiceMoe

Number: technical

identifier of the

Project Manager’s


2017 system

integer



within the CPP 2017

system.

If




0-1

codeServiceMoe

String: Project

Manager’s service

code

varchar(100)

Alphanumeric value

If




0-1

nomServiceMoe

String: name of the

Project Manager’s

service

varchar(255)

If




0-1

idMoa

Number: technical

identifier of the

Contracting

Authority’s structure

within the CPP 2017

system

integer




CPP 2017 structure

0-1

identifiantMoa String: identifier of the

Contracting Authority varchar(80)

Functional identifier of

the Contracting

Authority

0-1

designationMoa


the Contracting

Authority

varchar(100)

Alphanumeric value

This value is the SIRET

number of the


0-1

idServiceMoa

Number: technical

identifier of the

Contracting


within the CPP 2017

system

integer



within the CPP 2017

system.

If


0-1

279 / 557




codeServiceMoa

String: service code

of the Contracting

Authority

varchar(100)

Alphanumeric value

If




0-1

nomServiceMoa

String: name of the

Contracting


varchar(255)

If




0-1

idDestinataire

Number: technical

identifier of the


CPP 2017 system

integer




CPP 2017 structure

1

identifiantDestin

ataire


the invoice recipient varchar(14)

Alphanumeric value


SIRET.

1

designationDesti

nataire




characters which

corresponds to the


structure or the

concatenated name

and surname of its

deputy.

1

idServiceExecuta

nt

Number: technical

identifier of the

executing service

within the CPP 2017

system

integer



within the CPP 2017

system.

If




0-1

codeServiceExec

utant

String: executing


Alphanumeric value

If




0-1

nomServiceExec

utant

String: executing


If




0-1

cadreFacturation String: work invoicing

framework varchar(100) 0-1

typeFactureTrav

aux

String: Works invoice

type varchar(50)

Enumeration with 11

possible values:

-

DP_DE_SOUSTRAITANT

1

280 / 557


_TRAVAUX

-

PROJET_DECOMPTE_M

ENSUEL

- ETAT_ACOMPTE

-

ETAT_ACOMPTE_VALID

E

-

PROJET_DECOMPTE_FI

NAL

-

PROJET_DECOMPTE_GE

NERAL

-

PROJET_DECOMPTE_GE

NERAL_PROCEDURE_T

ACITE

- DECOMPTE_GENERAL

-

DECOMPTE_GENERAL_

SIGNE

-

DECOMPTE_GENERAL_

DEFINITIF_TACITE

-

DECOMPTE_GENERAL_

DEFINITIF_PROCEDURE

_TACITE

numeroFactureTr

avaux

String: number of the

work invoice varchar(20) 1

dateFactureTrav

aux

String: date of the

work invoice date



dateDepot

String: Submission

date of the work

invoice



montantHT

Number: amount


work invoice

decimal(19,6) 0-1

montantTTC

Number: amont

including tax of the

work invoice

decimal(19,6) 0-1

montantAPayer

Number: payable

amount of the work

invoice

decimal(19,6) 0-1

deviseFactureTra

vaux

String: currency of the

work invoice varchar(3) 1

statutFactureTra

vaux


of the work invoice varchar(50)

The returned statuses

depend on the role of

the user (who manages

the research) and the

depositor :

1

281 / 557


If Role = fournisseur:

If déposant =

Fournisseur

-

DemandePaiement.etat

Courant is equal to one

of the following values:

o BROUILLON

[DRAFT]

o

ERREUR_FOURNISSEU

R_SUR_VALIDEUR

[ERROR ON

VALIDATOR BY

SUPPLIER]

o ERREUR_DE_MOE

[ERROR ON PROJECT

MANAGER]

o SUSPENDUE

[PAUSED]

o A_COMPLETER [TO

COMPLETE]

o ERREUR_DE_MOA

[ERROR ON

CONTRACTING

AUTHORITY]

o A_RECYCLER [TO

RECYCLE]

o

ABSENCE_VALIDATION

_1_HORS_DELAI

[ABSENCE OF

VALIDATION 1 AFTER

DEADLINE]

o

ABSENCE_VALIDATION

_2_HORS_DELAI

[ABSENCE OF

VALIDATION 2 AFTER

DEADLINE]

o REJETEE

[REJECTED]

If Déposant <>

Fournisseur

-




o TRANSMISE_MOA

282 / 557


o

A_ASSOCIER_FOURNIS

SEUR [TO ASSOCIATE

WITH SUPPLIER]

If Role = Project

Manager

:

If déposant = Project

Manager

-




o BROUILLON

[DRAFT]

o SUSPENDUE

[PAUSED]

o A_COMPLETER [TO

COMPLETE]

o ERREUR_DE_MOA

[ERROR ON

CONTRACTING

AUTHORITY]

o A_RECYCLER [TO

RECYCLE]

o REJETEE

[REJECTED]

If déposant <> Project

Manager

-




o A_ASSOCIER_MOE

[TO ASSOCIATE WITH

PROJECT MANAGER]

o

MISE_A_DISPOSITION

_MOE [AVAILABLE TO

PROJECT MANAGER]

Note: a user,

connected to the

Project Manager, views

all the work invoices

that he must process.

The user must be

connected (the

connection must be

valid) to the Project

283 / 557


Manager’s service of

the work invoice and

have access to the

Work Invoices area of

this service. The user

can also be connected

(the connection must

be valid) to the default

technical service of the

Project Manager’s

structure and must

have access to the


these default technical

service.

If Role = Contracting

Authority:

If Depositor =


-




o BROUILLON

[DRAFT]

o SUSPENDUE

[PAUSED]

o A_COMPLETER [TO

COMPLETE]

o A_RECYCLER [TO

RECYCLE]

o REJETEE

[REJECTED]

If Depositor <>


-




o A_ASSOCIER_MOA

[TO ASSOCIATE WITH

CONTRACTING

AUTHORITY]

o

MISE_A_DISPOSITION

_MOA [AVAILABLE TO

CONTRACTING

AUTHORITY]

284 / 557


Note: a user,

connected to the

Contracting Authority,

views all the work

invoices that he must

process. The user must

be connected (the

connection must be

valid) to the


service of the work

invoice and have

access to the Work

Invoices area of this

service. The user can

also be connected (the

connection must be

valid) to the default

technical service of the


structure and must

have access to the


these default technical

service.

dateStatut

String: date of the

current status of the

work invoice


JJTHH:MM:SS+HH:MM 1



numeroBonCom

mande

String: purchase


flagTelecharge boolean: downloaded

invoice or not boolean

By default, all invoices

tagged "true" or "false"

must be returned. 1

285 / 557


Error table



invoices area


invoices area


invoices area of the selected structure


invoices area of the selected structure

20002 No result found No result found

20003 The selected structure does not fit for the

role of Contracting Authority

The selected structure does not fit for the

role of Contracting Authority

286 / 557


2.3.1.5 Submit work invoice

The method SoumettreFactureTravaux allows to save and submit an invoice as part of a works contract.

Input table



Service

providing the

data

Multiplicity

formatDepot

String: format

of the

deposited

document

varchar(

15)

Enumeration with 3

possible values:

- PDF_NON_SIGNE

- PDF_SIGNE_PADES

- PDF_SIGNE_XADES

1

Invoicing framework

cadreDeFacturation

1

cadreFact

uration

String:

Invoicing

frameworkinvoi

cing framework

code

varchar(

60)

Enumeration with 18

possible values:

-

A4_PROJET_DECOMP

TE_MENSUEL_FOURN

ISSEUR

-

A5_ETAT_ACOMPTE_F

OURNISSEUR

-

A6_ETAT_ACOMPTE_

VALIDE_FOURNISSEU

R

-

A7_PROJET_DECOMP

TE_FINAL_FOURNISS

EUR

-

A8_DECOMPTE_GENE

RAL_DEFINITIF_FOUR

NISSEUR

-

A10_DP_DE_SOUSTR

AITANT_TRAVAUX

-

A13_PROJET_DECOM

PTE_MENSUEL_COTR

AITANT

-

A14_PROJET_DECOM

PTE_FINAL_COTRAIT

ANT

-

A15_ETAT_ACOMPTE

RecupererCadr

eFacturation 1

287 / 557


_MOE

-

A16_ETAT_ACOMPTE

_VALIDE_MOE

-

A17_PROJET_DECOM

PTE_GENERAL_MOE

-

A18_DECOMPTE_GEN

ERAL_MOE

-

A19_ETAT_ACOMPTE

_VALIDE_MOA

-

A20_DECOMPTE_GEN

ERAL_MOA

-

A22_PROJET_DECOM

PTE_GENERAL_FOUR

NISSEUR_PROCEDUR

E_TACITE

-

A23_DECOMPTE_GEN

ERAL_DEFINITIF_TAC

ITE_FOURNISSEUR

-

A24_DECOMPTE_GEN

ERAL_DEFINITIF_TAC

ITE_MOE

-

A25_DECOMPTE_GEN

ERAL_DEFINITIF_MO

E_PROCEDURE_TACIT

E

idStructur

eValideur

Number:

technical

identifier de la

structure

valideur

integer

This identifier



CPP 2017 system.

The validator must

not be entered if the

invoicing framework

is a framework of

sub- or co-contracting

(A10, A13 and A14).

rechercherStru

cture 0-1

idStructur

eMoe

Number:

technical

identifier of the

Project

Manager in the

CPP 2017

system

integer

This identifier


Project Manager’s


CPP 2017 system.

This identifier is

required if the

If

RoleDeposant

= 'MOE':

rechercherStru

ctureActivesPo

urFacturesTrav

auxElse:

0-1

288 / 557


invoicing framework

is A4:

PROJET_DECOMPTE_

MENSUEL_FOURNISS

EUR or A7:

PROJET_DECOMPTE_F

INAL_FOURNISSEUR

rechercherStru

cture

idService

Moe

String:

technical

identifier of the

Project

Manager’s

service

integer

This identifier



2017 system.

If

RoleDeposant

= 'MOE':

rechercherServ

icesStructureEl

se:

recupererServi

cesParStructur

e

0-1

Preceding document

piecePrecedente

0-1

idPiecePre

cedente

Number:

technical

identifier of the

recipient

service of the

preceding piece

in the CPP

2017 system

integer rechercherFact

ureTravaux 1

Identification

identification 1

numeroFa

ctureSaisi

String: number

of the work

invoice

varchar(

20) Alphanumeric value 1

dateFactur

e

String: date of

the work

invoice whose

submission

format is PDF

date


JJ

or AAAA-MM-

JJTHH:MM:SS+HH:M

M

The date the invoice

is issued must be

earlier than or equal

to the date the

invoice was deposited

in the system.

1

Depositor

deposant 1

289 / 557


roleDepos

ant

String: role of

the work

invoice

depositor

varchar(

11)

Enumeration with 3

possible values:

- FOURNISSEUR

- MOE

- MOA

1

idStructur

eDeposant

Number:

technical

identifier of the

depositor’s

structure in the

CPP 2017

system

integer

This identifier


depositor’s structure

within the CPP 2017

system.

RecupererStru

cturesActivesP

ourFactureTrav

aux

1

idServiceD

eposant

Number:

technical

identifier of the

depositor’s

service in the

CPP 2017

system

integer

This identifier


depositor’s service

within the CPP 2017

system.

RecupererServi

cesParStructur

e

0-1

Recipient

destinataire 1

codeDesti

nataire

String:

functional

identifier of the

invoice

recipient

varchar(

14)

Alphanumeric value


SIRET.

RechercherStr

ucture 1

codeServi

ceExecuta

nt

String: service

code of the

invoice

recipient

varchar(


RechercherSer

viceExecutant 0-1

Supplier

fournisseur 1

idStructur

eFournisse

ur

Number:

supplier

technical ID in

CPP system

integer RechercherStr

ucture 1

idServiceF

ournisseur

Number:

technical ID of

the supplier’s

service dans

CPP

integer RechercherSer

vicesStructure 0-1

idCoordon

neesBanca

iresFourni

sseur

Number: ID of

the supplier’s

bank details

integer

RecupererCoor

donneesBancai

resValides

0-1

290 / 557


References

references 1

deviseFact

ureTravau

x

String:

currency code

of the work

invoice

varchar(

3)

RecupererDevi

ses 1

typeTva String: VAT

type

varchar(

50)

Enumeration with 4

possible values:

- TVA_SUR_DEBIT

-

TVA_SUR_ENCAISSE

MENT

- EXONERATION

- SANS_TVA

1

motifExon

erationTva

String: reason

for VAT

exemption

varchar(

5)

The selection of a

reason is required

only if the VAT type is

« EXONERATION » .

RecupererMotif

sExonerationTv

a

0-1

numeroMa

rche

String:

contract

number

varchar(

50) 0-1

numeroBo

nComman

de

String:

purchase order

number

varchar(

50)


the State, then the

system controls if a

purchase order exists

(if entered). (

2) If the recipient

indicates, in its own

parameters, that the

purchase order is

required


stionNumeroEj =

TRUE or


tionNumeroEJOuCode

Service and code

service not informed),

then the system

controls that the

purchase order is

entered.

3) In the others

cases, these

parameters are not

controlled.

RechercherEng

agementJuridiq

ue

0-1

291 / 557


modePaie

ment

String:

payment mean

ID

varchar(

11)

Enumeration with 6

possible values:

- ESPECE

- CHEQUE

- PRELEVEMENT

- VIREMENT

- AUTRE

- REPORT

RecupererMod

eReglements 1

Global amounts

montantsTota

ux 1

montantHt

Total

Number: tax-

free amount of

the work

invoice after

rebate

decimal(

19,6) 1

montantT

VA

Number: global

VAT amount of

the work

invoice

decimal(

19,6) 0-1

montantR

emiseGlob

aleTTC

Tax-included

global

allowance

amount

decimal(

19,6) 0-1

motifRemi

seGlobale

TTC

Reason for tax-

included global

allowance

amount

varchar(

1024) 0-1

montantA

Payer

Number:

payable

amount of the

work invoice

decimal(

19,6)

The payable amount

must not be strictly

greater than the tax-

included amount.

0-1

VAT summary

ligneTva Liste 0-n

ligneTvaT

auxManue

l

Number:

manual data

entry of the

VAT rate

decimal(

5,2)

If the VAT code is not

entered, the manual

VAT rate is required.

0-1

ligneTvaT

aux

String:

referenced

code of the

VAT rate

varchar(

6)

RecupererTaux

Tva 0-1

lgneTvaMo

ntantBase

HtParTaux

Number: basis

amount

without tax per

tax rate

decimal(

19,6)

Calculation of the tax-

free basis amount for

each applied VAT rate

in the work invoice:

tax-free basis amount

= sum of tax-free

amount after global

rebate

1

292 / 557


ligneTvaM

ontantTva

ParTaux

Number: total

tax amount per

tax rate

decimal(

19,6)

Calculation of the VAT

amount for each

applied VAT rate in

the work invoice :

VAT amount = sum

(tax-free amount

after global rebate) x

(100 + VAT rate) /

100

1

Main attachment


1

pieceJoint

ePrincipal

eDesignati

on

String: free

description of

the attachment

varchar(

255) 1

fichierPiec

eJointePri

ncipale

String:

base64-

encoded PDF

file

corresponding

to the work

invoice

file 1

Pièces jointes complémentaires


Liste 0-n

pieceJoint

eComplem

entaireDe

signation

String: free

description of

the attachment

varchar(

255) 1

pieceJoint

eComplem

entaireTyp

e

String: type of

the

complemetary

attachment to

be added to

the work

invoice

varchar(

30)

RecupererType

sPieceJointe 1

pieceJoint

eComplem

entaireId

String:

Technical ID of

the attachment

in the system

integer

This identifier



2017 CPP system

RechercherPiec

eJointeSurStru

cture

OR

RechercherPiec

eJointeSurMon

Compte

OR

AjouterFichier

DansSysteme

1

Output table


293 / 557


idFactureTrava

ux

String: technical

identifier of the work


2017 system

integer


identifies the work


2017 system.

1

identifiantDepo

sant

String: functional

identifier of the

depositor’s structure

varchar(80) 1

numeroFacture

Travaux

String: number of the

work invoice varchar(20)


each supplier.

Alphanumeric value.



accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

1

statutFactureTr

avaux


of the work invoice varchar(50) 1

dateDepotFact

ureTravaux

String: Submission

date of the work

invoice


JJTHH:MM:SS+HH:MM 1

294 / 557


Error table


Controls on the main attachment

20000 Virus detected

GFT_MSG_01.001 GFT-CU-01-SER-01.1 Contrôler dépôt PDF unitaire de facture de travaux -

contrôles du fichier

20001 The supplied document is not a PDF document

GFT_MSG_01.002 GFT-CU-01-SER-01.1 Contrôler dépôt PDF unitaire de facture de travaux - contrôles du fichier

20002 Incorrect document signature

GFT_MSG_01.003 GFT-CU-01-SER-01.1 Contrôler dépôt

PDF unitaire de facture de travaux - contrôles du fichier

20003 The designation of the main attachment must be entered.

GDP_MSG_11.073

20004 The designation of the complementary attachment must be entered.

GDP_MSG_11.074

20005 The input-supplied file encoding does not conform to the encoding standard (base64).

TRA_MSG_00.020

Functional controls

GFT-CU-01-SER-01.2 Contrôler dépôt PDF unitaire de facture de travaux - contrôles métier

20010 The depositor structure {0} does not exist

GFT_MSG_01.004 {0} = IdTechniqueStructureDéposant

20011 The depositor service {0} does not exist GFT_MSG_01.005 {0} = IdTechniqueServiceDéposant

20012 The depositor {0} service does not correspond to the depositor structure {1}.

GFT_MSG_01.006 {0} = IdTechniqueServiceDéposant {1} = IdTechniqueStructureDéposant

20013 The depositor structure {0} is not active.

GFT_MSG_01.007 {0} = IdTechniqueStructureDéposant

20014 The depositor service {0} is not active GFT_MSG_01.008 {0} = IdTechniqueServiceDeposant

20015 The selected user is not authorized on the Work Invoice area to modify the selected structure and service

GFT_MSG_01.009

20016 The selected structure does not fit for the role of Contracting Authority

GFT_MSG_01.010

20017 The invoicing framework is not

consistent with the selected role GFT_MSG_01.011

20018 The preceding document does not exist or is not a work invoice

GFT_MSG_01.012

20019 The supplier is different from the one indicated in the preceding document

GFT_MSG_01.013

20020 The Project Manager is different from the

one indicated in the preceding document GFT_MSG_01.014

20021 The Contracting Authority is different from the one indicated in the preceding document

GFT_MSG_01.015

20022 The invoicing framework {0} cannot be used in the case of deposit after an existing document

GFT_MSG_01.016 {0} = cadreFacturation

20023 The current and preceding document’s invoice frameworksare not consistent

GFT_MSG_01.019

20024 The invoicing framework {0} cannot be used if the preceding document is a DGS sent to a Contracting Authority


20025

The status of the preceding document

does not allow the deposit of a new document in the invoicing file

GFT_MSG_01.023

295 / 557


20026

The DFS is already associated to a DGS, deposited by the Project Manager, which is already associated to a following document. Please ask for association

directly by selecting the DGS deposited by the Project Manager.

GFT_MSG_01.024

20027 The preceding document is already associated to a following document which has not been rejected or refused.

GFT_MSG_01.025

20028 The invoicing framework cannot be used for a first deposit ; a pre-existing document is required.

GFT_MSG_01.026

Recipient controls

GFT-CU-01-SER-04 Enregistrer un dépôt PDF unitaire de facture de travaux [Register a unique PDF deposit of work

invoice]

20030 No recipient structure. GFT_MSG_01.031 {0} = IdTechniqueStructureDestinataire

20031 No recipient service. GFT_MSG_01.032 {0} = IdTechniqueServiceDestinataire

20032 The recipient service does not correspond to the recipient structure.

GFT_MSG_01.033 {0} = IdTechniqueServiceDestinataire {1} = IdTechniqueStructureDestinataire

20033 The recipient structure is not a public structure.

GFT_MSG_01.034 {0} = IdTechniqueStructureDestinataire

20034 The recipient structure is not active. GFT_MSG_01.035 {0} = IdTechniqueStructureDestinataire

20035 The recipient service is not active. GFT_MSG_01.036 {0} = IdTechniqueServiceDestinataire

20036

The recipient structure cannot be uniquely a contracting authority (MOA UNIQUEMENT) for this invoicing frameworkInvoicing framework

GFT_MSG_01.037 {0} = cadreFacturation GFT-CU-01-RGD-38

20037 The recipient service code is required for the recipient structure.

GFT_MSG_01.038

20038 This recipient structure requires a service code or a commitment number.

GFT_MSG_01.039

20039 The recipient structure requires a commitment number.

GFT_MSG_01.042

20040 The recipient service requires a commitment number.

GFT_MSG_01.041

20041 The commitment number does not exist. GFT_MSG_01.043 {0} = numeroEngagement

20042

Private structures are not able to select the recipient service FACTURES_PUBLIQUES. Please modify the entry.

GDP_MSG_11.072

Supplier’s controls


invoice]

20050 The supplier structure {0} does not exist.

GFT_MSG_01.044 {0} = IdTechniqueStructureFournisseur

20051 The supplier service {0} does not exist. GFT_MSG_01.045 {0} = IdTechniqueServiceFournisseur

20052 The supplier service {0} does not correspond to the supplier structure {1}.

GFT_MSG_01.046 {0} = IdTechniqueServiceFournisseur {1} = IdTechniqueStructureFournisseur

20053 The supplier structure {0} is not active. GFT_MSG_01.047

{0} = IdTechniqueStructureFournisseur

20054 The supplier service {0} is not active. GFT_MSG_01.048 {0} = IdTechniqueServiceFournisseur

20055

The user is a supplier ; then, the structure and service of the supplier must be the same as the structure and the service of the depositor.

GFT_MSG_01.049

296 / 557


20056 The supplier is different from the one indicated in the preceding document.

GFT_MSG_01.013

Validator’s controls


invoice]

20060 No validator is expected for the invoicing framework {0}.


20061 A validator is required for the invoicing framework {0}.


20062 The validator structure {0} does not exist.

GFT_MSG_01.053 {0} = IdTechniqueStructureValideur

20063 The validator structure {0} is not active. GFT_MSG_01.054

{0} = IdTechniqueStructureValideur

20064 Caution ! The validator cannot be the recipient of the invoice, please modify the entry.

GDP_MSG_11.081

20065 You are not able to issue sub- and cocontracting invoices with the State as validator.

GDP_MSG_11.080

Project Manager’s controls


invoice]

20070 The Project Manager’s structure {0} does not exist.

GFT_MSG_01.055 {0} = idTechniqueStructureMOE

20071 The Project Manager’s service {0} does not exist.

GFT_MSG_01.056 {0} = idTechniqueServiceMOE

20072 The Project Manager’s service {0} does not correspond to the Project Manager’s structure {1}.

GFT_MSG_01.057 {0} = idTechniqueServiceMOE {1} = idTechniqueStructureMOE

20073 The Project Manager’s structure {0} is not active.

GFT_MSG_01.058 {0} = idTechniqueStructureMOE

20074 The Project manager’s service {0} is not active.

GFT_MSG_01.059 {0} = idTechniqueServiceMOE

20075 The Project Manager’s structure is required for this invoicing framework {0}.


20076

The user is a Project Manager ; its structure and service must be the same as the structure and service of the depositor.

GFT_MSG_01.061

20077 The Project Manager is different from the one indicated in the preceding document.

GFT_MSG_01.014

Contracting Authority’s controls


invoice]

20080 The Contracting Authority is different from the one indicated in the preceding document.

GFT_MSG_01.063

Duplicate controls


invoice]

20090 There is already a payment request with the invoice number {0}, from the same supplier.

GFT_MSG_01.064 {0} = numeroFactureTravaux

20091

There is already a payment request with the invoice number {0}, from the same supplier and with the same commitment

and market numbers.


20092 There is already a payment request with the invoice number {0}, from the same Project Manager.


297 / 557


20093

There is already a payment request with the invoice number {0}, from the same Project Manager with the same commitment and market numbers.


20094 There is already a payment request with the invoice number {0}, from the same Contracting Authority.


Duplicate controls

20100 The user cannot submit this work invoice.

GFT_MSG_01.069

Controls on the complementary attachments

20110 The attachment {0}, whose type is {1}, does not exist.

GDP_MSG_11.044 {0} = name of the file {1} = extension of the file

20111 The maximum size of attachments ({0} Mo) is reached.

GDP_MSG_11.039 {0} = maximum size of attachment

20112 The attachment {0} is already used. TRA_MSG_00.017 {0} = idTechniquePiecejointe

20113 The user {0} is not authorized to use this attachment {1}.

TRA_MSG_00.016 {0} = identifier of the user {1} = idTechniquePieceJointe

Complementary controls

20120 The currency is not referenced.

GFT_MSG_01.108

GDP-CU-01-SER-07 - Enregistrer une pièce jointe d’une facture dans le système (modes portail & service)

20121 The exemption reason is required.

GFT_MSG_01.109 GDP-CU-01-SER-07 - Enregistrer une pièce jointe d’une facture dans le système (modes portail & service)

20122 The exemption reason is not referenced.

GFT_MSG_01.110

GDP-CU-01-SER-07 - Enregistrer une pièce jointe d’une facture dans le système (modes portail & service)

20123 The payable amount must not be strictly greater than to the tax-included global amount.


20124 VAT line: the VAT rate is required.


20125 VAT line: the VAT rate is not referenced.


20302 The date the invoice is issued must be earlier than or equal to the date the invoice was deposited in the system.

GFT_MSG_99.011

20127

The Project Manager service ({0}) has not the neccessary clearances to access to the area « Factures de travaux » [Work invoices]. Please contact the primary manager of the structure.

GFT_MSG_01.116 {0} = IdTechniqueServiceMOE GFT-CU-01-SER-04

20128 The service {0} has not the necessary clearances as Project Manager service.

GFT_MSG_01.117 {0} = IdTechniqueServiceMOE GFT-CU-01-SER-04

20129

The Project Manager structure {0} has not any service which accesses to the area « Factures de travaux » [Work invoices]. Please contact the primary manager of the structure.

GFT_MSG_01.115 {0} = IdTechniqueStructureMOE GFT-CU-01-SER-04

20131 The structure {0} does not use the application « Demandes de paiement »

GDP_MSG_01.014

298 / 557


[Payment requests]. Then, it cannot be linked to a payment request.

{0}= identifier (Cf. TRA-CU-00-RGD-40) " - " designation of the structure (Cf. TRA-CU-00-RGD-37) GFT-CU-01-SER-05 - « Soumettre un

dépôt PDF unitaire de facture de travaux » [Submit a unique PDF deposit of work invoice]

20132 The invoice number can be composed only by figures, letters and the special characters "-", "_", " ", "+" and "/".

GDP_MSG_11.076 GFT-CU-01-SER-04 (TDI-CU-03-RGD-06)

20133 The invoice must not be older than 4 years.

TRA_MSG_09.013 GFT-CU-01-SER-04

20134 The tax-included rebate amount cannot be negative, or greater than the tax-included amount before rebate.

GMJ_MSG_01.055 GDP-CU-01-RGD-27 - GFT-CU-01-SER-04

299 / 557


2.3.2 Process a work invoice


- Ask to recycle previous attachment

- Take a work invoice into account

- Refuse work invoice

- Suspend or ask to complete work invoice

- Recover reasons to refuse work invoice

2.3.2.1 Ask to recycle previous attachment

As part of works contracts, the method DemanderRecyclagePiecePrecedente allows a user to ask the recycling of previous attachment or to ask the correction of information linked to the contracting authority (Error MOA) by the submitter of the previous attachment.

Input table



Service

providing

the data

Multiplicity

idFactureTravaux

Number:

technical

identifier of the

work invoice

within the CPP

2017 system

integer

The technical identifier

uniquely identifies the work

invoice within the CPP 2017

system.

ConsulterFa

ctureTravau

x

0-1

Output table


idFactureTravaux

Number: technical

identifier of the

work invoice within

the CPP 2017

system

integer

This identifier


work invoice within


1

idPiecePrecedente

Number: technical

identifier of the

recipient service of

the preceding piece

in the CPP 2017

system

integer

This identifier


work invoice within


1

Error table



20001 The status of the work invoice is not A

RECYCLER nor ERREUR DE MOA. GFT_MSG_01.086

20002

The user cannot ask for recycling the

preceding document of transferring the

Contracting Authority error to the

following document of the work invoice.

GFT_MSG_01.092

300 / 557


301 / 557


2.3.2.2 Take a work invoice into account

The method PrendreEnCompteUneFactureDeTravaux allows the Project Manager to take into account the payment

request of subcontractor in the context of a work contract

Input table



Service

providing

the data

Multiplicity


Number: technical id of the current user in the Chorus Pro system

integer This identifier uniquely identifies the user within the 2017 CPP system

0-1

idFactureTravaux

String: technical identifier of the work invoice within the CPP 2017 system

integer This ID allows to uniquely identify the invoice within the system CPP 2017

1

Output table


idFactureTravaux


integer

This identifier uniquely identifies the work invoice within the CPP 2017 system.

0-1



varchar(20)

This ID is unique for each supplier. Alphanumeric value The special characters in brackets below are accepted: - [ - ] - [ _ ]

- [ / ] - [ + ]

0-1

Error table



20001 The user cannot take in account this work invoice.

GFT_MSG_01.083

302 / 557


2.3.2.3 Refuse work invoice

The method refuserFactureTravaux allows to reject an invoice as part of works contracts.

Input table



Service

providing the

data

Multiplicity



integer

This identifier uniquely identifies the user within the 2017 CPP system

0-1

idFactureTravaux

Number: technical identifier of the work invoice within the CPP 2017 system

integer

The technical identifier uniquely identifies the work invoice within the CPP 2017 system.

1

motifRefus

String: reason code for the rejection of the work invoice

varchar(20)

RecupererMotifsRefusFactureTravaux

0-1

complementInformation

String: further information on refusal reason

text(1024)

0-1

Output table





1

idFactureTravaux

Number: technical identifier of the work invoice within the CPP 2017

system

integer This identifier uniquely identifies the work invoice within the CPP 2017 system.

1

motifRefus

String: reason code for the rejection of the work invoice

varchar(20)

0-1

complementInformation

'String: further information on refusal reason

text(1024)

0-1

dateRefus String: date of refusal of the work invoice

date Date field: AAAA-MM-JJ 1



varchar(20)

This ID is unique for each supplier. Alphanumeric value

0-1

Error table



303 / 557


20001 The refusal reason does not exist for this invoicing framework.

GFT_MSG_01.077

20002 The user cannot refuse this work invoice. GFT_MSG_01.078

20004 The refusal reason cannot be entered because the codument has already been associated.

GFT_MSG_01.080

20005 The indicated refusal reason does not fit with the defined criteria.

GDP_MSG_01.079

304 / 557


2.3.2.4 Suspend or ask to complete work invoice

The method SuspendreOuDemanderCompleterFactureTravaux aims to suspend (or ask to complete) a work invoice

Input table



Service providing


idFactureT

ravaux

String: technical

identifier of the

work invoice

within the CPP

2017 system

integer

This ID allows to


invoice within the

system CPP 2017

1

commenta

ire

String: free

comment field text(250) 1

Output table


e

Sous-

Subattribut

e

Typing (tagger) Format Management rules Multiplicity

Error table


200 Successful request To delete if done in the generic error codes

400 Erroneous request To delete if done in the generic error codes

20000 GFT_MSG_01.029 - The work invoice ({0})

does not exist.

{0} = IdFactureTravaux

GFT_MSG_01.029: "La facture de

travaux {0} n'existe pas" [the work

invoice {0} does not exist]

20001 GFT_MSG_01.081 - The user is not

authorized to suspend this work invoice.

{0} = IdUtilisateur

GFT_MSG_01.081: "L'utilisateur n'a pas

le droit de suspendre cette facture de

travaux" [the user is not authorized to

suspend this work invoice]

20002

GFT_MSG_01.082 - The user ({0}) cannot

ask for further information about this work

invoice.

{0} = IdUtilisateur

GFT_MSG_01.082: "L’utilisateur n’a pas

le droit de demander un complément

sur cette facture de travaux" [the user

is not authorized to ask for further

information about this work invoice]

305 / 557


2.3.2.5 Retrieve reasons to refuse work invoice

The method recupererMotifsRefusFactureTravaux sends back reasons for rejection for the payment request which are

valid at the date of the rejection

Input table


(tagger) Format Management rules Multiplicity

codeCadreFacturationTravaux

String:

Invoicing

frameworkw

ork

invoicing

framework

code

varchar(50)


values:

-

A4_PROJET_DECOMPTE_MENSUEL_FO

URNISSEUR

- A5_ETAT_ACOMPTE_FOURNISSEUR

-

A7_PROJET_DECOMPTE_FINAL_FOURN

ISSEUR

-

A10_PROJET_DECOMPTE_MENSUEL_S

OUSTRAITANT

-

A13_PROJET_DECOMPTE_MENSUEL_C

OTRAITANT

-

A14_PROJET_DECOMPTE_FINAL_COTR

AITANT

- A15_ETAT_ACOMPTE_MOE

-

A17_PROJET_DECOMPTE_GENERAL_M

OE

- A18_DECOMPTE_GENERAL_MOE

- A20_DECOMPTE_GENERAL_MOA

-

A22_PROJET_DECOMPTE_GENERAL_F

OURNISSEUR_PROCEDURE_TACITE

1

Output table


rules Multiplicity

listeMotifRefusFac

tureTravaux List 0-n

codeMotif

String: reason

code for the

rejection

MotifRej.codeMoti

f varchar(20) 1

idMotif

Number:

technical

identifier of the

refusal reason

MotifRej.id integer 1

libelleMotif String: label of

the refusal reason

LibelleMotifRej.lib

elleMotif varchar(25) 1

306 / 557


Error table




307 / 557


2.3.3 Process a work invoice in error


- Complete work invoice

- Complete Project Manager

- Complete Project Manager service work invoice

- Correct validator work invoice

- Recyle work invoice

2.3.3.1 Complete work invoice

The method compléterFactureTravaux allows to modify an invoice into « SUSPENDUE » [PAUSED] or « DEMANDE

DE COMPLEMENT » (PAYMENT REQUEST) in adding attachments and/or in modifying the area « commentaire »

(comment).

Input table


(tagger) Format

Management

rules

Service

providing the

data

Multiplicity

idFactureTravaux


integer

This ID allows to uniquely identify the invoice within the system CPP 2017

1

Complementary attachments to be added


List 1-n

pieceJointeComplementaireDesignation

String: free description of the complementary attachment to be added to the work invoice

varchar(255) 1

pieceJointeComplementaireType

String: type

of the complementary attachment to be added to the work invoice

varchar(30) RecupererTypesPieceJointe

1

pieceJointeComplementaireId

String:

Technical ID of the attachment in the system

integer

RechercherPieceJointeSurStructure

OR RechercherPieceJointeSurMonCompte OR AjouterFichierDansSysteme

1

308 / 557


Output table


idFactureTravaux

String: technical identifier of the work invoice within the CPP 2017

system

integer This identifier uniquely identifies the work invoice within the CPP 2017 system.

1



varchar(20)

This ID is unique for each supplier. Alphanumeric value

1

dateTraitement

String: work invoice processing date

date Date field: AAAA-MM-JJTHH:MM:SS+HH:MM

1

Error table



20001 The status of the work invoice is not SUSPENDUE [PAUSED] nor A_COMPLETER [TO COMPLETE].

GFT_MSG_01.098

20002 The type of attachment does not exist. GFT_MSG_01.099

20003 The user is not authorized to complete this work invoice.

GFT_MSG_01.100

20004 The attachment does not exist. GDP_MSG_11.044

20005 The maximum size of attachments is reached.

GDP_MSG_11.039

20008 The attachment name must be entered. TRA_MSG_00.021

309 / 557


2.3.3.2 Complete Project Manager

The method completerMOE aims to add a Project Manager on a work invoice.

Input table


(tagger) Format

Management

rules

Service

providing the

data

Multiplicity

idFactureTravaux

String:

technical

identifier of

the work

invoice within

the CPP 2017

system

integer

This ID allows

to uniquely

identify the

invoice within

the system

CPP 2017

1

idStructureMo

e

String:

technical

identifier of

the Project

Manager’s

structure

within the CPP

2017 system

integer

This identifier

uniquely

identifies the

Project

Manager’s

structure

within the CPP

2017 system.

RechercherStr

ucture 0-1

idServiceMoe

String:

technical

identifier of

the Project

Manager’s

service within

the CPP 2017

system

integer

This ID allows

to uniquely

identify the

invoice within

the system

CPP 2017

RechercherSe

rvicesStructur

e

0-1

validationSans

Moe Boolean Boolean

TRUE:

authorized

only if

IdTechniqueSt

ructureMoe =

NULL

Default value

= FALSE

1

310 / 557


Output table


Service

providing

the data

Multiplicity

idFactureTravaux

String:

technical

identifier of the

work invoice

within the CPP

2017 system

integer

This identifier

uniquely identifies

the work invoice

within the CPP 2017

system.

0-1

numeroFactur

eTravaux

String: number

of the work

invoice

varchar(20)


each supplier.

Alphanumeric value

The special

characters in

brackets below are

accepted:

- [ - ]

- [ _ ]

- [ / ]

- [ + ]

0-1

Error table

Error

code Description

Associated error

message


20001

The status of the work invoice is not ERREUR_DE_MOE [ERROR ON PROJECT

MANAGER], ABSENCE_VALIDATION_1_HORS_DELAI [ABSENCE OF VALIDATION

1 AFTER DEADLINE] nor ABSENCE_VALIDATION_2_HORS_DELAI [ABSENCE OF

VALIDATION 2 AFTER DEADLINE]

GFT_MSG_01.088

20002 The user is not authorized to change the Project Manager of this work invoice. GFT_MSG_01.089

20003 The option ValidationSansMoe [ValidationWithoutProjectManager] is available

only for the invoicing framework A10. GFT_MSG_01.090

20004 The option ValidationSansMoe [ValidationWithoutProjectManager] is available

only if there is no Project Manager entered. GFT_MSG_01.091

20005 The Project Manager’s structure is required for the invoicing framework. GFT_MSG_01.060

20006 The Project Manager’s structure does not exist. GFT_MSG_01.055

20007 The Contracting Authority’s structure does not exist. GFT_MSG_01.056

20008 The Project Manager’s service does not correspond to the Project Manager’s

structure. GFT_MSG_01.057

20009 The Project Manager’s structure is not active. GFT_MSG_01.058

20010 The Project Manager’s service is not active. GFT_MSG_01.097

311 / 557


2.3.3.3 Complete work invoice service Project Manager

The method CompleterServiceMOEFactureTravaux aims to complete the Project Manager service in a work invoice

in every attachment in an invoice file.

Input table



Service providing


idFactureT

ravaux

String: technical

identifier of the

work invoice

within the CPP

2017 system

integer

This ID allows to


invoice within the

system CPP 2017

1

idTechniq

ueService

Moe

String: technical

identifier of the

Project Manager’s

service within the

CPP 2017 system

integer

This identifier


Project Manager’s


2017 system.

1

Output table


e

Sous-

Subattribut

e


Error table


200 Successful request To delete if done in the generic error codes

400 Erroneous request To delete if done in the generic error codes

20000 GFT_MSG_01.029 –The work invoice ({0})

does not exist.

{0} = IdTechniqueFactureTravaux

GFT_MSG_01.029: "La facture de

travaux {0} n'existe pas" [the work

invoice {0} does not exist]

20001

GFT_MSG_01.085 - The user is not

authorized to complete the Project

manager’s service of this work invoice.

GFT_MSG_01.085: "L'utilisateur n'a pas

le droit de compléter le service MOE de

cette facture de travaux" [the user is

not authorized to complete the Project

Manager’s service of this work invoice]

20002 GFT_MSG_01.084 - The service ({0}) does

not exist in the structure "{1}"

0} = IdTechniqueServiceMoe

{1} =

FactureTravaux.moe.structure.identifiant

GFT_MSG_01.084: Le service ({0})

n'existe pas pour la structure "{1}"

[The service {0} does no exist in the

structure {1}]

312 / 557


2.3.3.4 Correct validator work invoice

The method CorrigerValideurFactureTravaux aims to correct the validator of a work invoice.

Input table



Service providing


idFactureT

ravaux

String: technical id

of the work

invoice within the

CPP 2017 system

integer

This ID allows to


invoice within the

system CPP 2017

1

idTechniq

ueStructur

eValideur

String: technical id

of the validator’s

structure within

the CPP2017

system

integer

This identifier


validator within the

CPP 2017 system

1

Output table


e

Sous-

Subattribut

e


idFactureTravaux

String: technical id of the work invoice within the CPP 2017 system

integer


identifies the work


2017 system

0-1

Error table

Error

code Description Associated error messageAssociated error message

200 Successful requestSuccessful request To be deleted if done in the liste of generic messages

400 Error within the requestErroneous request To be deleted if done in the liste of generic messages

20000 GFT_MSG_01.029 -The work invoice {0} does not exist


GFT-CU-01-SER-15 : If the work invoice cannot be found, then the system

returns the folliwing error : « The work invoice (<$IdTechniqueFactureTravaux>

does not exist » (GFT_MSG_01.029)

20001 GFT_MSG_01.101 – The status of the work invoice is not

ERREUR_FOURNISSEUR_SUR_VALIDEUR [ERROR ON VALIDATOR BY SUPPLIER]

GFT-CU-01-SER-15: If the status of the work invoice is not

ERREUR_FOURNISSEUR_SUR_VALIDEUR [ERROR ON VALIDATOR BY SUPPLIER],

then the system returns the following error « The status of the work invoice is

not ERREUR_FOURNISSEUR_SUR_VALIDEUR » [ERROR ON VALIDATOR BY

SUPPLIER] (GFT_MSG_01.101)

20002 GFT_MSG_01.102 – The user is not allowed to correct the validator of this work

invoice

GFT-CU-01-SER-15: If the user do not have the required authorizations, then the

system returns the following error : « The user is not allowed to correct the

validator of this work invoice» (GFT_MSG_01.102)

20003 GFT_MSG_01.53 - The validator’s structure {0} does not exist

GFT-CU-01-SER-15: If the structure cannot be found, then the system returns

the following error « The validator’s structure

(<$IdTechniqueStructureValideur>) does not exist » (GFT_MSG_01.53)

20004 GFT_MSG_01.054 - The validator’s structure {0} is not active (ACTIF)

GFT-CU-01-SER-53: If the structure is not active, then the system returns the

following error « The validator’s structure (<$IdTechniqueStructureValideur>) is

not active » (GFT_MSG_01.054)

20005 GFT_MSG_01.095: The invoicing case {0} requires a validatorInvoicing

framework Controlled by the API before applying the business service

313 / 557


20006 GCU_MSG_05.019 – the value {0} is required Controlled by the API before applying the business service

314 / 557


2.3.3.5 Recycle work invoice

The method recyclerFactureTravaux allows to modify routing data of an invoice with a « A RECYCLER – ERREUR DES

DONNES D’ACHEMINEMENT» (To be recycled – routing data error) status or « ERREUR MOA » (Contracting authority

error) status or with works contracts.

Input table

Attribute Typing (tagger) Format Management rules Service providing



String: technical id of the current user in the Chorus Pro system


0-1

idFactureTravaux

String: technical ID of the work invoice in the CPP 2017 system

integer

This identifier uniquely identifies the work invoice within the CPP 2017 system

1

Recipient

identifiantDestinataire

String: identifier of the work invoice recipient

varchar(14)

Alphanumeric value This is the recipient’s SIRET.


1


String: service code of the work invoice recipient

Varchar(100)

Alphanumeric value

Case-insensitiveIf

GestionCodeService = True [ServiceCodeManagement = True] then this value is required

RechercherServiceExecutant

0-1

numeroBonCommande

String: commitment number

varchar(50)

RechercherEngagementJuridique

0-1

Output table


idFactureTravaux

String: technical id of the work invoice within the CPP 2017 system

integer This identifier uniquely identifies the work invoice within the CPP 2017 system

1



varchar(20)

1

statutFactureTravaux

String: current

status of the work invoice

varchar(50)

1

dateDepotFactureTravaux

String: Submission date of the work invoice

date Date field: AAAA-MM-JJTHH:MM:SS+HH:MM

1

315 / 557


Error table


20000 The work invoice {0} does not exist or has been archived.

GFT_MSG_01.029 - GFT-CU-01-SER-12:

"Recycler une facture de travaux"

[Recycle a work invoice]


20001 The status of the work invoice is not A RECYCLER nor ERREUR DE MOA.




20002 The user is not allowed to recycle this work invoice




20003 The recipient structure {0} does not exist. GFT_MSG_01.031 - GFT-CU-01-SER-12:



{0} = Identifiant structure destinataire

[Identifier of the recipient structure]

20004 The recipient service code {0} does not exist.




{0} = Code service exécutant [Executing

service code]

20005 The service code {0} does not match with the recipient structure {1}.





service code]



20006 The recipient structure {0} is not a public structure






20007 The recipient structure {0} is not active (ACTIF)






20008 The recipient service code {0} is not active (ACTIF)





service code]

20009 The recipient structure cannot be uniquely a contractive authority (MOA UNIQUEMENT) for this invoicing frameworkInvoicing framework




{0} = CadreFacturation

[InvoicingFramework]

316 / 557


20010 The recipient service code is required for the recipient structure




20011 This recipient structure requires a service code or a commitment number.




20012 The recipient service requires a commitment number.

GFT_MSG_01.041 - GFT-CU-01-SER-12 -

« Recycler une facture de travaux »


20013 The recipient structure requires a commitment number.




20014 The commitment number {0} does not exist




{0} = NumeroEngagement

[CommitmentNumber]

317 / 557


2.4 User and structure management

2.4.1 Manage areas from my structure/service


- Add area

- Search area

- Delete area

2.4.1.1 Add area

The method ajouterEspace allows to add an area to the structure or the structure service

Input table



Service

providing the

data

Multiplicity

structure

1

idStructure Technical id of

the structure in

the CPP 2017

system

integer This identifier

uniquely identifies

a structure within

the CPP 2017

system.

Required :

IdStructure

OR

TypeIdentifiantStr

ucture +

IdentifiantStructur

e

RechercherStru

cture

0-1

typeIdentifi

antStructur

e

Enumeration of

the possible

values of

identifier type


TypeIdentifiant

Required:

IdStructure

OR

TypeIdentifiantStr

ucture +

IdentifiantStructur

e

RechercherStru

cture

0-1

identifiantS

tructure

Functional

identifier of the

structure


value

Required:

IdStructure

OR

TypeIdentifiantStr

ucture +

RechercherStru

cture

0-1

318 / 557


IdentifiantStructur

e

idService Technical

identifier of the

service in the

CPP 2017

system


uniquely identifies

the service within

the CPP 2017

system.

RechercherSer

vicesStructure

0-1

idEspace Technical

identifier of the

Front Office

integer The identifiers of

the areas « Justice

costs invoice »

and « ICT refunds

request » are not

authorized,

because they are

not managed via

API requests.

The list of

identifiers is

available in the

External

Specifications. 1

parametresAjouterEspace

0-1

pageResult

atDemande

e

Number of the

results page to

be displayed

integer By default, the

output is the first

page.

0-1

nbResultats

ParPage

Number of

results per

page that can

be returned by

the research


service returns 10

results per page.

0-1

triSens Sorting order varchar(10) Enumeration with

two possible

values:

- ascending

sorting

- downward

sorting

By default, the

sorting is

downward.

0-1

triColonne Reference

column of the

sorting

varchar(80) Enumeration with

the attributes’

names of the

results’ list. By

default, the

sorting order is

performed on the

first attribute of

the results’ list.

0-1

319 / 557


Output table


parametresRetou

r

0-1


current page

integer

0-1

pages Number of pages

returned by the

research

integer

0-1

nbResultatsP

arPage

Number of results

per page

integer

0-1

total Number of results

returned by the

research

integer

0-1

listeEspace

0-n

idService Technical identifier

of the service

integer This identifier uniquely


within the CPP 2017

system.

0-1

codeService Service code varchar(100) Alphanumeric value

0-1

libelleService Label of the

service

varchar(100)

0-1

idEspaceFo Technical identifier

of the area

integer

0-1

codeEspace Area code integer

0-1

libelleEspace Label of the area varchar(100)

0-1

320 / 557


etatCourant Status of the

structure/service’s

area


EtatEspaceFoService 0-1

typeHabilitati

on

Type of

authorization on

the area


TypeHabilitation 0-1

Error table


20000 No active structure corresponds to the

identifier {0}.

GCU_MSG_06.001 - GCU-CU-16-SER-02:

« Ajouter les espaces ouverts à la structure

» [Add the available areas to the structure]

{0} = [identifier of the structure]

20001 The user {0} is not primary or secondary

manager of the structure {1}.




{0} = [name and surname of the user]



structure {1}.




{0} = [identifier of the service]


20003 The area {0} is already available in the

structure {1}.

GCU_MSG_06.005 - GCU-CU-16-SER-02



{0} = [label of the area]


20004 The area {0} is already available in the

service {2} of the structure {1}.







20005 The area {0} is not available in this type of

structure {1}.






20006 Please enter a technical identifier of

structure or a type and a functional

identifier of structure.


321 / 557


2.4.1.2 Search area

The method rechercherEspaces allows to send back the list of areas specified to a structure or a structure service.

Input table



Service

providing the

data

Multiplicity

structure 1

idStructur

e

Technical

identifier of the

structure in the

CPP 2017

system

integer

This identifier

uniquely identifies a


CPP 2017 system.

Required :

IdStructure

OR


ure +


RechercherStr

ucture 0-1

typeIdenti

fiantStruct

ure

Enumeration of

identifier type

possible values

varchar(

50)

Enumeration

TypeIdentifiant

Required:

IdStructure

OR


ure +


RechercherStr

ucture 0-1

identifiant

Structure

Functional

identifier of the

structure

varchar(

80)

Alphanumeric value

Required:

IdStructure

OR


ure +


RechercherStr

ucture 0-1

idService

Technical

identifier of the

service in the

CPP 2017

system

integer

This identifier



2017 system.

RechercherSer

vicesStructure 0-1

parametresRechercherEspaces

0-1

pageResul

tatDeman

dee

Number of the

results page to

be displayed

integer By default, the output

is the first page. 0-1

322 / 557


nbResultat

sParPage

Number of

results per

page that can

be returned by

the research

integer

By default, the

service returns 10

results per page.

0-1

triSens Sorting order varchar(

10)


possible values:

- ascending sorting

- downward sorting

By default, the

sorting is downward.

0-1

triColonne

Reference

column of the

sorting

varchar(

80)


attributes’ names of

the results’ list. By

default, the sorting

order is performed on

the first attribute of


0-1

Output table


parametresRetour

0-1



pages

Number of pages

returned by the

research

integer 0-1

nbResultatsParPa

ge

Number of results


total

Number of results

returned by the

research

integer 0-1

listeEspace 0-n


of the service integer



within the CPP 2017

system.

0-1

323 / 557


codeService Service code varchar(100) Alphanumeric value 0-1


service varchar(100) 0-1


of the area integer 0-1

codeEspace Area code integer 0-1

libelleEspace Label of the area varchar(100) 0-1

etatCourant

Status of the


area



typeHabilitation

Type of

authorization on

the area



Error table



identifier {0}.

GCU-CU-16-SER-01: « Rechercher les

espaces de la structure » [Search for the

areas of the structure]


GCU_MSG_06.001


structure {1}.

GCU-CU-16-SER-01: « Rechercher les

espaces de la structure » [Search for the

areas of the structure]



GCU_MSG_06.004

20002

Please enter the technical identifier of a

structure or a type and a functional

identifier of a structure.


20003 The user {0} is not connected to the

structure {1}.

GCU_MSG_08.010

{0}= name and surname of the user

{1}= identifier of the structure


324 / 557


2.4.1.3 Delete area

The method supprimerEspace allows to delete an area from the structure or the structure service.

Input table



Service

providing the

data

Multiplicity

structure

1

idStructure Technical

identifier of the

structure in the

CPP 2017

system




CPP 2017 system.

Required :

IdStructure

OR


ure +


RechercherStru

cture

0-1

typeIdentifi

antStructur

e

Enumeration of

the identifier

type possible

values

varchar(

50)

Enumeration

TypeIdentifiant

Required:

IdStructure

OR


ure +


RechercherStru

cture

0-1

identifiantSt

ructure

Functional

identifier of the

structure

varchar(

80)

Alphanumeric value

Required:

IdStructure

OR


ure +


RechercherStru

cture

0-1

idService Technical

identifier of the

service in the

CPP 2017

system




2017 system.

RechercherSer

vicesStructure

0-1

idEspace Technical

identifier of the

FO area to

delete

integer The identifiers of the

areas « Justice costs

invoice » and « ICT

refunds request » are

not authorized,

because they are not

The list of

identifiers is

available in the

External

Specifications.

1

325 / 557


managed via API

requests.

motif Area deletion

reason

varchar(

255)

0-1

parametresSupprimerEspace

0-1

pageResulta

tDemandee

Number of the

results page to

be displayed


is the first page.

0-1

nbResultats

ParPage

Number of

results per

page that can

be returned by

the research


service returns 10

results per page.

0-1


10)


possible values:

- ascending sorting

- downward sorting

By default, the


0-1

triColonne Reference

column of the

sorting

varchar(

80)








0-1

326 / 557


Output table


parametresRetour

0-1



pages

Number of pages

returned by the

research

integer 0-1

nbResultatsParPa

ge

Number of results


total

Number of results

returned by the

research

integer 0-1

listeEspace 0-n


of the service integer



within the CPP 2017

system.

0-1

codeService Service code varchar(100

) Alphanumeric value 0-1

libelleService Label of the service varchar(100

) 0-1


of the area integer 0-1

codeEspace Area code integer 0-1

libelleEspace Label of the area varchar(100

) 0-1

327 / 557


etatCourant

Status of the


area

varchar(100

)

Enumeration


typeHabilitation

Type of

authorization on the

area



Error table



identifier {0}.

GCU_MSG_06.001 - GCU-CU-16-SER-

03: « Supprimer des espaces ouverts à

la structure » [Delete available areas of

the structure]

{0} = [Identifier of the structure]

20001 No valid user whose connection

address is {0}




the structure]

{0} = [connection email address of the

user]

20002

The user {0} is not primary or

secondary manager of the structure

{1}.




the structure]

{0} = [name and surname of the user ]



structure {1}.




the structure]



20004 The area {0} is not available in the

structure {1}.




the structure]

{0} = label of the area

{1} = functional identifier of the

structure


service {2} of the structure {1}.




the structure]

{0} = label of the area

{1} = functional identifier of the

structure

{2} = service code

328 / 557


20006

Please enter the technical identifier of a

structure or the type and the functional

identifier of a structure.


20007 The sent area is not managed by an

API request. GDP_MSG_01.012 - SXP

329 / 557


2.4.2 Manage my structure


- Consult SIRET information

- Consult structure

- Consult structure with intra-community VAT

- Modify structure

- Search structure services

- Search structure

- Search users connected to structure

- Search users managed by manager

- Retrieve structures managed by manager

- Change primary manager

- Enter structure general informations

- Download recipient directory

2.4.2.1 Consult SIRET information

The method consulterInformationSIRET allows to retrieve data from the structure with a SIRET type matching the

INSEE database.

Input table

Attribute Typing (tagger) Format Management rules Service providing the

data Multiplicity

siretStructure

SIRET number of

the structure to

search for

varchar(14) 1

Output table


siret SIRET number varchar(14) - 0-1

siren SIREN number varchar(9) - 0-1

numeroInterneClassement Intern number of classifying varchar(5) - 0-1

adresse Address of the supplier varchar(255

) - 0-1

330 / 557


siege Registered office varchar(3) - 0-1

dateCreationEtablissement Creation date of the

settlement date


JJ 0-1

raisonSociale Corporate name of the

company varchar(38) - 0-1

civilite Civility varchar(3) - 0-1

categorieJuridique Legal category varchar(255

) - 0-1

dateCreationEntreprise Creation date of the company date Date field: AAAA-MM-

JJ 0-1

categorieEntreprise Company category varchar(5) - 0-1

localisationSiege Headquarters location varchar(50) - 0-1

dateReactivationEtablissement

Reactivation date of the

settlement date


JJ 0-1

siretPredecesseurSuccesseur

SIRET number of the

predecessor varchar(14) - 0-1

estActif The structure is active or not boolean

true: the structure is

active

false: the structure is

not active

0-1

Error table


20000 Incorrect SIRET format. GCU_MSG_01_014

20001 The structure {0} is unknown from the

INSEE database.

GCU_MSG_00.026


331 / 557


20002 The link with the SIREN database is not

operational. Please try again later.

GCU_MSG_00_311

332 / 557


2.4.2.2 Consult structure

The method consulterStructure allows to consult information from a structrue to which a user is connected.

Input table



idUtilisateurCo

urant

Number: technical

identifier of the

user in the CPP

system

integer



2017 CPP system

0-1

idStructureCP

P

Number: technical

identifier of the


CPP 2017 system

integer




structure

RechercherStruct

ure 1

codeLangue

String: code of the

language used in

the multilingual

descriptions

varchar(5)

Without value, if no language

is chosen or supported by the


written in french.

0-1

Output table

Attribut

e Subattribute

Sous-


General informations

information

Generales 1

idStructureCP

P

Number: technical

identifier of the


CPP 2017 system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

1

raisonSociale

Structure

String: corporate

name of the

structure

varchar(

99) 1

identifiantStr

ucture


the structure

varchar(

80) 1

typeIdentifian

tStructure

String: identifier

type of the structure

varchar(

14) 1

libelleStructur

e


structure

varchar(

99) 0-1

emailStructur

e

String: email

address of the

structure

varchar(

200) 0-1

nomStructure

String: name of the

structure

varchar(

100) 0-1

prenomStruct

ure

String: surname of

the structure

varchar(

100) 0-1

numeroRcsSt

ructure

String: RCS tax

identification of the

structure

varchar(

20) 0-1

333 / 557


structurePrive

ePublique

String: indicates if

the structure is

private or public

varchar(

15)

Enumeration with 2

possible values:

- PRIVEE

- PUBLIQUE

0-1

Headquarters postal address

adressePost

aleDuSiege 1

adresse String: address

details

varchar(

100) 1

complementA

dresse1

String: first

complement of the

address

varchar(

100) 0-1

complementA

dresse2

String: second

complement of the

address

varchar(

100) 0-1

ville String: city varchar(

50) 1

codePostal String: postal code varchar(

10) 0-1

pays String: country varchar(

100) 0-1

telephone String: phone

number

varchar(

15) 0-1

indicatifTelep

hone

String:

international

dialling code

varchar(

5) 0-1

fax String: fax number varchar(

15) 0-1

indicatifFax String: dialling code

of fax number

varchar(

5) 0-1

Parameters

parametres 0-1

recevoirDonn

eesViaEDI

boolean: ability of

the structure to

receive data via EDI

mode

boolean

Required if the type

of the structure is

PUBLIC.

true: the structure

is able to receive

data via EDI mode.

false: the structure

is not able to


mode.

0-1

numeroEJDoit

EtreRenseign

e

boolean:

commitment

number required or

not

boolean


of the structure is

PUBLIC.

true: the

commitment

0-1

334 / 557


number is required

ofr invoices and

work invoices.

false: the

commitment

number is not

required ofr invoices

and work invoices.

codeServiceD

oitEtreRensei

gne

boolean: service

code entered by the

supplier required or

not

boolean


of the structure is

PUBLIC.

True: the service

code is required for

invoices and work

invoices.

False: the service

code is not required

for invoices and

work invoices.

0-1

statutMiseEnP

aiementNestP

asRemonte

boolean: the « Mise

en paiement »

[Payment] status is

not returned to the

supplier.

boolean


of the structure is

PUBLIC.

True: the « Mise en

paiement »

[Payment] status of

invoices/work

invoices will be not

returned to the

supplier.

False: the « Mise en

paiement »

[Payment] status of

invoices/work

invoices will be

returned to the

supplier.

0-1

connexionEDI

boolean:

connection of the

structure via EDI

mode

boolean


of the structure is

PUBLIC.

True: the structure

is connected via EDI

mode.

False: the structure

is not connected via

EDI mode.

0-1

gestionNumer

oEJOuCodeSe

rvice

boolean:

commitment

number or service

code entered by the

boolean


of the structure is

PUBLIC.

0-1

335 / 557



not

True: the

commitment

number or the

service code is

required for invoices

and work invoices.

False: the

commitment

number or the

service code is not


and work invoices.

estMOA

boolean: presence

of a Contracting

Authority within the

structure

boolean

This data must be

entered only for a

public structure:

TRUE or FALSE

0-1

estMOAuniqu

ement

boolean: ability of

the structure to

process work

invoices only

boolean

This data must be

entered only for a

public structure:

TRUE or FALSE

0-1

Error table


20000 Connection email address of the user not

found. GCU_MSG_00.008

20001 The identifier of the structure does not

correspond to a valid structure. GCU_MSG_00.014

20002 The user cannot view this structure GCU_MSG_07.004

336 / 557


2.4.2.3 Consult structure with intra-community VAT

The method consulterStructureAvecTVAIntraCom allows to consult information from a structure to which the user is

connected (including its intra-community VAT).

Input table



idStructureCP

P

Number: technical

identifier of the


CPP 2017 system

integer




structure

RechercherStruct

ure 1

codeLangue

String: code of the

language used in

the multilingual

descriptions

varchar(5)

Without value, if no language

is chosen or supported by the


written in french.

0-1

Output table

Attribut

e Subattribute

Sous-



information

Generales 1

idStructureCP

P

Number: technical

identifier of the


CPP 2017 system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

1

raisonSociale

Structure

String: corporate

name of the

structure

varchar(

99) 1

identifiantStr

ucture


the structure

varchar(

80) 1

typeIdentifian

tStructure

String: identifier


varchar(

14) 1

libelleStructur

e


structure

varchar(

99) 0-1

emailStructur

e

String: email

address of the

structure

varchar(

200) 0-1

nomStructure

String: name of the

structure

varchar(

100) 0-1

prenomStruct

ure

String: surname of

the structure

varchar(

100) 0-1

numeroRcsSt

ructure

String: RCS tax

identification of the

structure

varchar(

20) 0-1

structurePrive

ePublique

String: indicates if

the structure is

private or public

varchar(

15)

Enumeration with 2

possible values: 0-1

337 / 557


- PRIVATE

- PUBLIC


adressePost

aleDuSiege 1


details

varchar(

100) 1

complementA

dresse1

String: first

complement of the

address

varchar(

100) 0-1

complementA

dresse2

String: second

complement of the

address

varchar(

100) 0-1

ville String: city varchar(

50) 1

codePostal String: postal code varchar(

10) 0-1

pays String: country varchar(

100) 0-1


number

varchar(

15) 0-1

indicatifTelep

hone

String: international

dialling code

varchar(

5) 0-1

fax String: fax number varchar(

15) 0-1

indicatifFax String: dialling code

of fax number

varchar(

5) 0-1

Parameters

parametres 0-1

recevoirDonn

eesViaEDI

boolean: ability of

the structure to


mode

boolean


of the structure is

PUBLIC.

true: the structure

is able to receive

data via EDI mode.

false: the structure

is not able to


mode.

0-1

numeroEJDoit

EtreRenseign

e

boolean:

commitment

number required or

not

boolean


of the structure is

PUBLIC.

true: the

commitment

number is required

ofr invoices and

work invoices.

false: the

0-1

338 / 557


commitment

number is not

required ofr invoices

and work invoices.

codeServiceD

oitEtreRensei

gne

boolean: service

code entered by the


not

boolean


of the structure is

PUBLIC.

True: the service


invoices and work

invoices.

False: the service

code is not required

for invoices and

work invoices.

0-1

statutMiseEnP

aiementNestP

asRemonte

boolean: the « Mise

en paiement »

[Payment] status is

not returned to

thesupplier.

boolean


of the structure is

PUBLIC.


paiement »

[Payment] status of

invoices/work


returned to

thesupplier.


paiement »

[Payment] status of

invoices/work

invoices will be

returned to the

supplier.

0-1

connexionEDI

boolean: connection

of the structure via

EDI mode

boolean


of the structure is

PUBLIC.

True: the structure

is connected via EDI

mode.


is not connected via

EDI mode.

0-1

gestionNumer

oEJOuCodeSe

rvice

boolean:

commitment

number or service

code entered by the


not

boolean


of the structure is

PUBLIC.

True: the

commitment

number or the

service code is

0-1

339 / 557



and work invoices.

False: the

commitment

number or the

service code is not


and work invoices.

avecMOA

boolean: presence

of a Contracting

Authority within the

structure

boolean

True: the structure

is able to be a

Contracting

Authority.


is not able to be a

Contracting

Authority.

0-1

estMOAuniqu

ement

boolean: ability of

the structure to

process work

invoices only

boolean

This data must be

entered only for a

public structure:

TRUE or FALSE

0-1

Error table


20000 Connection email address of the user not

found. GCU_MSG_00.008



20002 The user cannot view this structure GCU_MSG_07.004

340 / 557


2.4.2.4 Modify structure

The method modifierStructure allowd to modify information and parameters of a structure managed by the user

Input table



Service

providing

the data

Multiplicity

idUtilisateurCo

urant

Number: technical

identifier of the

user in the CPP

system

integer



the 2017 CPP system

0-1

idStructure

Number: technical

identifier of the

structure within

the CPP 2017

system

integer

This technical identifier uniquely identifies the structure within the CPP 2017 structure Required: IdStructure OR TypeIdentifiantStructure + IdentifiantStructure

0-1

typeIdentifian

tStructure

String:

enumeration of

the identifier type

possible values

varcha

r(50)

Enumeration with 7 possible values: - SIRET - RIDET - TAHITI - HORS_UE - UE_HORS_FRANCE - PARTICULIER - EN_COURS_IMMATRICULATION

Required: IdStructure OR TypeIdentifiantStructure + IdentifiantStructure

Rechercher

Structure 0-1

identifiantStru

cture

String: functional

identifier of the

structure

varcha

r(80)

Alphanumeric value Required: IdStructure

OR TypeIdentifiantStructure + IdentifiantStructure

Rechercher

Structure 0-1


informationsG

eneralesStruct

ure

1

libelleStruc

ture


structure

varcha

r(99) 0-1

emailStruct

ure

String: email

address of the

structure

varcha

r(200)

If this field is not empty,

the format of the datat

is:

string of characters

(without special ones) +

0-1

341 / 557


« @ » + EITHER IP OR


(without special ones) +

« . » + 2 characters

(minimum, without

special ones)

nomStructu

re

String: name of

the structure’s

deputy

varcha

r(100) 0-1

prenomStr

ucture

String: surname of

the structure’s

deputy

varcha

r(100) 0-1

numeroRcs

Structure

String: RCS tax

identification of

the structure

varcha

r(20) 0-1

centreGesti

onAgricole

boolean: the

structure is an

Agricultural

Management

center

boolea

n

True: the structure is an

Agricultural Management

center.

False: the structure is

not an Agricultural

Management center.

0-1

etatStructu

re

String: status of

the structure

varcha

r(10)

Required if the

structure is private.

Empty if the structure is

public.

0-1

raisonSocia

le

String: corporate

name of the

structure

varcha

r(200)

numeroTVA

String:

intracommunity

VAT identifier

varcha

r(16) 0-1

Postal address of the service

adressePostal

e 1


details

varcha

r(100)

Changing the postal

address is not required

during the modification of

a structure sheet.

For example : if the

country code is entered,

then the others fields of

the address/city/postal

code are required.

Furthermore there is no

need to change these

parameters.

0-1

complemen

tAdresse1

String: first

complement of the

address

varcha

r(100) 0-1

342 / 557


complemen

tAdresse2

String: second

complement of the

address

varcha

r(100) 0-1

ville String: city varcha

r(50)

The city entered

corresponds to the

specified postal code.

0-1

codePostal String: postal code varcha

r(10)

The postal code is a string

of characters (maximum 9

alphanumeric characters) :

the string can contain

numbers and characters.

No special character can

be entered.

0-1

pays String: country

code

varcha

r(2)

Recuperer

Pays 0-1


number

varcha

r(15)

The phone number is

composed by two parts :

- The international

dialling code : 5

alphanumeric

characters,

including ‘+’ ;

- The phone number :

15 alphanumeric

characters. The

character <space>

is forbidden.

If the selected country is France, then the international dialling code is pre-entered with the value « +33 » and it cannot be changed. If another country is selected, the user can

enter the wished value with 5 characters allowed.

0-1

indicatifTel

ephone

String:

international

dialling code

varcha

r(5) 0-1

fax String: Fax

number

varcha

r(15)

The fax number is


- The fax dialling

code : 5

alphanumeric

characters,

including ‘+’ ;

- The fax number :

15 alphanumeric

characters. The

character <space>

is forbidden.

If the selected country is

France, then the fax

dialling code is pre-

entered with the value

0-1

indicatifFax

String: dialling

code of fax

number

varcha

r(5) 0-1

343 / 557


« +33 » and it cannot be

changed. If another

country is selected, the

user can enter the wished

value with 5 characters

allowed.

Parameters

paramModifier

Structure 1

recevoirDo

nneesViaED

I

boolean: ability of

the structure to

receive data via

EDI mode

boolea

n

True: the structure is able

to receive data via EDI

mode.

False: the structure is not

able to receive data via

EDI mode.

0-1

numeroEJD

oitEtreRens

eigne

boolean:

commitment

number required

or not

boolea

n

True: the commitment

number is required ofr

invoices and work

invoices.

False: the commitment

number is not required ofr

invoices and work

invoices.

0-1

codeServic

eDoitEtreR

enseigne

boolean: service

code entered by

the supplier

required or not

boolea

n

True: the service code is

required for invoices and

work invoices.

False: the service code is

not required for invoices

and work invoices.

0-1

statutMiseE

nPaiement

NestPasRe

monte

boolean: the

« Mise en

paiement »

[Payment] status

is not returned to

the supplier.

boolea

n


paiement » [Payment]

status of invoices/work


returned to the supplier.


paiement » [Payment]

status of invoices/work

invoices will be returned to

the supplier.

0-1

gestionNu

meroEJOuC

odeService

boolean:

commitment

number or service

code entered by

the supplier

required or not

boolea

n


number or the service


invoices and work

invoices.


number or the service

code is not required for

invoices and work

invoices.

0-1

344 / 557


avecMoa

boolean: presence of a Contracting Authority within the structure

boolean

True: the structure is able

to be a Contracting

Authority.

False: the structure is not able to be a Contracting Authority.

0-1

estMoaUniq

uement

boolean: ability of the structure to

process work invoices only

boolea

n

True : the structure is able to process work invoice only.

False : the structure is not only a Contracting Authority.

0-1

Output table


idStructure

Number: technical

identifier of the structure

within the CPP 2017

system

integer



CPP 2017 structure

1

Error table




20001

The identifier value is not

consistent with the identifier type

entered.

GCU-MSG-00.010

20002

Semantic error on one of the

following fields:

- identifiantStructure

- emailStructure

- ville

- codePostal

- telephone

- fax

GCU-MSG-00.011

20003 The structure does not exist. GCU-MSG-00.014

20004

The structure’s type (private or

public) is not consistent with the

identifier type and the identifier of

the structure.

GCU-MSG-00.018

20005

The user is not primary or

secondary manager of the

structure.

GCU_MSG_00.019

20006 The postal address entered is not

valid. GCU_MSG_00.038

20007 The recording of the structure’s

data has failed. GCU_MSG_00.013

20008

GCU_MSG_00.046 - If {2} or {3}

are selected, {1} must not be

selected.

{1} =

GCU_FicheStructure_Parametres_NumEJOuCodeService

{2} =

GCU_FicheStructure_Parametres_NumEngagementJuridique

345 / 557


{3} = GCU_FicheStructure_Parametres_CodeService

GCU-CU-00-RGD-135

GCU-CU-00-SER-08 Modifier une fiche structure

[Modify a structure sheet]

20009

TRA_MSG_08.001 - The value

entered in the field [Indicatif] of

the phone number must be

maximum 5-character long. The

character '+' is allowed for the

first position.

TRA-CU-08-RGD-06



20010

TRA_MSG_08.003 - Phone number

format incorrect: it must begin

with the number '0' or be 9-

character long

TRA-CU-08-RGD-08



20011

TRA_MSG_08.004 - Phone number

format incorrect: it must be 9-

character long

TRA-CU-08-RGD-08



20012

TRA_MSG_08.002 - The value

entered in the field [Indicatif] of

the fax number must be maximum

5-character long. The character '+'

is allowed for the first position.

TRA-CU-08-RGD-07



20013

TRA_MSG_08.005 - Fax number

format incorrect: it must begin

with the number '0' or be 9-

character long

TRA-CU-08-RGD-09



20014

TRA_MSG_08.006 - Fax number

format incorrect: it must be 9-

character long

TRA-CU-08-RGD-09



20015

TRA_MSG_08.007 - All the

required fields of the postal

address are not filled.

TRA-CU-08-RGD-12



20016

GCU_MSG_05.008 - The user {2}

is not registered in the CPP 2017

system or is not {3} or {4}

{2}=Name and surname of the user

{3}= ACTIF (EtatCompteFO reference table)

{4}= EN_COURS_D_ACTIVATION (EtatCompteFO reference

table)

GCU-CU-05-SER-07 Lister les abonnements aux

espaces d’un utilisateur [List the area subscriptions

of an user]

20017

GCU_MSG_00.060 - Pleas indicate

a technical identifier of structure

or a type and a functional

identifier of structure.

20018 GCU_MSG_05.019 - The field {0}

is required. {0}= label of the required field

20019 GCU_MSG_00.008 - The user {0}

is not registered in the system. {0} = [Name and surname of the user]

20020 TRA_MSG_00.018 - The country

code is not referenced.

20025 The identifier type of the structure

is different from the SIRET ; then, GCU_MSG_00.065

346 / 557


it is not possible to enter the VAT

number.

2.4.2.5 Search structure services

The method rechercherServicesStructure allows to search services belonging to a public structure or a structure to

which the user is connected.

Input table


idUtilisateur

Courant



Chorus Pro system

integer



system

0-1

idStructure

Number: technical

identifier of the

structure in the CPP

2017 system

integer



CPP 2017 structure

1


parametres

Rechercher

ServicesStr

ucture

0-1

pageResultat

Demandee


results page to be

displayed


page. 0-1

nbResultatsP

arPage

Number: Number of

results per page that

can be returned by the

research



triSens String: sorting order varchar

(10)


values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne String: reference

column of the sorting -


values:

- CodeService [Service code]

- LibelleService [Service label]

- DateDbtService [Beginning date

of the service]

- DateFinService [End date of the

service]

- EstActif [is active]


0-1

347 / 557



"CodeService".

Output table


e Typing (tagger) Format Management rules Multiplicity


pageCouran

te


current page integer

0-1

pages

Number: Number of


research

integer

0-1

nbResultats

ParPage

Number: number of

results per page integer

0-1

total

Number: Number of

results returned by the

research

integer

0-1

List of services

listeServices

0-*

idService

Number: technical

identifier of the service


integer




1

codeService String: service code

varcha

r(100) Alphanumeric value 1

libelleServic

e


service

varcha

r(100) 1

dateDbtSer

vice

String: beginning date

of the service activation

period

Date Date field: AAAA-MM-JJ

HH:MI 0-1

dateFinServ

ice

String: end date of the

service activation

period


HH:MI 0-1

estActif

Boolean: flag indicating

whether the service is

active or not, according

to its end date of

activation period

boolea

n

If the end date of the

activation period is not

entered, then the parameter

"Actif" is filled with "true".If

the end date of the activation

period is earlier than the

current date, then "Actif" is

filled with the value "false".

If not, "Actif" is filled with the

value "true".

1

Error table




20001 The identifier of the user does not

correspond to a valid user. GCU_MSG_100.003

348 / 557


20002

The user does not correspond to the

primary /secondary manager of the

structure.

GCU_MSG_00.019

349 / 557


2.4.2.6 Search structure

The method rechercherStructure allows a manager to search structures.

Input table



Service

providing

the data

Multiplicity

idUtilisateur

Courant

Number: technical

id of the current

user in the Chorus

Pro system

integer


identifies the user

within the 2017 CPP

system

0-1

structure

At least, one of the

ttributes below (without

TypeIdentifiantStructure

) must be entered.

1

raisonSocial

eStructure

String: corporate

name of the

structure

varchar(

99) 0-1

identifiantSt

ructure

String: functional

identifier of the

structure

varchar(

80)

Alphanumeric value

If


= « SIRET », the

identifier can be

composed by:

- at least 9 characters ;

- the other characters

can be as following:

o Numerical characters

o the characters ‘*’ ou ‘

?’

The characters ‘*’ et ‘ ?’

are forbidden among

the first 9 numerical

characters.

0-1

typeIdentifi

antStructur

e

String: identifier

type of the

structure

varchar(

14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

-

EN_COURS_IMMATRICU

LATION

RecupererT

ypeIdentifia

ntStructure

0-1

libelleStruct

ure


structure

varchar(

99) 0-1

nomStructu

re

String: name of the

structure’s deputy

varchar(

100) 0-1

350 / 557


prenomStru

cture

String: surname of

the structure’s

deputy

varchar(

100) 0-1

adresseCod

ePostal

String: postal code

of the structure’s

address

varchar(

10) 0-1

adresseVille String: city of the

structure’s address

varchar(

50) 0-1

adresseCod

ePays

String: country

code of the

structure’s address

varchar(

2)

RecupererP

ays 0-1

typeStructu

re

String: type of the

structure

varchar(

15)

Enumeration with 2

possible values:

- PRIVEE [PRIVATE]

- PUBLIQUE [PUBLIC]

RecupererT

ypeStructur

e

0-1

statutStruct

ure

String: status of

the structure

varchar(

10)

Enumeration with 2

possible values:

- ACTIF

- INACTIF

0-1

estMOA

Boolean: selection

of the structures

able to process

work invoices

boolean TRUE or FALSE 0-1

estMOAUNiq

uement

Boolean: selection

of the structures

able to process

work invoices only

boolean TRUE or FALSE 0-1

restreindreS

tructuresPri

vees

Boolean: selection

of private

structures

boolean

There are two cases:

1) The

attribute"ResteindreStru

cturesPrivees" is not

entered or filled with

"true" then:

the system returns in

the list all the

structures:

- all the public

structures


research criteria,

- Only the private

structures, connected to

the user and


research criteria

OR

2) The attribute

"ResteindreStructuresPr

ivees" is filled with the

0-1

351 / 557


value "false", then all

the publicand private

structures


research criteria are

returned.


parametres 0-1

pageResulta

tDemandee

Number: number of

the results page to

be displayed


the first page. 0-1

nbResultats

ParPage

Number: Number of

results per page

that can be

returned by the

research

integer



page.

0-1


order

varchar(

10)


possible values:

- ascending sorting

- downward sorting

By default, the sorting

is downward.

0-1

triColonne

String: reference

column of the

sorting

-

Enumeration with 4

possible values:

-


- IdentifiantStructure

- DesignationStructure

- Statut


is performed on the

field

"IdentifiantStructure".

0-1

352 / 557


Output table


parametres

Retour 0-1



pages

Number: Number of

pages returned by

the research

integer 0-1

nbResultatsP

arPage

Number: number of


total

Number: Number of

results returned by

the research

integer 0-1


listeStructur

es 0-n

idStructureCP

P

Number: technical

identifier of the


CPP 2017 system

integer


identifies the structure within the CPP

2017 structure

1

typeIdentifian

tStructure

String: identifier


varchar

(14)

Enumeration with 7 possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

1

identifiantStr

ucture

String: functional

identifier of the

structure

varchar

(80) Alphanumeric value 1

designationSt

ructure

String: designation

of the structure

varchar

(201)




concatenated name and surname of

its deputy.

1

statut String: status of the

structure

varchar

(8)

The status of the returned invoice is

determined from :

- the end date of the structure

validity period,

- the current date,

- the status of the structure in the

database

- the flag Duplique

If Structure.duplique = VRAI [TRUE]

Or if Structure.etat = INACTIF

[INACTIVE]Or if the end date is

entered and is earlier than the

current date:

1

353 / 557


then the status of the structure is

INACTIVE.

In all the other cases, the status of

the returned structure is ACTIVE.

Note: this calcultation is performed if

the status is not right in the database

(ex: the batch correcting the

structure statuses has not run during

the night).

This API request refreshes the

structure’s status in the database.

Thus, the status of the structure

returned by this request is not always

consistent with the status of the

structure saved in the database.

Error table


20000 No structure corresponding to the research

criteria found. GCU_MSG_00.014

20001 At least, one field of the parameter

"Structure" must be filled. TRA_MSG_00.011

20002 The user has no access to the application. GCU_MSG_00.009

20003 For a structure with a SIRET number, at

least the first 9 characters must be entered. TRA_MSG_07.001

354 / 557


2.4.2.7 Search users connected to structure

The method rechercherUtilisateursRattachesStructure allows a manager to search users connected to a structure.

Input table


e

Sous-

Subattribut

e

Sous-sous-

Subattribut

e


Multi

plicit

y

idStructure

Number:

technical

identifier of the

structure within

the CPP 2017

system

integer

This technical

identifier uniquely

identifies the


CPP 2017 system.

1


paramet

resRech

erche

0-1

pageResult

atDemande

e

Number:

number of the

results page to

be displayed

integer

By default, the

output is the first

page.

0-1

nbResultats

ParPage

Number:

Number of

results per

page that can

be returned by

the research

integer

By default, the

service returns 10

results per page.

0-1


order varchar(10)

Enumeration with

two possible

values:

- ascending sorting

- downward

sorting

By default, the

sorting is

downward.

0-1

triColonne

String:

reference

column of the

sorting

-

Enumeration with

11 possible values:

- NomUtilisateur

- PrenomUtilisateur

-

AdresseEmailConne

xion

-

AdresseContactUtili

sateur

-

StatutRattachemen

t

0-1

355 / 557


- RoleUtilisateur

- StatutUtilisateur

- DateReactivation

-

DateDerniereConne

xion

-

DateDebutRattache

ment

-

DateFinRattacheme

nt

By default, the

sorting is

performed on the

field

"NomUtilisateur".

Output table


e

Sous-

Subattribut

e

Sous-sous-

Subattribut

e


Multi

plicit

y

parametresRetour

0-1

pageCourante

Number:

number of the

current page

integer 0-1

pages

Number:

Number of

pages returned

by the research

integer 0-1

nbResultatsParPage

Number:

number of

results per

page

integer 0-1

Total

Number:

Number of

results returned

by the research

integer 0-1

List of the users connected to the structure

listeUtilis

ateurs Liste 0-n

idUtilisateur

Rattache

Number:

technical

identifier of a

user within the

CPP 2017

system

integer

This technical

identifier uniquely

identifies the user

within the CPP

2017 system.

1

nomUtilisat

eur

String: name of

the user

varchar(10

0) 1

356 / 557


prenomUtili

sateur

String:

surname of the

user

varchar(10

0) 1

adresseEm

ailConnexio

n

String:

connection

email address

of the user

varchar(20

0) 1

adresseCon

tactUtilisate

ur

String: email

address of the

user

varchar(20

0) 0-1

idRattache

ment

Number:

technical

identifier of the

connection

integer

This technical

identifier uniquely

identifies the user

within the CPP

2017 system.

1

statutRatta

chement

String: status

of the

connection

varchar(25)

Enumeration with

3 possible values:

-

EN_COURS_DE_V

ALIDATION

- VALIDÉE

- DESACTIVÉE

1

roleUtilisate

ur

String: role of

the user within

the structure

varchar(30)

Enumeration with 3

possible values:

-

GESTIONNAIRE_PR

INCIPAL

[PRIMARY_MANAGE

R]

-

GESTIONNAIRE_SE

CONDAIRE

[SECONDARY_MAN

AGER]

-

UTILISATEUR_SIMP

LE [SIMPLE_USER]

1

statutUtilisa

teur

String: status

of the user varchar(25)

Enumeration with 6

possible values:

-

EN_COURS_DE_VA

LIDATION

-

EN_COURS_D_ACTI

VATION

- ACTIF

- BLOQUE

- INACTIF

-

SUPPRIME_(LOGIQ

UE)

1

357 / 557


dateReactiv

ation

String: date of

user

reactivation

date

Date field:

AAAA-MM-

JJTHH:MM:SS+HH:

MM

0-1

dateDernier

eConnexion

String: last

login date of

the user

date

Date field:

AAAA-MM-

JJTHH:MM:SS+HH:

MM

0-1

dateDebutR

attachemen

t

String:

beginning date

of the

connection

validity period

date

Date field:

AAAA-MM-

JJTHH:MM:SS+HH:

MM:

1

dateFinRatt

achement

String: end

date of the

connection

validity period

date

Date field:

AAAA-MM-

JJTHH:MM:SS+HH:

MM

0-1

Error table


20000 No structure found for the entered

identifier. GCU_MSG_00.014

20001

GCU_MSG_05.009 - The user is not

registered in the CPP system or is not

active.

GCU_MSG_05.009

20002 The user is not authorized to manage the

structure. GCU_MSG_00.019


20005 GCU_MSG_05.029 - The identifier does not


20006

The identifier of the user – who validates

the connection request – or the identifier of

the user – who sent the connection request

– does not correspond to a valid user.

GCU_MSG_00.008

358 / 557


2.4.2.8 Search users managed by manager

The method rechercherUtilisateursGeresParGestionnaire allows to search the list of users connected to structures

managed by the manager.

Input table



Service

providing the

data

Multiplicity

nomUtilisateur

Name of the

user

varchar(1

00)

This research criterion

allows the special '*'

et '?'

0-1

prenomUtilisateur

Surname of

the user

varchar(1

00)



et '?'

0-1

adresseEmailConnexion

Connection

email

address of

the user

varchar(2

00)



et '?'

0-1

statutUtilisateur

Status of the

user

varchar(3

0)

Enumeration

"EtatCompteFo"

RecupererStatu

tsUtilisateur 0-1

structure 0-1

idStructure

Technical

identifier of

the structure

in the CPP

2017 system

integer

IdStructure

OR


ure +


RechercherStru

cture 0-1

typeIdentifia

ntStructure

Enumeration

of the

possible

values for

identifier type

varchar(5

0)

Enumeration

TypeIdentifiant

IdStructure

OR


ure +


RechercherStru

cture 0-1

identifiantStr

ucture

Functional

identifier of

the structure

varchar(8

0)

IdStructure

OR


ure +


RechercherStru

cture 0-1

idService

Technical

identifier of

the service in

the CPP 2017

system

integer

This identifier



2017 system.

RechercherSer

vicesStructure 0-1

359 / 557


parametresRecherche

0-1

pageResultat

Demandee

Number of

the results

page to be

displayed



nbResultatsP

arPage

Number of

results per

page that can

be returned

by the

research

integer

By default, the

service returns 10

results per page.

0-1

triSens Sorting order varchar(1

0)


possible values:

- ascending sorting

- downward sorting

By default, the


0-1

triColonne

Reference

column of the

sorting








0-1

Output table



parametresRetour

0-1



pages

Number of

pages returned

by the research

integer 0-1

nbResultatsPa

rPage

Number of


total

Number of

results returned

by the research

integer 0-1

360 / 557


listeUtilisateurRattachement

Liste 0-n

idStructure

Technical

identifier of the

structure within

the CPP 2017

system

integer 1

typeIdentifiant

Structure

Identifier type of

the structure

varchar(5

0)

Enumeration

"TypeIdentifiant" 1

identifiantStru

cture

Identifier of the

structure

varchar(8

0) 1

designationStr

ucture

Designation of

the structure

varchar(2

01) 0-1

idUtilisateur

Technical

identifier of the

user

integer 1

nomUtilisateur Name of the

user

varchar(1

00) 0-1

prenomUtilisat

eur

Surname of the

user

varchar(1

00) 0-1

statutUtilisate

ur

Status of the

user

varchar(3

0)

Enumeration

"EtatCompteFo" 1

roleUtilisateur User role within

the structure

varchar(3

0)

Enumeration

"RoleUtil" 0-1

statutRattache

mentStructure

Status of the

connection

varchar(2

5)

Enumeration

"EtatRattachServic

eCompteFo"

1

idRattacheme

ntStructure

Technical

identifier of the

connection

request in the

CPP 2017

system

integer 1

361 / 557


listeServicesR

attache

List of the

services to

which the user is

connected ; the

default service is

not returned.

0-n

IdService 1

CodeService

Code of the

structure’s

service

varchar(1

00)

Alphanumeric

value 0-1

LibelleService

Name of the

structure’s

service

varchar(1

00)

Alphanumeric

value 0-1

StatutService

Status of the

structure’s

service

varchar(1

0) 0-1

DateDbtServic

e

Beginning date

of the service

activation period

Date Date field: AAAA-

MM-JJ HH:MI 0-1

DateFinServic

e

End date of the

service

activation period


MM-JJ HH:MI 0-1

EstActif

Flag indicating

whether the

service is active

or not, according

to its end date

of activation

period

boolean

If the end date of

the activation

period is not

entered, then the

parameter "Actif"

is filled with

"true".If the end

date of the

activation period is

earlier than the

current date, then

"Actif" is filled with

the value "false".

If not, "Actif" is

filled with the

value "true".

1

StatutRattach

ementService

Status of the

connection

varchar(2

5)

Enumeration

"EtatRattachServic

eCompteFo"

1

362 / 557


IdRattacheme

ntService

Technical

identifier of the

connection

request in the

CPP 2017

system

integer 1

Error table



correspond to a valid user.

GCU_MSG_04.002

20001 No result returned by the research. TRA_MSG_00.015 - SXP

20002 Please enter a technical identifier or a

type and a functional identifier of a

structure.

GCU_MSG_00.062

363 / 557


2.4.2.9 Retrieve structures managed by manager

The method recupererStructuresGereesParGestionnaire allows to list structures managed by the user as primary or

secondary manager.

Input table



Service

providing the

data

Multiplicity

parametres

This identifier



CPP system

0-1

pageResul

tatDeman

dee

Number of the

results page to

be displayed



nbResultat

sParPage

Number of

results per

page that can

be returned by

the research

integer

By default, the

service returns 10

results per page.

0-1


10)


possible values:

- ascending sorting

- downward sorting

By default, the


0-1

triColonne

Reference

column of the

sorting








0-1

Output table


parametresRetour

0-1



pages

Number of pages

returned by the

research

integer 0-1

364 / 557


nbResultatsParPa

ge

Number of results


total

Number of results

returned by the

research

integer 0-1

listeStructures 0-n

idStructure


of the structure

within the CPP 2017

system

integer




2017 structure

0-1

typeIdentifiantSt

ructure

Identifier type of

the structure varchar(14)

Enumeration

"TypeIdentifiant" 0-1

identifiantStructu

re

Functional identifier

of the structure varchar(80) 0-1

designationStruc

ture

Designation of the

structure

varchar(201

)


characters which

corresponds to the


structure or the



0-1

dateCreationStru

cture

Creation date of the

structure 0-1

statutStructure Status of the

structure

Enumeration

"EtatStructure" 0-1

Error table


20000 No active user corresponds to this data.


14: « Lister les structures sur lesquels

l’utilisateur FO est gestionnaire » [List the

structures whose manager is the FO user]

2.4.2.10 Change primary manager

The method RemplacerGestionnairePrincipal retrieves the data needed for the formula of processing the connection

requests for a user and a structure.

365 / 557


Input table



Service

providin

g the

data

Multiplicity

idStructure

Number:

technical

identifier of the

structure in the

CPP 2017

system

integer


identifies a structure within the

CPP 2017 system.

Required :

IdStructure

OR

TypeIdentifiantStructure +


0-1

typeIdentifian

tStructure

String:

identifier type

of the structure

varchar(

50)


values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

-

EN_COURS_IMMATRICULATION

Required:

IdStructure

OR



0-1


String:

functional

identifier of the

structure

varchar(

80)

varchar(18)

Required:

IdStructure

OR



0-1

adresseConnexionNouveauGestionnairePrincipal

String: login

email address

of the new

primary

manager

varchar(

200)

This data is unique in the CPP

2017 system. 1

Output table



Service

providing the

data

Multiplicity

Error table

366 / 557





20000 No active user corresponds to this data. GCU_MSG_04.002

20001 The identifier of the structure does not correspond to a valid structure.

GCU_MSG_04.007

20002

The user {0} is the primary manager of the structure {1} but he does not correspond to the technical user or developper of the structure {1}.

GCU_MSG_04.023 {0}=Name and surname of the user {1} = Identifier of the structure

20003

Please enter a technical identifier or a

type and a functional identifier of a structure.

GCU_MSG_00.060

20004 The current user {0} is not primary or secondary manager of the structure {1} {2}.

GCU_MSG_04.011

{0} = [connection email address of the user] {1} = [identifier of the structure] {2} = [libellé du service]

20005 The following fields are required: {0} GCU_MSG_05.019 {0}= labels of the required fields

20006 The user {0} is already the primary manager of the structure{1}.

GCU_MSG_04.022

{0} = [connection email address of the user] {1} = [designation of the structure]

367 / 557


2.4.2.11 Enter structure general informations

The method saisirGeneralitesStructure allows a user to create a new structure and set new parameters

Input table


te

Typing


Service

providing

the data

Multiplicity

information

sGenerales 1

raisonSoci

aleStructu

re

String:

corporate

name of the

structure

varchar(99) 0-1

identifiant

Structure

String:

identifier of

the structure

varchar(80)

The rules applied on this

field are following:

- in capitals

- no accent, no cedilla

- no space

- the special characters

authorized are « - », « ’ »,

« , », « . » and « & »

1

typeStruct

ure

String:

indicates if

the structure

is private or

public

varchar(15)

Enumeration with 1

possible values:

- PRIVATE

Recuperer

TypeStruct

ure

1

typeIdenti

fiantStruct

ure

String:

identifier type

of the

structure

varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

Recuperer

TypeIdenti

fiantStruct

ure

1

libelleStru

cture

String: label

of the

structure

varchar(99) 0-1

emailStruc

ture

String: email

address of the

structure

varchar(200)


the format of the datat is:


(without special ones) + «

@ » + EITHER IP OR



. » + 2 characters

(minimum, without special

ones)

0-1

nomStruct

ure

String: name

of the varchar(100) 0-1

368 / 557


structure’s

deputy

prenomStr

ucture

String:

surname of

the structure’s

deputy

varchar(100) 0-1

numeroRc

sStructure

String: RCS

tax

identification

of the

structure

varchar(20) 0-1

numeroTV

A

String:

intracommunit

y VAT

identifier

varchar(16)

Valid only if the identifier

type of the structure is

SIRET.

0-1

estCentre

DeGestion

boolean : the

structure is an

Agricultural

Management

center

boolean

True: the structure is an

Agricultural Management

center.

False: the structure is not

an Agricultural

Management center.

1


adressePost

aleDuSiege 1

adresse

String:

address

details

varchar(100) 1

compleme

ntAdresse

1

String: first

complement

of the address

varchar(100) 0-1

compleme

ntAdresse

2

String: second

complement

of the address

varchar(100) 0-1

ville String: city varchar(50)

The city entered

corresponds to the

specified postal code.

1

codePostal String: postal

code varchar(10)

The postal code is a string

of characters (maximum 9

alphanumeric

characters) : the string

can contain numbers and

characters. No special

character can be entered.

0-1

pays String:

country code varchar(2)

Recuperer

Pays 1


number varchar(15)

The phone number is


- The international

dialling code : 5

alphanumeric

0-1

indicatifTe

lephone

String:

international

dialling code

varchar(5) 0-1

369 / 557


characters,

including ‘+’ ;

- The phone

number : 15

alphanumeric

characters. The

character <space>

is forbidden.


France, then the

international dialling code

is pre-entered with the

value « +33 » and it

cannot be changed. If

another country is

selected, the user can

enter the wished value

with 5 characters allowed.

fax String: fax

number varchar(15)

The fax number is


- The fax dialling

code : 5

alphanumeric

characters,

including ‘+’ ;

- The fax number :

15 alphanumeric

characters. The

character <space>

is forbidden.


France, then the fax

dialling code is pre-

entered with the value


changed. If another

country is selected, the

user can enter the wished

value with 5 characters

allowed.

0-1

indicatifFa

x

String:

dialling code

of fax number

varchar(5) 0-1

Output table


idStructureCPP



system

integer



CPP 2017 structure

1

370 / 557


Error table


20001 The identifier value is not consistent with

the identifier type entered. GCU-MSG-00.010

20002

Semantic error on one of the following

fields:

- identifiantStructure

- emailStructure

- ville

- codePostal

- telephone

- fax

GCU-MSG-00.011

20003 Another structure with this identifier already

exists in the CPP 2017 system. GCU-MSG-00.012

20004 Invalid user. GCU_MSG_00.008

20005 The postal address entered is not valid. GCU_MSG_00.038

20006 The recording of the structure’s data has

failed. GCU_MSG_00.013

371 / 557


2.4.2.12 Download recipient directory

The method TelechargerAnnuaireDestinataire alllows to retrieve the recipient directory.

Input table


e

Sous-

Subattribut

e

Sous-sous-

Subattribut

e


Multi

plicit

y

Output table


fichierResultat

String:

compressed and

base64-encoded

binary file

File

The current directory is available at

the following address:

PARAM_FAR0037_BASE_URL/PARAM

_FAR0037_NOM_FICHIER

1

Error table


20002 The maximum size is reached. GCU_MSG_00.067

20003 The directory is not available. GCU_MSG_00.068

372 / 557


2.4.3 Manage my service


- Consult structure service

- Modify structure service

- Search users connected to service

- Enter general information structure service

- Delete structure service

2.4.3.1 Consult structure service

The method consulterServiceStructure allows to consult:

- The information concerning a service to which the user is connected - The information concerning a public structure service ture publique

Input table


e

Sous-

Subattribut

e

Sous-sous-

Subattribut

e


Multi

plicit

y


Number:

technical id of

the current

user in the

Chorus Pro

system

integer

This identifier

uniquely identifies

the user within the

2017 CPP system

0-1

idStruct

ure

Number:

technical

identifier of the

structure within

the CPP 2017

system

integer

This identifier

uniquely identifies


the CPP 2017

system.

1

idService

Number:

technical

identifier of the

service within

the CPP 2017

system

integer

This technical

identifier uniquely

identifies the

service within the

CPP 2017 system.

1

codeLan

gue

String: code of

the language

used in the

multilingual

descriptions

varchar(2)

Without value, if no

language is chosen

or supported by

the system, the

descriptions are

written in french.

0-1

373 / 557


Output table


rules Multiplicity

informationsGenerales

1

codeService String: service

code varchar(100)

Alphanumeric

value 1

nomService String: label of

the service varchar(100) 1

descriptionService

String: details of

the service varchar(255) 0-1


adressePostale 0-1

adresse

String: postal

address of the

service

varchar(100)

1

complementAdres

se1

String: first

complement of

the service postal

address

varchar(100)

0-1

complementAdres

se2

String: second

complement of

the service postal

address

varchar(100)

0-1

codePostal

String: postal

code of the

service

varchar(10)

0-1

ville String: city of the

service varchar(50)

1

pays String: country of

the service varchar(50)

Multilingual

description: the

returned

description

depends on the

requested

language in the

service

parameters.

0-1

telephone

String: phone

number of the

service

varchar(15)

0-1

indicatifTelephone

String:

international

dialling code of

the service

varchar(5) 0-1

fax

String: fax

number of the

service

varchar(15)

0-1

indicatifFax

String: fax

dialling code of

the service

varchar(5) 0-1

374 / 557


Parameters

parametres 1

dateCreation

String: creation

date of the

service

Date

Date field:

AAAA-MM-

JJTHH:MM:SS+H

H:MM

1

dateModification

String: last

modification date

of the service

Date

Date field:

AAAA-MM-

JJTHH:MM:SS+H

H:MM

1

dateDebutValidite

String: activation

date of the

service

Date

Date field:

AAAA-MM-

JJTHH:MM:SS+H

H:MM

1

dateFinValidite

String: end date

of the service

validity period

Date

Date field:

AAAA-MM-

JJTHH:MM:SS+H

H:MM

0-1

numeroEngageme

nt

Boolean:

commitment

number required

or not

boolean

Only for public

structures.

- True: the

commitment

number is

required.

- False: the

commitment

number is not

required.

0-1

Error table


20000 No structure found for identifier. GCU_MSG_00.014

20001 User not registered in the system. GCU_MSG_00.008

20002 No service found for the structure entered. GCU_MSG_00.021

375 / 557


2.4.3.2 Modify structure service

The method modifierServiceStructure allows to modify the information, contact information and areas of the

structure service managed by the user

Input table



Service

providing

the data

Multiplicity

idStructure

Number: technical

identifier of the

structure to modify in

the CPP 2017 system

integer




structureRequired:

IdStructure

OR



RechercherS

tructure 0-1

typeIdentifiantS

tructure

String: enumeration

of the identifier type

possible values

varchar(

50)


values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

-

EN_COURS_IMMATRICULATION

Required:

IdStructure

OR



RechercherS

tructure 0-1

identifiantStruct

ure

String: Functional

identifier of the

structure

varchar(

80)

Alphanumeric valueRequired:

IdStructure

OR



RechercherS

tructure 0-1

idService

Number: technical

identifier of the

service to modify in

the CPP 2017 system

integer




1


codeService String: service code varchar(


nomService String: label of the

service

varchar(


0-1

descriptionServi

ce

String: details of the

service

varchar(

255)

0-1

statutService Status of the service varchar(

100)


values:

- ACTIF [ACTIVE]

0-1

376 / 557


- INACTIF [INACTIVE]

- SUPPRIME [DELETED]

Parameters

dateDebutValidi

te

String: beginning

date of the service

validity period



dateFinValidite

String: end date of

the service validity

period



numeroEngage

ment

Boolean:

commitment

number

boolean


number is required.


number is not required.

Only for public structures.

0-1

List of areas

listeEspaces List 1-n

idEspace

Number: technical

identifier of the area

in the CPP 2017

system

integer


identifies the area within the

CPP 2017 system.

1


paramInitialiser

ModifierService

Structure

0-1

nbResultats

Maximum

Number: Maximum

number of results that

can be seen for a

research

integer



results.

0-1

pageResulta

tDemandee

Number: number of

the result page to be

displayed


the first page. 0-1

nbResultats

ParPage

Number: Number of


can be returned by

the research

integer



page.

0-1

triSens String: sorting order varchar(10

)


possible values:

- ascending sorting

- downward sorting


downward.

0-1



Enumeration with 5

possible values:

- CodeService

- LibelleService

- DateDbtService

- DateFinService

- EstActif

0-1

377 / 557




"CodeService"

Output table


e Typing (tagger) Format Management rules Multiplicity

parametresRetou

r

pageCoura

nte

Number: number of


pages

Number: Number of


research

integer 0-1

nbResultats

ParPage

Number: number of


total

Number: Number of

results returned by

the research

integer 0-1

List of updated services

listeServices

0-*

idService

Number: technical

identifier of the

service in the CPP

2017 system

integer



system.

1

codeServic

e String: service code

varcha


libelleServi

ce


service

varcha

r(100) 1

dateDbtSer

vice

String: beginning

date of the service

activation period

Date Date field: AAAA-MM-


dateFinSer

vice

String: end date of

the service activation

period



estActif

Boolean: flag

indicating whether

the service is active

or not, according to

its end date of

activation period

boolea

n

If the end date of the activation

period is not entered, then the

parameter "Actif" is filled with

"true".If the end date of the

activation period is earlier than

the current date, then "Actif" is

filled with the value "false".

If not, "Actif" is filled with the

value "true".

1

Error table



378 / 557







20002

The user does not correspond to the

primary /secondary manager of the

structure.

GCU_MSG_00.019

20003 The service code does not correspond to a

valid service of the structure. GCU_MSG_100.002

20004

For any area-object from the list of areas,

the code of the area is not entered and does

not correspond to an existing area code

within the EspaceFo database.

GCU_MSG_100.007

20005

GCU_MSG_100.008 - The end date of the

service validity period is not consistent with

the new chosen status.

GCU-CU-100-SER-04 Modifier un

service d’une structure [Modify a

structure’s service]

20006 GCU_MSG_100.007 - The area {0}does not

exist in the list of FO areas.

{0} = [Code of the FO area]

GCU-CU-100-SER-04 Modifier un

service d’une structure [Modify a

structure’s service]

20007 GCU_MSG_06.001 - No active structure

corresponds to the identifier {0}.


GCU–CU-16-SER-03 Supprimer des

espaces ouverts à la structure [Delete

areas available in the structure]

20008 GCU_MSG_06.002 - No valid user whose

connection address is {0}

{0} = [Connection address]




20009

GCU_MSG_06.003 - The user {0} is not

primary or secondary manager of the

structure {1}.

{0} = [Name and surname of the user]





20010 GCU_MSG_06.004 - The service {0} is

unknown for the structure {1}.






20011 GCU_MSG_06.007 - The area {0} is not

available in the structure {1}.






20012

GCU_MSG_06.008 - The area {0} is not

available in the service {2} of the

structure {1}.







379 / 557


20013 GCU_MSG_06.005 - The area {0} is already

available in the structure {1}.



GCU–CU-16-SER-02 Ajouter les espaces

ouverts à la structure [Add areas

available in the structure]

20014

GCU_MSG_06.006 - The area {0} is already

available in the service {2} of the structure

{1}.







20015 GCU_MSG_06.010 - The area {0} is not

available for the structure {1}.






20016

GCU_MSG_00.060 - Please enter a

technical identifier or a type and a

functional identifier of a structure.

380 / 557


2.4.3.3 Search users connected to service

The method rechercherUtilisateursRattachesService allows a manager to search users connected to a structure service

Input table


e

Sous-

Subattribut

e

Sous-sous-

Subattribut

e


Multi

plicit

y

idStructure

Number:

technical

identifier of the

structure within

the CPP 2017

system

integer

This technical

identifier uniquely

identifies a


CPP 2017 system.

1

idService

Number:

technical

identifier of the

service linked

to the

structure,

which is

concerned by

the user

research

integer

This identifier

uniquely identifies

the service within

the CPP 2017

system.

1


paramet

resRech

erche

0-1

pageResult

atDemande

e

Number:

number of the

result page to

be displayed

integer

By default, the

output is the first

page.

0-1

nbResultats

ParPage

Number:

Number of

results per

page that can

be returned by

the research

integer

By default, the

service returns 10

results per page.

0-1


order varchar(10)

Enumeration with

two possible

values:

- ascending sorting

- downward

sorting

By default, the

sorting is

downward.

0-1

triColonne String:

reference -

Enumeration with 5

possible values:

- NomUtilisateur

0-1

381 / 557


column of the

sorting

- PrenomUtilisateur

-

AdresseEmailConta

ctUtilisateur

- RoleUtilisateur

-

StatutRattachemen

t

By default, the

sorting is

performed on the

column"NomUtilisat

eur"

Output table


e

Sous-

Subattribut

e

Sous-sous-

Subattribut

e


Multi

plicit

y

parametresRetour

0-1

pageCourante

Number:

number of the

current page

integer 0-1

pages

Number:

Number of

pages returned

by the research

integer 0-1

nbResultatsParPage

Number:

number of

results per

page

integer 0-1

total

Number:

Number of

results returned

by the research

integer 0-1

List of the users connected to the structure

listeUtilis

ateursRa

ttachesA

uService

Liste 0-n

idUtilisateur

Number:

technical

identifier of a

user within the

CPP 2017

system

integer

This technical

identifier uniquely

identifies the user

within the CPP

2017 system.

1

idRattache

ment

Number:

technical

identifier of the

connection

integer

This technical

identifier uniquely

identifies the user

connection to a

1

382 / 557



CPP 2017 system.

nomUtilisat

eur

String: name of

the user

varchar(10

0) 1

prenomUtili

sateur

String:

surname of the

user

varchar(10

0) 1

adresseEm

ailContactU

tilisateur

String: email

address of

contact of the

user

varchar(20

0) 1

roleUtilisate

ur

String: role of

the user varchar(30)

Enumeration with

3 possible values:

-

GESTIONNAIRE_P

RINCIPAL

[PRIMARY_MANA

GER]

-

GESTIONNAIRE_S

ECONDAIRE

[SECONDARY_MA

NAGER]

-

UTILISATEUR_SI

MPLE

[SIMPLE_USER]

1

statutRatta

chement

String: status

of the

connection

varchar(25)

Enumeration with

2 possible values:

-

EN_COURS_DE_V

ALIDATION

- VALIDEE

1

Error table


20000 No structure found for identifier GCU_MSG_00.014

20001 The user is not registered in the CPP system

or is not active. GCU_MSG_05.009

20002 The user is not primary or secondary

manager of the structure. GCU_MSG_00.019

20003 No service found for the structure entered. GCU_MSG_00.021


383 / 557


2.4.3.4 Enter general information structure service

The method saisirGeneralitesServiceStructure allows a user to create a new service and set its parameters

Input table


e

Sous-

Subattribut

e

Sous-

sous-

Subattrib

ute

Typing


Multipli

city

idStructure

Number:

technical

identifier of

the structure

in the CPP

2017 system

integer

This technical

identifier uniquely

identifies the

structure within

the CPP 2017

structure

1


informati

onsGene

rales

1

codeService

String:

service code

varcha

r(100)

Alphanumeric

value

1

nomService

String: label

of the service

varcha

r(100) 1

description

Service

String:

details of the

service

varcha

r(255) 0-1


adressePostale

Required if the

structure is the

State

0-1

adresse

String: postal

address

entered by

the supplier

varcha

r(100)

1

complemen

tAdresse1

String: first

complement

of the

supplier’s

postal

address

varcha

r(100)

0-1

complemen

tAdresse2

String:

second

complement

of the

supplier’s

postal

address

varcha

r(100)

0-1

384 / 557


codePostal

String:

postal code

entered by

the supplier

varcha

r(10)

Required if the

country is France.

The postal code is

a string of

maximum 10

alphanumerical

characters. It

could contain

numbers and

characters. It is

not allowed to

enter special

characters.

0-1

ville

String: city

entered by

the supplier

varcha

r(50)

1

pays

String:

country

entered by

the supplier

varcha

r(2)

Recu

perer

Pays

1

indicatifPay

sTelephone

String:

international

dialling code

of the

supplier’s

phone

number

varcha

r(5)

Could contain

maximum 5

characters ; the

special character

'+' is authorized.

0-1

telephone

String: phone

number

entered by

the supplier

varcha

r(15)

Contains 15

alphanumerical

characters. The

character

<espace> is

forbidden.

0-1

indicatifPay

sFax

String: fax

dialling code

of the user

varcha

r(5)

Could contain

maximum 5

characters ; the

special character

'+' is authorized.

0-1

fax

String: fax

number

entered by

the user

varcha

r(15)

Contains 15

alphanumerical

characters. The

character

<espace> is

forbidden.

0-1

Parameters

parametres

1

dateDebutV

alidite

String:

Activation Date

Date field: AAAA-

MM-JJ 1

385 / 557


date of the

service

ou AAAA-MM-

JJTHH:MM:SS+HH

:MM

dateFinVali

dite

String: date

when the

status of the

service

becomes

inactive

Date

Date field: AAAA-

MM-JJ

or AAAA-MM-

JJTHH:MM:SS+HH

:MM

0-1

numeroEng

agement

Boolean:

commitment

number

required or

not

boolea

n

Only for public

structures.

- True: the

commitment

number is

required.

- False: the

commitment

number is not

required.

0-1

Output table


idService



system

integer



CPP 2017 structure

1

Error table


20000 GCU_MSG_05.029 - The identifier does not


20001

GCU_MSG_05.009 - The user is not

registered in the CPP 2017 system or is not

active.

GCU_MSG_05.009

20002 GCU_MSG_00.019 - The user is not primary

or secondary manager of the structure. GCU_MSG_00.019

20003 The postal code is required. GCU_MSG_05.019

20005

The value entered in the field [Indicatif] of

the phone number must be maximum 5-

character long. The character '+' is allowed

for the first position.

TRA_MSG_08.001

20006

Phone number format incorrect: it must

begin with the number '0' or be 9-character

long

TRA_MSG_08.003

20007 Phone number format incorrect: it must be

9-character long TRA_MSG_08.004

20008


the fax number must be maximum 5-



TRA_MSG_08.002

386 / 557


20009

TRA_MSG_08.005 - Fax number format

incorrect: it must begin with the number '0'

or be 9-character long

TRA_MSG_08.005

20010 Fax number format incorrect: it must be 9-

character long TRA_MSG_08.006

20011 The country code is not referenced. TRA_MSG_00.018

20012 Incorrect format in the field {0}

{0} = [name of the field]

20013 The identifier does not correspond to a valid


20014 The service already exists. GCU_MSG_100.000_1

20015 Technical error.

387 / 557


2.4.3.5 Delete structure service

The method supprimerServiceStructure allows to delete a service from a structure

Input table



Service

providing the

data

Multiplicity

idStructure

Technical

identifier of the

structure in the

CPP 2017

system

integer

This identifier



CPP 2017 system.

Required :

IdStructure

OR


ure +


RechercherStr

ucture 0-1


Identifier type

of the structure

varchar(

50)

Enumeration

TypeIdentifiant

Required:

IdStructure

OR


ure +


RechercherStr

ucture 0-1


Functional

identifier of the

structure

varchar(

18)

Alphanumeric value

Required:

IdStructure

OR


ure +


RechercherStr

ucture 0-1

idService

Technical

identifier of the

service in the

CPP 2017

system

integer

This identifier



2017 system.

RechercherSer

vicesStructure 1

paramInitialiserModifierServiceStructure

0-1

pageResul

tatDeman

dee

Number of the

result page to

be displayed



nbResultat

sParPage

Number of

results per

page that can

integer

By default, the

service returns 10

results per page.

0-1

388 / 557


be returned by

the research


10)


possible values:

- ascending sorting

- downward sorting

By default, the


0-1

triColonne

Reference

column of the

sorting

-








0-1

Output table


parametresRet

our 0-1



pages

Number of pages

returned by the

research

integer 0-1

nbResultatsParPag

e

Number of


total

Number of

results returned

by the research

integer 0-1

listeServices List 0-n

idService

Technical

identifier of the

service in the

CPP 2017

system

integer




1

389 / 557


codeService Service code varchar(



service

varchar(

100) 1

dateDbtService

Beginning date

of the service

activation period


HH:MI 1

dateFinService

End date of the

service

activation period


HH:MI 0-1

estActif

Flag indicating

whether the

service is active

or not, according

to its end date of

activation period

boolean


activation period is not

entered, then the parameter

"Actif" is filled with "true".If

the end date of the

activation period is earlier

than the current date, then

"Actif" is filled with the

value "false".

If not, "Actif" is filled with

the value "true".

1

Error table


20000 GCU_MSG_05.029 - The identifier {0}

does not correspond to a valid structure.


GCU-CU-100-SER-05 Supprimer un

service d’une structure [Delete a

service of a structure]

20001 GCU_MSG_00.019 - The user {0} is not

primary or secondary manager of the

structure {1}.






20002 GCU_MSG_100.009 - There is no service,

active or not, corresponding to the code

{1} which exists in the structure whose

identifier is {0}.


{1} = [service code]




20003 GCU_MSG_100.006 - A payment request

or a draft statement is processing on this

service {0}. Thus, it cannot be deleted.

{0} = [name of the service]




20004 Please enter a technical identifier or a


structure.

GCU_MSG_00.060

390 / 557



identifier {0}.

GCU_MSG_100.001

{0} = functional or technical identifier

391 / 557


2.4.4 Manage my user account


- Consult user account

- Ask my user account subscriptions

- List structure connections user

- Modify user by manager

- Search valid users

- Retrieve my user account subscriptions

- Retrieve my user account connections

- Delete my user account subscriptions

- Delete my user account structure connections

2.4.4.1 Consult user account

The method consulterCompteUtilisateur allows to consult the user account information

Input table



Service

providing the

data

Multiplicity

utilisateur 1

adresseE

mailConne

xionUtilisa

teur

Corresponding

to the login

email address

entered by the

user

varchar(

200)

Required:

AdresseEmailConnexi

onUtilisateur

OR

IdUtilisateur

RechercherUtili

sateurValide 0-1

idUtilisate

ur

Technical

identifier of the

user within the

CPP 2017

system

integer

This identifier



CPP system

Required:

AdresseEmailConnexi

onUtilisateur

OR

IdUtilisateur

RechercherUtili

sateurValide 0-1

Output table


idUtilisateur


the user in the CPP

system

integer 1

392 / 557


nom Name of the user varchar(100) 0-1

prenom Surname of the user varchar(100) 0-1

statutUtilisateur

Status of the user varchar(30) Enumeration

"etatCompteFo" 1

adresseEmailConnexion

Login email address varchar(200) 1

langue Language selected by

the user varchar(2) 1

recevoirDesNotifications

booleen true: Oui

false: Non 0-1

adresseEmail

Contact Contact email address varchar(200) 0-1

dateHeureCreation

Creation date and

time of the the

account

date 0-1

indicatifTelephone

International dialling

code varchar(5) 0-1

telephone Phone number varchar(15) 0-1

indicatifFax Fax dialling code varchar(5) 0-1

fax Fax number varchar(15) 0-1

adressePostale

0-1

393 / 557


adresse Address varchar(100) 0-1

complementAd

r1

First complement of

the postal address varchar(100) 0-1

complementAd

r2

Second complement

of the postal address varchar(100) 0-1

codePostal Postal code varchar(10) 0-1

ville City varchar(50) 0-1

pays Country varchar(2) 0-1

Error table


20000 The following fields are required: {0} GCU_MSG_05.019

{0}= labels of the required fields

20001 The user {0} concerned by the action

does not exist.

GCU_MSG_00.056


user] or [identifier of the user]

20002 The user {0} does not have the

necessary clearances to perform this

action.

TRA_MSG_00.028


394 / 557


2.4.4.2 Ask my user account subscriptions

The method demanderAbonnementsMonCompteUtilisateur allows to create one or several subscriptions requests to

areas added to the structure by a manager. If the user is manager of the structure or the service and/or if the area

is OPEN, the subscription request is automatically validated.

For information, the technical identifier of the area contains the authorization (consultation or modification) granted

by the user for this area.

Input table



Service

providing the

data

Multiplicity

structure 1

idStructur

e

Technical

identifier of the

structure in the

CPP 2017

system

integer

This identifier



CPP 2017 system.

Required :

IdStructure

OR


ure +


RechercherStr

ucture 0-1

typeIdenti

fiantStruct

ure

Identifier type

of the structure

varchar(

50)

Enumeration

TypeIdentifiant

Required:

IdStructure

OR


ure +


RechercherStr

ucture 0-1

identifiant

Structure

Functional

identifier of the

structure

varchar(

80)

Alphanumeric value

Required:

IdStructure

OR


ure +


RechercherStr

ucture 0-1

listeAbonnement

1-n

idService

Technical

identifier of the

concerned

service

integer RechercherEsp

aces 1

395 / 557


idEspaceF

o

Technical

identifier of the

selected area

integer RechercherEsp

aces 1

commentaire

Motivated

comments for

the

subscription

request

varchar

(255) 0-1

Output table


listeAbonnement 1-n

idAbonnement


of the subscription

in the CPP 2017

system

integer 1

Error table


20000 The user {2} is not registered in the CPP

2017 system or is not {3}

GCU_MSG_05.009


{3}= ACTIF (EtatCompteFO reference

table) [ACTIVE]

20001

Subscription request impossible:

the identifier {0} does not correspond to

a valid structure.

GCU_MSG_05.029


20002

Subscription request impossible:

The service {0} is unknown for the

structure {1}.

GCU_MSG_05.030



20003 Subscription request impossible:

the area {0} is not allowed.

GCU_MSG_05.028

{0}=identifier of the area

20004



structure.



structure {1}. GCU_MSG_00.024


service {2} of the structure {1}. GCU_MSG_00.025

396 / 557


2.4.4.3 List structure connections user

The method ListerRattachementsStructureUtilisateur retrieves the information needed for the connections requests

process form for a user and a structure.

Input table



Service

providing the

data

Multiplicity

adresseEmailConnexionUtilisateur

String:

corresponding

to the email

address of the

user within the

CPP 2017

system,

concerned by

the

deactivations

and activations

of connections

to the structure

by the system

varchar(

200)


identifies a user within


Required:

AdresseEmailConnexionU

tilisateur

OR

IdUtilisateur

RechercherUtili

sateursValides 0-1

idUtilisateur

Number:

technical

identifier of the

user within the

CPP 2017

system,

concerned by

the

deactivations

and activations

of connections

to the structure

by the system

integer



the 2017 CPP system

Required:

AdresseEmailConnexionU

tilisateurSelectionne

OR

IdUtilisateur

RechercherUtili

sateurValide 0-1

idStructure

Number:

technical

identifier of the

structure in the

CPP 2017

system

integer


identifies a structure

within the CPP 2017

system.

Required :

IdStructure

OR


+ IdentifiantStructure

RechercherStru

cture 0-1


String:

identifier type

of the structure

varchar(

50)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

RechercherStru

cture 0-1

397 / 557


- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

-

EN_COURS_IMMATRICU

LATION

Required:

IdStructure

OR




String:

functional

identifier of the

structure

varchar(

80)

Alphanumeric value

Required:

IdStructure

OR



RechercherStru

cture 0-1


parametresListerRattachementsStructureUtilisateur

pageResul

tatDeman

dee

Number:

number of the

result page to

be displayed


first page. 0-1

nbResultat

sParPage

Number:

number of

results per

page that can

be returned by

the research




order

varchar(

10)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

String:

reference

column of the

sorting

-


values:

- CodeService

- NomService

- StatutRattachement



"NomService".

0-1

398 / 557


Output table



Service

providing the

data

Multiplicity

parametresRetour

pageCour

ante

Number:

number of the

current page

integer 1

pages

Number:

Number of

pages returned

by the research

integer 1

nbResultat

sParPage

Number:

number of

results per

page

integer 1

total

Number:

Number of

results

returned by the

research

integer 1

Structure to connect

idStructure

Number:

technical

identifier of the

structure in the

CPP 2017

system

integer



within the CPP 2017

system.

1


String:

functional

identifier of the

structure

varchar(

80)




2017 structure

1

designationStructure

String:

designation of

the structure

varchar(

201)


characters which

corresponds to the


structure or the



0-1

premierService

boolean: the

user is

connected or

not to the first

service of the

structure

boolean

True: the user is

connected to the first

service of the structure.

False: the user is not

connected to the first

service of the structure.

1

List of the structure’s services

399 / 557


listeServices

idService

Number:

technical

identifier of the

service in the

CPP 2017

system

integer


identifies a service

within the CPP 2017

system.

1 integer

idRattache

ment

Number:

technical

identifier of the

connection

request in the

CPP 2017

system

integer


identifies a connection

request within the CPP

2017 system.

0-1 integer

codeServi

ce

String: service

code

varchar(

100) 1

varchar(1

00)

nomServic

e

String: name

of the service

varchar(

100) 1

varchar(1

00)

statutRatt

achement

String: status

of the

connection

request

varchar(

50)

Enumeration with 5

possible values:

-

EN_COURS_DE_VALIDAT

ION

- REFUSEE

- VALIDEE

- DESACTIVEE

- SUPPRIMEE(LOGIQUE)

[DELETED (LOGICAL)]

0-1 varchar(5

0)

dateDebut

String:

beginning date

of the

connection

validity period


JJTHH:MM:SS+HH:MM 0-1 date

dateFin

String: end

date of the

connection

validity period


JJTHH:MM:SS+HH:MM 0-1 date

commenta

ire

String:

comment on

connection

varchar(

255) 0-1

varchar(2

55)

400 / 557


Error table




20001 The user does not exist or is not valid. GCU_MSG_00.009

20002 The user {0} is not registered in the application.

GCU_MSG_00.008 {0} = Name and surname of the user

20003 The user {0} is not connected to the structure {1}

GCU_MSG_00.050 {0} = Name and surname of the user {1} = identifier of the structure

20004 No structure found for this identifier {0} or the structure has already been duplicated.

GCU_MSG_00.050 {0} = identifier

20005 A technical or functional identifier is required for the user.

GCU_MSG_00.057

20006 Please enter a technical identifier or a type and a functional identifier of a structure.

GCU_MSG_00.060

20007 The technical and functional identifiers do not correspond to each other.

GCU_MSG_00.059

401 / 557


2.4.4.4 Modify user by manager

The method modifierUtilisateurParGestionnaire allows a manager to modify the information of a user who is connected

to one the structures managed by him

Input table



Service

providing

the data

Multiplicity

information

sGenerales 1

adresseElect

roniqueConn

exion

String: login email

address

varchar

(200)

This data is unique in the

CPP 2017 system.


the format of the datat is:



@ » + EITHER IP OR string

of characters (without

special ones) + « . » + 2

characters (minimum,

without special ones)

1

adresseElect

roniqueCont

act

String: contact email

address of the

supplier

varchar

(200)

If the contact email address

is not entered, then the

login email address will be

used as contact email

address for the issued

emails.

0-1

nom String: name of the

user

varchar

(100) 1

prenom String: surname of

the user

varchar

(100) 1

Postal address

adressePos

tale 1

adresse String: details of the

supplier address

varchar

(100) 1

complement

Adresse1

String: first

complement of the

address

varchar

(100) 0-1

complement

Adresse2

String: second

complement of the

address

varchar

(100) 0-1

ville String: city of the

supplier address

varchar

(50) 1

codePostal

String: postal code

of the supplier

address

varchar

(10)

Required if the country is

entered and whose code is

"FR"

0-1

402 / 557


pays

String: country code

of the supplier

address

varchar

(2)

The data must be

referenced in the reference

table of the countries. The

value of the fiel dis

controlled.

RecupererPays

0-1

indicatifPays

Telephone

String: international

dialling code of the

user phone number

varchar

(5)

The phone number is


- The international

dialling code : 5

alphanumeric

characters, including

‘+’ ;

- The phone number :

15 alphanumeric

characters. The

character <space> is

forbidden.


France, then the

international dialling code is

pre-entered with the value


changed. If another country

is selected, the user can

enter the wished value with

5 characters allowed..

0-1


number of the user

varchar

(15) 0-1

indicatifPays

Fax

String: fax dialling

code of the user

varchar

(5)

The fax number is


- The fax dialling

code : 5

alphanumeric

characters, including

‘+’ ;

- The fax number : 15

alphanumeric

characters. The

character <space> is

forbidden.


France, then the fax dialling

code is pre-entered with

the value « +33 » and it

cannot be changed. If

another country is selected,

the user can enter the

wished value with 5

characters allowed.

0-1

fax String: fax number

of the user

varchar

(15) 0-1

Output table


403 / 557


idUtilisateurModifi

e

Number: technical identifier of

the user, which has just been

modified in the CPP 2017

system

integer



system

1

Error table


20000

This connection address does not

correspond to any identified user in the CPP

2017 system.

GCU_MSG_01_019

20002 The contact email address contains

unauthorized characters. TRA_MSG_09.004

20005


the fax number must be maximum 5-



TRA_MSG_08.002

20006


the phone number must be maximum 5-



TRA_MSG_08.001

20007

Phone number format incorrect: it must

begin with the number '0' or be 9-character

long

TRA_MSG_08.003

Only if the selected country is France.

20008 Phone number format incorrect: it must be

9-character long

TRA_MSG_08.004


20009 Fax number format incorrect: it must begin

with the number '0' or be 9-character long

TRA_MSG_08.005


20010 Fax number format incorrect: it must be 9-

character long

TRA_MSG_08.006


20012

The current user is not primary or

secondary manager of a structure to which

the user to modify is trying to connect.

GCU_MSG_01_024

Only if idUtilisateurCourant is different from

idUtilisateurSelectionne

20013 The user status does not allow to modify

his informations. GCU_MSG_01_021

404 / 557


- Search valid users

The method RechercherUtilisateursValides checks if there is at least one valid user corresponding to one of the 7

registered parameters. If the user matches, the user informations are returned.

Input table



Service

providing the

data

Multiplicity

identifiantDeConnexion

String:

connection

identifier of the

researched

user

varchar(

200)

The connection identifier

is unique in the CPP

2017 system.

This data is

AdresseElectroniqueCon

nexion or the PIGP

identifier.

Required: at least one of

the 7 parameters must

be entered (connection

identifier, name,

surname, postal code,

address, city, country)

0-1

nom

String: name

of the user

researched

varchar(

100)

String: name of the user




identifier, name,



0-1

prenom

String:

surname of the

researched

user

varchar(

100)

String: user surname




identifier, name,



0-1

codePostal

String: postal

code of the

researched

user

varchar(

10)

String: postal code of

the user address




identifier, name,



0-1

adresse String: postal

address

varchar(

200)

String: postal address




identifier, name,



0-1

405 / 557


ville

String: city of

the researched

user

varchar(

50)

String: city of the suer

address




identifier, name,



0-1

pays

String: country

of the

researched

user

varchar(

2)

String: country code of

the user address




identifier, name,



RecupererPays 0-1

idStructure

Number:

technical

identifier of the

structure in the

CPP 2017

system

integer



within the CPP 2017

system.

Required :

IdStructure

OR



RechercherStru

cture 0-1


String:

identifier type

of the structure

varchar(

50)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

-

EN_COURS_IMMATRICU

LATION

Required:

IdStructure

OR



RechercherStru

cture 0-1


String:

functional

identifier of the

structure

varchar(

80)

Identifier of the current

structure to which the

user is trying to connect.

Required:

IdStructure

OR

RechercherStru

cture 0-1

406 / 557




Paging

parametresRechercherUtilisateursValides

pageResul

tatDeman

dee

Number:

number of the

result page to

be displayed


the first page. 0-1

nbResultat

sParPage

Number:

number of

results per

page that can

be returned by

the research

integer



page.

0-1


order

varchar(

10)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

String:

reference

column of the

sorting

-


following possible

values:

- Nom

- Prenom

- StatutUtilisateur



"Nom".

0-1

407 / 557


Output table


te Typing (tagger) Format

Management

rules

Service

providing the

data

Multiplicity

parametresRetour

pageCour

ante

Number:

number of the

current page

integer 1

pages

Number:

Number of

pages returned

by the research

integer 1

nbResultat

sParPage

Number:

number of

results per

page

integer 1

total

Number:

Number of

results

returned by the

research

integer 1


listeUtilisateurs

0-n

idUtilisate

ur

Number:

technical

identifier of the

user in the CPP

system

integer 0-1

nom String: name

of the user varchar(100) 0-1

prenom

String:

surname of the

user

varchar(100) 0-1

statutUtili

sateur

String: Status

of the user

Enumeration with 4

possible values:

EN_COURS_DE_VAL

IDATION

EN_COURS_D_ACTI

VATION

ACTIF

BLOQUE

0-1

408 / 557


Error table





20001 At least one of the research criteria must be entered.

TRA_MSG_00.011

20002 Please enter a technical identifier or a type and a functional identifier of a structure.

GCU_MSG_00.060

20003 The identifier of the structure does not correspond to a valid structure.

GCU_MSG_100.001

409 / 557


2.4.4.5 Search for valid users

The method rechercher UtilisateursValides checks if one or several valid user(s) correspond to at least one of the 7 parameters. If such a user exist, then his/theirs informations are returned.

Input table



Service

providing the

data

Multiplicity

identifiantDeConnexion

String : login

identifier of the

researched

user

Varchar(

200)

The login identifier is

unique in the CPP 2017

system. It is the value of

AdresseElectroniqueCon

nexion or the PIGP

identifier.

Required : one of the 7

criteria must be entered

(login identifier, name,



0-1

nom

String: name

of the

researched

user

Varchar(

100)

String: name of the user






0-1

prenom

String:

surname of the

researched

user

Varchar(

100)

String: surname of the

user






0-1

codePostal

String : postal

code of the

researched

user

Varchar(

10)

String: postal code of

the user address






0-1

address String: postal

address

Varchar(

200)

String: postal address of

the user




0-1

410 / 557




city

String: city of

the researched

user

Varchar(

50)

String: city of the user

address






0-1

country

String: country

of the

researched

user

Varchar(

2)

String: country code of

the user address






recuoererPays 0-1

idStructure

Number:

technical

identifier of the

structure in the

CPP 2017

system

Integer



within the CPP 2017

system.

Required :

idStructure

OR


+ identifiantStructure

rechercherStru

cture 0-1


String:

identifier type

of structure

Varchar(

50)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANC

E

- PARTICULIER

- EN_COURS_IMMA

TRICULATION

Required :

idStructure

OR

typeIdentifiantStructure + identifiantStructure

rechercherStru

cture 0-1


String:

functional

identifier of

structure

Varchar(

80)

Identifier of the current

structure to which the

user is going to be

connected.

Required :

rechercherStru

cture 0-1

411 / 557


idStructure

OR


+ identifiantStructure

Pagination

parametresRe chercherUtilis

ateursValides

pageResul

tatDeman

dee

Number:

number of the

result page to

be displayed

Integer By default, the service

returns the first page. 0-1

nbResultat

sParPage

Number:

number of

results per

page

Integer



page.

0-1


order

Varchar(

10)

Enumeration with 2

possible values:

- Ascending

- Downward

By default, the sorting is downward.

0-1

triColonne String: sorted

column -

Enumeration with 3

possible values:

- Name

- Surname

- statutUtilisateur

By default, the sorting is performed on the field “Nom” [Name].

0-1

Output table


parametresRetour


current page integer 1

pages

Number of pages

returned by the

research

integer 1

nbResultatsParPa

ge

Number of

results per page integer 1

total

Number of

results returned

by the research

integer 1

412 / 557



listeUtilisateurs 0-n

idUtilisateur

Number :

technical

identifier of the

user in the CPP

2017 system

integer 0-1

nom String : name of

the user Varchar(100) 0-1

prenom String : surname

of the user varchar(100) 0-1

statutUtilisateur String : status of

the user

Enumeration

with 4 possible

values :

EN_COURS_DE

_VALIDATION

EN_COURS_D_

ACTIVATION

ACTIF

BLOQUE

0-1

Error table


2000 Successful request.

400 Erroneous request.

20000 No result found. TRA_MSG_00.012

20001 At least one of the research criteria must

be filled. TRA_MSG_00.011

20002 Please indicate a technical identifier of structure or a identifier type and a functional identifier of structure.

GCU_MSG_00.060

20003 The structure identifier does not correspond to any valid structure.

GCU_MSG_100.001

413 / 557


2.4.4.6 Retrieve my user account subscriptions

The method recupererAbonnementsMonCompteUtilisateur allows to list every service associated to the structure to which the user is connected and to identify every one of them to which the user has subscribed.

Input table



Service

providing the

data

Multiplicity

parametresRecherche

0-1

pageResul

tatDeman

dee

Number of the

result page to

be displayed


the first page. 0-1

nbResultat

sParPage

Number of

results per

page that can

be returned by

the research

integer



page.

0-1


10)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

Reference

column of the

sorting

-


attributes’ names of the

results’ list. By default,

the sorting order is

performed on the first

attribute of the results’

list.

0-1

Output table


parametresRetour



pages

Number of pages

returned by the

research

integer 0-1

414 / 557


nbResultatsParPa

ge

Number of


total

Number of

results returned

by the research

integer 0-1

listeEspaces 0-n

idAbonnement

Technical

identifier of the

subscription in

the CPP 2017

system

integer 1

idStructure

Technical

identifier of the

structure

integer 1

identifiantStructu

re

Identifier of the

structure varchar(18) 1

typeIdentifiantSt

ructure

Identifier type of

the structure varchar(14) 1

designationStruc

ture

Designation of

the structure varchar(201) 1

idService

Technical

identifier of the

service in the

CPP 2017

system

integer 1

codeService

libelleService

Name of the

structure’s

service

varchar(100)

This field can remain

empty if the structure has

no service.

0-1

idEspace

Technical

identifier of the

area in the CPP

2017 system

integer 1

codeEspace

libelleEspace

Label of the area

associated to the

entity’s service

varchar(255) 1

415 / 557


statutAbonneme

nt

Current status of

the subscription varchar(15) 1

typeHabilitation

Type of

authorized

clearances on

this area

varchar(50) 1

Error table


20000 The user {2} is not registered in the CPP 2017 system or is not {3}

GCU_MSG_05.009

{2}=Name and surname of the user {3}= ACTIF (EtatCompteFO reference table) GCU-CU-05-SER-17 Supprimer un abonnement à un espace [Delete an area’s subscription]

20001 The user is not registered in the Chorus Pro system.

GCU_MSG_05.015

416 / 557


2.4.4.7 Retrieve my user account connections

The method recupererRattachementsMonCompteUtilisateur allows to search the structures to which the user has at

least one activ connection

Input table



Service

providing the

data

Multiplicity

parametresRecherche

0-1

pageResul

tatDeman

dee

Number of the

result page to

be displayed


the first page. 0-1

nbResultat

sParPage

Number of

results per

page that can

be returned by

the research

integer



page.

0-1


10)


possible values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

Reference

column of the

sorting

-


attributes’ names of the

results’ list. By default,

the sorting order is

performed on the first

attribute of the results’

list.

0-1

Output table

Attribute Subattribute Sub-


parametresRetour



pages

Number of

pages returned

by the research

integer 0-1

nbResultatsP

arPage

Number of

results per

page

integer 0-1

417 / 557


total

Number of

results

returned by the

research

integer 0-1

listeStructureRattachement

Liste 0-n

idStructure

Technical

identifier of the

structure

within the CPP

2017 system

integer 1

typeIdentifian

tStructure

Identifier type

of structure varchar(50) 1

identifiantStr

ucture

Identifier of the


designationSt

ructure

Designation of

the structure

varchar(201

) 0-1

statutUtilisate

ur

Status of the

user varchar(30) 1

roleUtilisateur

User role

within the

structure

varchar(30) 0-1

statutRattach

ementStructu

re

Connection

status varchar(25) 1

idRattacheme

ntStructure

Technical

identifier of the

connection

request in the

CPP 2017

system

integer 1

listeServicesR

attache

List of the

services to

which the user

is connected ;

the default

service is not

returned.

0-n

IdService 1

CodeService

Code of the

structure’s

service

varchar(100

)

Alphanumeric

value 0-1

418 / 557


LibelleService

Name of the

structure’s

service

varchar(100

)

Alphanumeric

value 0-1

StatutService

Status of the

structure

service

varchar(10) 0-1

DateDbtService

Beginning date

of the service

activation

period


MM-JJ HH:MI 0-1

DateFinService

End date of the

service

activation

period


MM-JJ HH:MI 0-1

EstActif

Flag indicating

whether the

service is

active or not,

according to its

end date of

activation

period

boolean

If the end date of

the activation

period is not

entered, then the

parameter "Actif"

is filled with

"true".If the end

date of the


earlier than the

current date, then


the value "false".

If not, "Actif" is

filled with the

value "true".

1

StatutRattache

mentService

Connection

status varchar(25) 1

IdRattachemen

tService

Technical

identifier of the

connection

request in the

CPP 2017

system

integer 1

Error table


20000 The parametered user does not exist or is not valid.

GCU_MSG_05.028

419 / 557


2.4.4.8 Delete my user account subscriptions

The method supprimerAbonnementsMonCompteUtilisateur allows to delete the user’s subscription to an area. The deleted subscription is now with the « DESACTIVE » (deactivated) status.

Input table



Service

providing the

data

Multiplicity

idAbonnement

Technical

identifier of the

subscription in

the CPP 2017

system

integer

RecupererAbon

nementsMonCo

mpteUtilisateur

1

Output table



Error table


20000 Impossible unsubscription: the subscription does not exist for the user {2}

GCU_MSG_05.033 {2} = Name and surname of the user GCU-CU-05-SER-17 Supprimer un abonnement à un espace [Delete an area’s subscription]

20001 The user {2} is not registered in the CPP

2017 system or is not {3}

GCU_MSG_05.009 {2}=Name and surname of the user {3}= ACTIF (EtatCompteFO reference

table) GCU-CU-05-SER-17 Supprimer un abonnement à un espace [Delete an area’s subscription]

420 / 557


2.4.4.9 Delete my user account structure connections

The method supprimerRattachStructureMonCompteUtilisateur allowd to delete all the user’s connections from a given structure

Input table



Service

providing the

data

Multiplicity

structure 1

idStructur

e

Technical

identifier of the

structure in the

CPP 2017

system

integer



within the CPP 2017

system.

Required :

IdStructure

OR



RechercherStru

cture 0-1

typeIdenti

fiantStruct

ure

Identifier type

of structure varchar(50)

Enumeration

TypeIdentifiant

Required:

IdStructure

OR



RechercherStru

cture 0-1

identifiant

Structure

Functional

identifier of the

structure

varchar(80)

Alphanumeric value

Required:

IdStructure

OR



RechercherStru

cture 0-1

Output table

Attribute Subattribute Sub-


421 / 557


Error table


20000 The connection request does not exist.

GCU_MSG_05.001

GCU-CU-05-SER-15 Supprimer un rattachement à une Structure [Delete a connection to a structure]

20001 Connection deletion refused: the user {0} is the primary manager of the structure

GCU_MSG_05.027 {0}=Name and surname of the user asking for deletion of the connection to a structure

GCU-CU-05-SER-15 Supprimer un rattachement à une Structure [Delete a connection to a structure]

20002 The user is not registered in the CPP2017 system.

GCU_MSG_05.015 GCU-CU-05-SER-01 vérifier si l’utilisateur existe dans CPP [check if the user exists in the CPP 2017 system]

20003 The user {2} is not registered in the CPP 2017 system or is not {3}

GCU_MSG_05.009 {2}=Name and surname of the user {3}= ACTIF (EtatCompteFO reference table) GCU-CU-05-SER-15 Supprimer un rattachement à une Structure [Delete a connection to a structure]

20004 Please enter a technical identifier or a type and a functional identifier of a

structure.


20005 No active structure corresponds to the identifier {0}.


422 / 557


2.4.5 Manage connections and subscriptions

This chapter indicates the input, output and error tables for the following methods:

- Activate or deactivate the user connections to a structure

- Search for the standby subscription requests by manager

- Search for the standby connection requests by manager

- Delete a user connected to a structure

- Validate subscription requests by manager

- Validate user connection

- Retrieve services for standby connection requests

- Refuse subscription requests by manager

2.4.5.1 Activate or deactivate the user connection to a structure

The method ActiverOuDesactiverRattachementsDunUtilisateurAUneStructure deactivate all the connections «

EN_COURS_DE_VALIDATION» or « VALIDEE » of a user to the services of a selected structure, OR reactivate all

the connections « DESACTIVEE » of a user to the services of a selected structure.

Input table

Attribute Subattribute Typing (tagger) Form

at Management rules

Service providing

the data

Multiplic

ity

idStructure

Number: technical

identifier of the


2017 system

intege

r

This technical

identifier uniquely

identifies the


CPP 2017 structure

Required:

IdStructure

OR


ure +


RechercherStruct

ure 0-1

typeIdentifian

tStructure String: identifier type

of structure

varch

ar(50

)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

-

EN_COURS_IMMATR

ICULATION

Required:

IdStructure

OR


ure +


RechercherStruct

ure 0-1

423 / 557


identifiantStru

cture

String: functional identifier of the structure

varch

ar(80

)

Alphanumeric value

Required:

IdStructure

OR


ure +


RechercherStruct

ure 0-1

idUtilisateurSe

lectionne

Number: technical identifier of the user within the CPP 2017 system, concerned by the deactivations and activations of connections to the structure by the system

intege

r

This identifier

uniquely identifies

the user within the

2017 CPP system

Required:

AdresseEmailConnex

ionUtilisateurSelectio

nne

OR

IdUtilisateurSelectio

nne

RechercherUtilisa

teurValide 0-1

adresseEmailC

onnexionUtilis

ateurSelection

ne

String: corresponding to the login email address entered by the user requesting the subscription

varch

ar(20

0)

This identifier

uniquely identifies

the user within the

2017 CPP system

Required:

AdresseEmailConnex

ionUtilisateurSelectio

nne

OR

IdUtilisateurSelectio

nne

RechercherUtilisa

teurValide 0-1

nouvelEtatRat

tachement

String: new status requested by the

manager for all the connections

varch

ar(15

)

Enumeration with 2

possible values:

- VALIDE

- DESACTIVE

The status VALIDE

allows to activate

the connections, the

status DESACTIVE

allows to deactivate

the connections.

1

commentaire

String: comment or reason associated to the activation or deactivation of a connection.

varch

ar(25

5)

Comment or reason

associated to the

activation or

deactivation of a

connection.

0-1

Output table


Error table

424 / 557





20000 GCU_MSG_04.002 - The user {0} does not

correspond to any active user.

{0} = [User email address]

GCU-CU-04-SER-09

Désactiver/Réactiver le rattachement

d’un utilisateur à une structure

[Deactivate/reactivate the user

connection to a structure]

20001 GCU_MSG_04.007 - No active structure

corresponds to the identifier {0}.


GCU-CU-04-SER-09





20002

GCU_MSG_04.011 - The current user {0} is

not primary or secondary manager of the

structure {1}.



GCU-CU-04-SER-09





20003

GCU_MSG_04.013 - Impossible deactivation

The user {3} cannot be the primary

manager of the structure {2}.

{3} = [user to deactivate]


GCU-CU-04-SER-09





20004

GCU_MSG_04.016 - There is not any

connection to deactivate between the user

(3) and the structure (2).

{3} = [user to reactivate]


GCU-CU-04-SER-09





20005

GCU_MSG_04.015 - There is not any

connection to validate between the user (3)

and the structure (2).

{3} = [user to deactivate]


GCU-CU-04-SER-09





20006

GCU_MSG_00.048 - The technical user or

developper of a structure cannot be deleted

or deactivated.

GCU-CU-04-SER-09





20007 GCU_MSG_00.056 - The user {0}

concerned by the action does not exist. {0} = [user email address]

425 / 557


20008 GCU_MSG_00.057 - A technical or

functional identifier is required for the user.

20009

GCU_MSG_00.059 - The technical and

functional identifiers do not correspond to

each other.

20010

GCU_MSG_00.060 - Please enter a

technical identifier or a type and a

functional identifier of a structure.

2.4.5.2 Search for standby subscription requests by manager

The method rechercherDemandeAbonnementEnAttenteParGestionnaire allows to retrieve the necessary data for

processing formular, by a manager, of the subscription requests of a structure (optional).

Input table



Service

providing the

data

Multiplicity

structure 0-1

idStructur

e

Technical

identifier of the

structure in the

CPP 2017

system

integer

Required:

IdStructure

OR


ure +


RechercherStr

ucture 0-1

typeIdenti

fiantStruct

ure

Identifier type

of structure

varchar(

50)

Enumeration

TypeIdentifiant

Required:

IdStructure

OR


ure +


RechercherStr

ucture 0-1

identifiant

Structure

Functional

identifier of the

structure

varchar(

80)

Required:

IdStructure

OR


ure +


RechercherStr

ucture 0-1

parametresRecherche

0-1

pageResul

tatDeman

dee

Number of the

result page to

be displayed



nbResultat

sParPage

Number of

results per

page that can

integer

By default, the

service returns 10

results per page.

0-1

426 / 557


be returned by

the research


10)


possible values:

- ascending sorting

- downward sorting

By default, the


0-1

triColonne

Reference

column of the

sorting

-








0-1

Output table


Subattribute Typing (tagger) Format

Management

rules Multiplicity

parametresRe

tour



pages

Number of pages

returned by the

research

integer 0-1

nbResultatsPar

Page

Number of


total

Number of

results returned

by the research

integer 0-1

listeDemandesAbonnement

0-1

listeEspace

427 / 557


idAbonnement

Technical

identifier of the

subscription, i.e.

the link between

the area, the

structure and the

user in the CPP

2017 system

integer 1

libelleEspace

Label of the area

targeted by the

subscription

varchar(2

55) 1

typeHabilitatio

n

Type of

authorized

clearances on

this area

varchar(5

0)

Enumeration

"TypeHabilitation

"

1

StatutAbonnem

ent

Subscription

current status

varchar(3

0)

Enumeration

"EtatEspaceServi

ceCompteFo"

1

dateDemandeA

bonnement

Creation date of

the subscription

request

date

Date field:

AAAA-MM-JJ

HH:MI

1

idRattachemen

t

Number:

technical

identifier of the

connection

request in the

CPP 2017 system

integer

This identifier

uniquely

identifies a

connection

request within

the CPP 2017

system.

1

nomService Name of the

structure service

varchar(1

00) 1

idStructure

Number:

technical

identifier of the

structure within

the CPP 2017

system

integer

This technical

identifier

uniquely

identifies the

structure within

the CPP 2017

structure

1

identifiantStruc

ture

String:

functional

identifier of the

structure

varchar(8

0)

Alphanumeric

value 1

typeIdentifiant

Structure

String: identifier

type of the

structure

varchar(1

4)

Enumeration

"TypeIdentifiant" 1

428 / 557


designation

String:

designation of

the structure

varchar(2

01) 1

idUtilisateur

Technical

identifier of the

user in the CPP

system

integer 0-1

nom Name of the user varchar(1

00) 0-1

prenom Surname of the

user

varchar(1

00) 0-1

adresseEmailC

ontactUtilisateu

r

Contact email

address of the

user

varchar(2

00) 1

Error table



identifier {0}.

GCU_MSG_04.007


GCU-CU-04-SER-17 Lister les demandes

d’abonnement en attente sur une

structure pour un utilisateur [List the

standby subscription requests on a

structure for a user]

20001 The current user {0} is not primary or

secondary manager of the structure {1}.

GCU_MSG_04.011



GCU-CU-04-SER-17 Lister les demandes

d’abonnement en attente sur une

structure pour un utilisateur [List the

standby subscription requests on a

structure for a user]

20002



structure.


429 / 557


2.4.5.3 Search for the standby connection requests by manager

Le service RechercherDemandesRattachEnAttenteParGestionnaire searches for the connection requests whose statu

sis « En cours de validation » [under validation], linked to the services whose manager is the current user.

Input table

Attribute Subattribute Typing (tagger) Format Management rules Service providing

the data

Multiplic

ity

idStructure

Number: technical

identifier of the

structure within

the CPP 2017

system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

Optional:

IdStructure

OR


ure +


RechercherStruct

ure 0-1

typeIdentifian

tStructure String: identifier

type of structure

varchar(50

)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

-

EN_COURS_IMMATR

ICULATION

Optional:

IdStructure

OR


ure +


RechercherStruct

ure 0-1

identifiantStru

cture


varchar(80

)

Alphanumeric value

Optional:

IdStructure

OR


ure +


RechercherStruct

ure 0-1


parametresRechercherDemandesRattachEnAttenteParGestionnaire

0-1

430 / 557


pageResulta

tDemandee

Number: number of the result page to be displayed

integer

By default, the

output is the first

page.

0-1

nbResultats

ParPage

Number: Number of results per page that can be returned by the research

integer

By default, the

service returns 10

results per page.

0-1

triSens String: sorting order

varchar(10

)

Enumeration with


- ascending sorting

- downward sorting

By default, the


0-1

triColonne String: reference column of the sorting

-

Enumeration with 6

possible values:

-


-

DesignationStructure

-

NomPrenomDemand

eur

- CodeService

- NomService

- StatutService

By default, the


on the field

"DesignationStructur

e".

0-1

431 / 557


Output table


parametresRetour

pageCourant

e

Number: number

of the current

page

integer 0-1

pages

Number: Number

of pages returned

by the research

integer 0-1

nbResultatsP

arPage

Number: Number

of results per

page

integer 0-1

total

Number: Number

of results

returned by the

research

integer 0-1

List of the standby connection requests

listeDemandesRattachement

Liste 0-n

idStructure

Number:

technical

identifier of the

structure within

the CPP 2017

system

integer


identifies a structure within


1

typeIdentifia

ntStructure

String: identifier

type of structure

varcha

r(50)


values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

-

EN_COURS_IMMATRICULAT

ION

1

identifiantStr

ucture

String: identifier

of the structure

varcha

r(80) 1

designationS

tructure

String:

designation of

the structure

varcha

r(201)

The designation of a

structure depends on:

- Structure.raisonSociale if

this attribute is not empty

- the concatenated

Structure.nom and

Structure.prenom attributes

if Structure.raisonSociale is

empty.

1

idDemandeur

Number:

technical

identifier allowing

integer


uniquely identifies the user

who has requested the

1

432 / 557


to identify the

user who has

requested the

connection

connection within the CPP

2017 system.

nomDemand

eur

String: name of

the user who has

requested the

connection

varcha

r(255)

There is the name of the

user who has requested the

connection.

1

prenomDem

andeur

String: surname

of the user who

has requested

the connection

varcha

r(255)

There is the surname of the

user who has requested the

connection.

1

codeService

String: code of

the structure’s

service (if the

user has only

requested a

connection to a

single one service

in this structure)

varcha

r(100)

Alphanumeric value

This data is entered only if

the user has requested the

connection to a single one

service of this structure.

0-1

nomService

String: name of

the structure

service (if the

user has only

requested a

connection to a

single one service

in this structure)

varcha

r(100)

Alphanumeric value





0-1

statutService

String: status of

the structure

service (if the

user has only

requested a

connection to a

single one service

in this structure)

varcha

r(10)





0-1

idRattachem

ent

Number:

technical

identifier of the

connection

request in the

CPP 2017 system

integer




2017 system.

1

Error table




433 / 557



and a functional identifier of a structure. GCU_MSG_00.060

20001 Not any connection request corresponding

to the data found. GCU_MSG_04.001


identifier {0}. GCU_MSG_100.001

434 / 557


2.4.5.4 Delete user connected to structure

The method SupprimerUtilisateurRattacheStructure deletes all the connections selected and parametered among

the structures whose primary manager is the current user.

Input table


Service

providing the

data

Multiplicity

listeRattache

ment liste 1-n

idRattachem

ent

Number: list of the connection technical identifiers to delete

integer

This identifier

uniquely identifies

a connection

request within the

CPP 2017 system.

1

parametresSu

pprimerUtilisa

teurRattacheS

tructure

pageResulta

tDemandee

Number: number of

the result page to be displayed

integer

By default, the

output is the first

page.

0-1

nbResultats

ParPage

Number: number of results per page that can be returned by the research

integer

By default, the

service returns 6

results per page.

0-1

triSens String: sorting order varchar(

10)

Enumeration with

two possible

values:

- ascending

sorting

- downward

sorting

By default, the

sorting is

downward.

0-1

triColonne String: reference column of the sorting

-

Enumeration with 4

possible values:

-

TypeIdentifiantStru

cture

-


-

DesignationStructu

re

- Statut

Tri par défaut:


0-1

435 / 557


Output table


parametresRetour


the current page integer 1

pages

Number: Number of


research

integer 1

nbResultatsParPa

ge

Number: number of


total

Number: Number of

results returned by

the research

integer 1

listeStructures 0-n

idStructure

Number: technical

identifier of the


CPP 2017 system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

1

typeIdentifiantSt

ructure


of the structure varchar(14)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

1

identifiantStructu

re

String: functional

identifier of the

structure

varchar(80) 1

designationStruc

ture




of characters which

corresponds to the

corporate name of


concatenated name

and surname of its

deputy.

1

statut String: status of the


436 / 557


Error table




20001

Deactivation of the account refused: the

user {0} is not registered in the CPP 2017

system or is not {1}

GCU_MSG_05.009

20002

Deactivation of the account refused: the

user {0} is the primary manager of a

structure.

GCU_MSG_05.027


asking for the deletion of a connection to

a structure.

437 / 557


2.4.5.5 Validate subscription requests by manager

The method validerDemandesAbonnementParGestionnaire allows a manager to validate a subscription request of a

user who wants to connect to an area of a structure managed by this manager.

Input table


(tagger) Format

Management

rules

Service

providing the

data

Multiplicity


Number:

technical

identifier of

the current

user within the

CPP 2017

system

integer

This technical

identifier

uniquely

identifies the

current user

within the CPP

2017 system.

0-1

listeIdAbonnement 1-n

idAbonnement

Number:

technical

identifier of

the

subscription,

i.e. the link

between the

area, the

structure and

the user in the

CPP 2017

system

integer

This identifier

uniquely

identifies a

subscription

within the CPP

2017 system.

ConsulterDem

andesAbonne

mentParGestio

nnaire

OR

RechercherDe

mandesAbonn

ementEnAttent

eParGestionnai

re

1

typeHabilitation

String: type of clearances of the subscription request chosen by the

manager

String

Enumeration

with 2 possible

values:

-

CONSULTATIO

N_UNIQUEME

NT

-

MODIFICATIO

N

1

parametresValiderDemandesAbonnementParGestionnaire

pageResultatDemandee

Number: number of the result page to be displayed

integer

By default, the

output is the

first page.

0-1

nbResultatsParPage

Number: Number of results per page that can be returned by

the research

integer

By default, the

service returns

6 results per

page.

0-1

438 / 557


triSens String: sorting order

varchar(10)

Enumeration

with two

possible

values:

- ascending

sorting

- downward

sorting

By default, the

sorting is

downward.

0-1

triColonne

String: reference column of the sorting

-

Enumeration

with the

flollowing

possible value:

IdAbonnement

0-1

Output table

Attribute Subattribute Typing (tagger) Format Manageme

nt rules Multiplicity

idUtilisateurCour

ant

Number:

technical

identifier of the

current user

within the CPP

2017 system

integer

This technical

identifier

uniquely

identifies the

current user

within the CPP

2017 system.

0-1

parametresRetou

r

pageCourante

Number: number

of the current

page

integer 1

pages

Number: Number

of pages returned

by the research

integer 1

nbResultatsParPa

ge

Number: number

of results per

page

integer 1

total

Number: Number

of results

returned by the

research

integer 1

listeIdAbonneme

nt 0-n

idAbonnement

Number:

technical

identifier of the

subscription, i.e.

the link between

the area, the

structure and the

integer

This identifier

uniquely

identifies a

subscription

within the CPP

2017 system.

1

439 / 557


user in the CPP

2017 system

Error table


20000 The identifier of the user does not correspond

to a valid user. GCU_MSG_04.002

20001 Not any area subscription corresponding to

the data has been found. GCU_MSG_04.005

20002

The current user is not primary or secondary

manager of at least one structure connected

to the selected user. Thus, he has not the

necessary clearances to perform this process.

GCU_MSG_04.011

20003 The subscription status is not "en cours de

validation" [under validation]. GCU_MSG_04.006

20004

Il n'existe pas de rattachement actif entre

l'utilisateur et le service lié à l'abonnement à

l'espace

GCU_MSG_04.008

20005 Le service concerné par le rattachement

n'existe pas ou est inactif GCU_MSG_04.017

20006 La structure concernée par le rattachement

n'est pas valide GCU_MSG_04.018

20007

The identifier of the user – who sent the

connection request – does not correspond to

a valid user.

GCU_MSG_04.012

20008

GCU_MSG_04.022 - L'utilisateur ne peut pas

s'abonner à cet espace: il est seulement

ouvert à une structure publique.

GCU-CU-04-SER-05 Valider une demande

d’abonnement à un espace

20009


s'abonner à cet espace: il est seulement

ouvert à une structure privée.

GCU-CU-04-SER-05 Valider une demande

d’abonnement à un espace

20010 GCU_MSG_05.009 - L'utilisateur {2} n'est

pas déclaré dans CPP ou n'est pas {3}


{3}= ACTIF (Référentiel EtatCompteFO)

GCU-CU-05-SER-16 Demander un

abonnement à des espaces

20011

GCU_MSG_05.029 - Subscription request

impossible:

the identifier {0} does not correspond to a

valid structure.




20012


impossible:

The service {0} is unknown for the structure

{1}.





20013 GCU_MSG_05.016 - une erreur est survenue GCU-CU-05-SER-16 Demander un


20014 GCU_MSG_05.013 - l'utilisateur n'est pas

rattaché à une structure



20015


impossible:

the area {0} is not allowed.

{0}=identifiant de l'espace



20009 The field {0} is required. GSU_MSG_05.019

440 / 557


{0} = name of the field

441 / 557


2.4.5.6 Validate user connection

The method validerRattachementUtilisateur permet à un gestionnaire de valider une demande de rattachement d’un

utilisateur souhaitant se rattacher à une structure gérée par un gestionnaire

Input table


Service

providing

the data

Multiplicity

adresseEmailConnexionUtilisateurRattache

String: corresponding to the login email address entered by the user requesting the

subscription

varchar

(200)

Required:

AdresseEmailConnex

ionUtilisateurRattach

e

OR

IdUtilisateurRattache

RechercherU

tilisateurVali

de

0-1

idUtilisateurRattache

Number: technical identifier de l'utilisateur au sein du système CPP de l'utilisateur qui fait l'objet de la demande de rattachement

integer

This identifier

uniquely identifies

the user within the

2017 CPP system

Required:

AdresseEmailConnex

ionUtilisateurRattach

e

OR

IdUtilisateurRattache

RechercherU

tilisateurVali

de

0-1

idStructure

Number: technical

identifier of the

structure in the CPP

2017 system

integer

This identifier



CPP 2017 system.

Required :

IdStructure

OR

TypeIdentifiantStruc

ture +


RechercherS

tructure 0-1


String: énumération des possible values de type d'identifiant

varchar

(50)

Enumeration with 7

possible values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

-

EN_COURS_IMMATR

ICULATION

Required:

IdStructure

OU

RechercherS

tructure 0-1

442 / 557



ture +




varchar

(80)

Alphanumeric value

Required:

IdStructure

OU


ture +


RechercherS

tructure 0-1

roleUtilisateur

String: rôle de

l'utilisateur par rapport

à la structure

varchar

(50)

Enumeration with 3

possible values:

-

GESTIONNAIRE_PRIN

CIPAL

-

GESTIONNAIRE_SECO

NDAIRE

-

UTILISATEUR_SIMPLE

1

Détails

details 1

dateDebutV

alidite

String: date de début de

validité d'un service

pour un compte

utilisateur


MM-JJ HH:MI 1

dateFinValid

ite

String: date de fin de

validité d'un service

pour un compte

utilisateur


MM-JJ HH:MI 0-1

commentair

es

String: détails

renseignés par

l'utilisateur à propos de

la demande de

rattachement

varchar

(255) 0-1

liste des services déjà rattachés ou à rattacher

listeServices Liste

La liste des services à

transmettre en entrée

sont:

- les services déjà

rattaché et actif

- les services faisant

déjà l'objet d'une

demande de

rattachement "en

cours d'activation"

- les nouveaux

services auxquels

l'utilisateur souhaite

se rattacher

0-n

443 / 557


La liste peut être vide.

idService

Number: technical



integer



within the CPP 2017

system.

1

idRattachem

ent

Number: technical

identifier of the

connection request in

the CPP 2017 system

integer




2017 system.

Ce paramètre n'est

pas renseigné dans le

cas où il s'agit d'un

nouveau service

auquel l'utilisateur

souhaite se rattacher.

0-1


parametresValiderRattachementUtilisateur

pageResulta

tDemandee


result page to be

displayed



nbResultats

ParPage

Number: number of



research

integer



page.

0-1


(10)


possible values:

- ascending sorting

- downward sorting


is downward.

0-1



Enumeration avec 2

possible values:

- IdService

- IdRattachement


is performed on the

field "IdService"

0-1

Output table

Attribute Subattr

ibute Typing (tagger) Format Management rules Multiplicity

idUtilisateurCo

urant

Number: technical

identifier de l'utilisateur integer


identifies a user within


0-1

444 / 557


qui valide la demande de

rattachement

parametresRetour

pageCo

urante




returned by the research integer 1

nbResu

ltatsPar

Page


per page integer 1

total

Number: Number of


research

integer 1


listeRattachementValide

Liste 0-n

idServi

ce

Number: technical

identifier of the service in

the CPP 2017 system

integer



within the CPP 2017

system.

1

idRatta

cheme

nt

Number: technical

identifier of the connection

request in the CPP 2017

system

integer




2017 system.

1

445 / 557


Error table


20000

The identifier of the user – who validates the

connection request – or the identifier of the

user – who sent the connection request –

does not correspond to a valid user.

GCU_MSG_00.008



20002

Si l'utilisateur validant la demande de

rattachement est gestionnaire

principal/secondaire de la structure, le rôle

doit être spécifié (non vide).

GCU_MSG_00.015

20003 Le rôle spécifié ne correspond pas à un rôle

connu. GCU_MSG_00.016

20004

Si l'utilisateur validant la demande de

rattachement n'est pas gestionnaire

principal/secondaire de la structure, alors cet

utilisateur doit être le même que celui qui

fait l'objet de la demande de rattachement.

GCU_MSG_00.017

20005 GCU_MSG_00.016 - Le rôle {0} n'est pas

géré dans le système.

{0} = [Rôle]

GCU-CU-00-SER-05 Rattacher un

utilisateur à une structure

20006

GCU_MSG_00.017 - L'utilisateur {0} ne peut

pas créer de rattachement pour l'utilisateur

{1} sur la structure {2}.

{0} = [Name and surname of the user qui

fait le rattachement]

{1} = [Name and surname of the user qui

doit être rattacher]




20007


demander un rattachement à une structure

où il est déjà Gestionnaire Principal.



20008

GCU_MSG_00.018 - La structure {0} n'a pas

le type de structure attendu: publique ou

privée.

{0} = [Identifiant]



20009 GCU_MSG_00.057 - A technical or

functional identifier is required for the user.

20010

GCU_MSG_00.059 - The technical and

functional identifiers do not correspond to

each other.

20011 GCU_MSG_00.021 - Le service {0} n'existe

pas pour la structure {1}

20012

GCU_MSG_00.060 - Please enter a technical

identifier or a type and a functional identifier

of a structure.

20013 GCU_MSG_05.019 - the field {0} is required. {0}= label of the required field

446 / 557


2.4.5.7 Retrieve services for standby connection requests

The method recupererServicesPourDemandeRattachEnAttente permet de récupérer les services de la structure pour

laquelle un autre utilisateur possède une demande de rattachement en cours.

Input table



Service

providing the

data

Multiplicity

structure 1

idStructur

e

Technical

identifier of the

structure in the

CPP 2017

system

integer

Required:

IdStructure

OU


ure +


RechercherStr

ucture 0-1

typeIdenti

fiantStruct

ure

Enumération

des possible

values de type

d'identifiant

varchar(

50)

Enumération

TypeIdentifiant

Required:

IdStructure

OU


ure +


RechercherStr

ucture 0-1

identifiant

Structure

Functional

identifier of the

structure

varchar(

80)

Required:

IdStructure

OU


ure +


RechercherStr

ucture 0-1

utilisateur

Utilisateur

sélectionné,

pour lequel le

système

recherche les

services de la

structure

auxquels il est

"en cours de

rattachement"

1

adresseE

mailConne

xionUtilisa

teur

Correspond à

l'adresse

électronique de

connexion

renseignée par

l'utilisateur

varchar(

200)

Required:

AdresseEmailConnexi

onUtilisateur

OU

IdUtilisateur

RechercherUtili

sateurValide 0-1

idUtilisate

ur

Technical

identifier de

l'utilisateur au

integer

This identifier



RechercherUtili

sateurValide 0-1

447 / 557


sein du

système CPP

de l'utilisateur

CPP system

Required:

AdresseEmailConnexi

onUtilisateur

OU

IdUtilisateur

parametresRecherche

0-1

nbResultat

sMaximu

m

Maximum

number of

results that can

be seen for a

research

integer

By default, the

service returns no

more than 200

results.

0-1

pageResul

tatDeman

dee

Number of the

result page to

be displayed



nbResultat

sParPage

Number of

results per

page that can

be returned by

the research

integer

By default, the

service returns 10

results per page.

0-1


10)

Enumeration with

deux possible values:

- Ascendant

- Descendant

Par défaut, le tri est

ascendant.

0-1

triColonne

Reference

column of the

sorting

-








0-1

448 / 557


Output table


parametresRetour

0-1



pages

Number of pages

returned by the

research

integer 0-1

nbResultatsPar

Page

Number of results per

page integer 0-1

total

Number of results

returned by the

research

integer 0-1

listeServices Liste 0-n

idService


the service in the CPP

2017 system

integer

This identifier



2017 system.

1

codeService Service code varchar(100) Alphanumeric value 1

libelleService Name of the service varchar(100) 1

statutService Status of the service varchar(10)

Enumeration with 2

possible values:

- ACTIF

- INACTIF

1

dateDbtService

Beginning date of the

service activation

period


JJ HH:MI 0-1

dateFinService

End date of the

service activation

period


JJ HH:MI 0-1

449 / 557


estActif

Flag indicating

whether the service is

active or not,

according to its end

date of activation

period

boolean



not entered, then the

parameter "Actif" is

filled with "true".If

the end date of the


earlier than the

current date, then


the value "false".

If not, "Actif" is filled

with the value "true".

1

Error table


20000 The user {0} does not correspond to any

active user.

GCU_MSG_04.002

{0] = [user email address]

GCU-CU-04-SER-18 Lister les services

demandés pour une structure donnée par

un utilisateur donné [List the required

services for selected structure and user]


identifier {0}.

GCU_MSG_04.007


GCU-CU-04-SER-18 Lister les services

demandés pour une structure donnée par

un utilisateur donné [List the required

services for selected structure and user]

20002



structure.


20003 A technical or functional identifier is

required for the user. GCU_MSG_00.057 - SXP

20004

The current user {0} is not primary or

secondary manager of the structure {1}

{2}.

GCU_MSG_04.011


450 / 557


2.4.5.8 Refuse subscription request by manager

The method refuserDemandesAbonnementParGestionnaire permet à un gestionnaire de refuser une demande

d’abonnement d’un utilisateur pour un espace ou une strucure donnés.

Input table



idAbonnement


of the

subscription, i.e.

the link between

the area, the

structure and the

user in the CPP

2017 system

integer

RechercherDeman

desAbonnementEn

AttenteParGestion

naire

1

motifRefus Motif du refus varchar(255) 1

Output table


Error table




20001 Not any area subscription corresponding

to the data has been found. GCU_MSG_04.005

20002

The current user is not primary or

secondary manager of at least one

structure connected to the selected user.

Thus, he has not the necessary

clearances to perform this process.

GCU_MSG_04.011

20003 The subscription status is not "en cours

de validation" [under validation]. GCU_MSG_04.006

20005

The identifier of the user – who sent the

connection request – does not correspond

to a valid user.

GCU_MSG_04.012


identifier {0}. GCU_MSG_04.007


structure {1}.

GCU_MSG_06.004



451 / 557


20008 Not any connection request

corresponding to the data found. GCU_MSG_04.001

20009

There is not any active connection

between the user {0} and the service

{1}.

GCU_MSG_04.008


user]

{1} = [name of the service connected to

the subscription request]

452 / 557


2.4.5.9 Refuse user connection

The method refuserRattachementUtilisateur allows the manager to refuse the connection requests whose statu sis

« en cours » [processing], for a parametered couple (user, structure).

Input table


data Multiplicity

idRattachement

Unique technical

identifier of the

connection

request

integer

RechercherDemandesR

attachEnAttenteParGest

ionnaire

1

motifRefus

Reason of

connection

request refusal

varchar(2

55) 1

Output table


Error table


20000 GCU_MSG_04.002 - The user {0} does

not correspond to any active user.

{0] = [user email address]

GCU-CU-04-SER-02 Refuser une

demande de rattachement à un

service [Refuse a connection request

to a service]

20001

GCU_MSG_04.012 – The requesting user

{0} does not correspond to any valid and

active user.





to a service]

20002 GCU_MSG_04.001 - Not any connection

request corresponding to the data found.




to a service]

20005

GCU_MSG_04.011 - The current user

{0} is not primary or secondary manager

of the structure {1}.






to a service]

20006

GCU_MSG_04.003 - The connection

request of the user {0} to the service

{1} of the structure {2} has not the

status {3}.

{0} = [user to connect]

{1} = [service to connect]

{2} = [structure to connect]

{3} = [expected processing status]



453 / 557



to a service]

454 / 557


2.5 Data flow overview

This chapter indicates the input, output and error tables for the following services:

- Consult account

- Consult detailed account

2.5.1 Consult account

The method ConsulterCR allows to consult informations linked to the flow submission and retrieve the PDF account

of the process of the flow submitted via the Portal or the service DeposerFluxFacture.

Input table


Service

providing

the data

Multiplicity

numeroFluxDepot

Number: number of

the submitted flow varchar(25)

This identifier uniquely identifies a

flow within the CPP 2017 system.

1

dateDepot

String: submission

date of the

invoicing flow

date Date field: AAAA-MM-JJ 0-1

syntaxeFlux String: flow syntax varchar(24)


values:








0-1

Output table


numeroFluxDepot Number: Numéro du

flux varchar(255) 1

dateDepotFlux String: Submission



JJTHH:MM:SS+HH:MM 1

codeInterfaceFlux String: interface code

of the flow varchar(255) Enumeration CodeInterface 1

etatCourantFlux String: current status

of the flow varchar(255)

Received:

The flow has been received by

Chorus Pro ;

Processed by the CPP ES:

The flow has arrived in the CPP

Exchange System ;

Waiting for processing:

1

455 / 557


The flow is waiting for being

processed ;

Processing:

The flow is being processed ;

Faulty:

The flow is not processed by

the CPP ES, i twill be necessary

to submit it again ;

Rejeted:

The flow has been processed

but rejected because of failures

in the flow ;

Waiting for processing again:

The flow has been blocked,

waiting for a manual

processing ;

Integrated:

The flow has been processed

and integrated in Chorus Pro ;

Partially integrated:

This case concerns the flows

whose correct invoices only

have been integrated.

designationPartenaire String: designation of







deputy.

1

nomFichierFlux String: name of the

flow document varchar(255) 1

dateHeureEtatCourantFlux

String: date and time

of the current status date


JJTHH:MM:SS+HH:MM 1

fichierCR

String: file containing

the base64-encoded

attachment

file

PDF document generated on

the fly by a SXP process from

HTML.

1

456 / 557


Error table


20000

You have not the necessary clearances on the area Flow Overview and Qualification for the issuing structure {0}

POQ-CU-01-SER-03

POQ_MSG_01.002 {0} = Identifier of the structure

20001 Flow not found. POQ-CU-01-SER-03 POQ_MSG_01.003

20002 The flow does not correspond to a flow submitted via the Portal or the service deposerFluxFacture.

POQ_MSG_01.035

20003 No flow type speicifed for the research. POQ_MSG_01.027

20004 No flow format specified for the research.

POQ_MSG_01.028

20005 No flow syntax specified for the research.

POQ_MSG_01.023

20006 No processing mode specified for the research.

POQ_MSG_01.139

20007 No submission mode specified for the research.

POQ_MSG_01.024

20008 No flow status specified for the advanced research on status.

POQ_MSG_01.025

20009 No date specified for the advanced research on history.

POQ_MSG_01.026

20010 Account not found. POQ_MSG_01.030

20011 HTML flow not found. POQ_MSG_01.031

457 / 557


2.5.2 Consult detailed account

The method ConsulterCRDetaille allows to consult the integration status of a API-issued flow, with, as appropriate,

the errors identified by the system (inadmissibility of the flow or rejection of one or several payment requests).

Input table


Service

providing

the data

Multiplicity

numeroFluxDe

pot

Number of the

submitted flow varchar(25)

DeposerFlux

Facture 1

Output table


nomFichier Name of the submitted

document varchar(60) 1

dateDepotFlux Submission date of the

flow date 1

codeInterfaceDepotFlux

Interface code of the

submitted flow varchar(15) 1

etatCourantDepotFlux

Current status of the

submitted flow

Texte (50

caractères) 1

dateHeureEtatCourantFlux

Modification date and

time of the current

status of the submitted

flow

date 1

listeErreurTechnique

0-n

natureErreur Nature of error varchar 0-1

codeErreur Technical code of the

error integer 0-1

libelleErreur Label of the error varchar 0-1

listeErreurDP 0-n

identifiantFournis

seur


the supplier requesting

payment

integer 0-1

458 / 557


identifiantDestin

ataire


the recipient receiving

the payment request

integer 0-1

numeroDP Number of the payment

request varchar 0-1

libelleErreurDP Label of the error varchar 0-1

Error table


20000 You have not the necessary clearances on the area Flow Overview for the issuing structure {0}

POQ_MSG_01.002 {0} = designation of the recipient structure

20001 Flow not found. POQ_MSG_01.003

459 / 557


2.6 Commitment number management


- Consult the details of a commitment

- Search for a commitment

- Retrieve a commitment

- Retrieve the type of a commitment

2.6.1 Consult the details of a commitment

The method consulterDetailEngagementJuridique allows to consult the details of a commitment number and the

associated payment requests.

Input table


data Multiplicity

numeroEngagementJuridique

Commitment

number varchar(10)

RechercherEngagement

Juridique 1

Output table


idEngagement


of the

commitment

within the CPP

2017 system

integer


identifies the commitment

number within the CPP 2017

system.

1


Current

commitment

number

varchar(10) 1

etatCourantEngagement

Current status of

the commitment. varchar(20) Enumeration EtatEJ 1

typeEngagement

Commitment type varchar(100) Enumeration TypeEJ 1

emetteur 0-1

idStructureEme

ttrice


of the issuing

structure within

the CPP 2017

system

integer 0-1

460 / 557


identifiantStruc

tureEmettrice

Functional

identifier of the

commitment-

issuing structure

varchar(80) 0-1

raisonSocialeSt

ructureEmettric

e

Corporate name of

the structure

issuing the

commitment

varchar(100) 0-1

idServiceExecu

tant


of the executing

service within the

CPP 2017 system

integer 0-1

codeServiceExe

cutant

Code of the

executing service

of the

commitment

varchar(100) 0-1

nomServiceExe

cutant

Name of the

executing service

of the

commitment

varchar(100) 0-1

adresseService

ExecutantDetai

l

Details of the

executing service

address

varchar(100) 0-1

adresseService

ExecutantComp

lement1

First complement

of the executing

service address

varchar(100) 0-1

adresseService

ExecutantComp

lement2

Second

complement of the

executing service

address

varchar(100) 0-1

adresseService

ExecutantCode

Postal

Postal code of the

executing service

address

varchar(10) 0-1

adresseService

ExecutantVille

City of the

executing service

address

varchar(50) 0-1

adresseService

ExecutantCode

Pays

Country code of

the executing

service address

varchar(2) 0-1

adresseService

ExecutantLibell

ePays

Country label of

the executing

service address

varchar(100) 0-1

recepteur 1

461 / 557


idStructureRec

eptrice


of the recipient

structure in the

CPP 2017 system

integer 1

identifiantStruc

tureReceptrice

Functional

identifier of the

recipient structure

varchar(80) 1

designationStr

uctureReceptric

e

Designation of the

recipient structure varchar(100) 1

adresseStructu

reReceptriceDe

tail

Details of the

recipient structure

address

varchar(100) 0-1

adresseStructu

reReceptriceCo

mplement1

First complement

of the recipient

structure address

varchar(100) 0-1

adresseStructu

reReceptriceCo

mplement2

Second

complement of the

recipient structure

address

varchar(100) 0-1

adresseStructu

reReceptriceCo

dePostal

Postal code of the

recipient structure

address

varchar(10) 0-1

adresseStructu

reReceptriceVill

e

City of the

recipient structure

address

varchar(50) 0-1

adresseStructu

reReceptriceCo

dePaysa

Country code of

the recipient

structure address

varchar(2) 0-1

adresseStructu

reReceptriceLib

ellePays

Country label of

the recipient

structure address

varchar(100) 0-1

references 0-1

deviseEngagem

ent

Commitment

currency varchar(3) 0-1

libelleDevise

Label of the

commitment

currency

varchar(50) French label of the currency 0-1

462 / 557



dateNotification

Engagement

Modification date

of the

commitment



nontantTotalTt

c

Global tax-

included amount

of the

commitment

Decimal(19,6

) 0-1

lignePoste List 0-n

numeroDePost

e

Number of the

commitment post integer 1

statutPoste Status of the

commitment post varchar(10) Enumeration EtatPosteEj 0-1

montantTtcPost

e

Tax-included

amount of the

commitment post

Decimal(19,6

) 0-1

demandePaiement

Liste 0-n

idDemandePaie

ment


of the payment

request within the

CPP 2017 system

integer 1

numeroDeman

dePaiement

Number of the

payment request

issued by the

supplier

varchar(20) 1

typeDemandeP

aiement

Type of payment

request varchar(50)

Enumeration

TypeDemandePaiement 1

sousType

Type of

invoice/work

invoice

varchar(50)

Enumeration TypeFacture ou

Enumeration

TypeFactureTravaux

0-1

dateFournisseu

r

Issuing date of the

payment request

in the supplier IS



463 / 557


EtatCourantDe

mandePaiemen

t

Current status of

the payment

request


EtatDemandePaiement 1

montantTtcDe

mandePaiemen

t

Tax-included

amount of the

payment request

Decimal(19,6

) 0-1

Error table


20000 GEJ_MSG_01.004 - The commitment

number {0} has not been found.

{0}= parameter of commitment identifier

GEJ-CU-01-SER-03 - « Consulter le détail

d’un engagement juridique » [consult the

details of commitment]

20001

GEJ_MSG_01.003 - The user {0} has not

the necessary clearances to consult the

commitment numbers of the structure

{1}.


{1}= identifier of the structure

GEJ-CU-01-SER-03 - « Consulter le détail

d’un engagement juridique » [consult the

details of commitment]

20002

The structure {0} has not any payment

request whose status is "Mise en

paiement" [Payment] in Chorus Pro. Thus

its commitment numbers are not

available.

GEJ_MSG_01.006

{0} = designation of the structure

464 / 557


2.6.2 Search for a commitment number

The method rechercherEngagementJuridique allows to search for a commitment number.

Input table



codeEngagementJuridique

String: type

code of the

researched

commitments

varchar(100

)


values:

- BON_DE_COMMANDE

- MARCHE_A_TRANCHE

- MARCHE_UNIQUE

- MARCHE_MIXTE

- MAPA_A_TRANCHES

- MAPA_UNIQUE

- MAPA_MIXTE

- AUTRES_CONTRATS

- BON_DE_COMMANDE_TECHNIQUE

- MARCHE_A_BON_DE_COMMANDE

- MAPA_A_BON_DE_COMMANDE

- BAUX

- DECISIONS_DIVERSES

- LISTE_DE_PRIX

- SUBVENTIONS

0-1


String:

number of

the

researched

commitment

varchar(10)

The characters « * » and « % » are

authorized for the research, at least

3 characteers are required.

0-1

numeroMarcheEngagementJuridique

String:

contract

number of

the

researched

commitment

varchar(10)

The characters « * » and « % » are

authorized for the research, at least

3 characteers are required.

0-1

structureReceptriceEngagemen

tJuridique

String:

identifier of

the recipient

structure

associated

with the

researched

commitment

varchar(18) 0-1


String:

executing

service code

varchar(100

) 0-1

etatCourantEng

agementJuridique

String: status

of the

researched

commitments

varchar(20)


- COMMANDE

- FACTURE

- CLOTURE

- SUPPRIME

0-1

465 / 557



parametresRecherche

0-1

pageResultat

Demandee

Number:

number of

the result

page to be

displayed


page. 0-1

nbResultatsP

arpage

Number:

number of

results per

page that can

be returned

by the

research



triSens String:

sorting order varchar(10)


values:

- ascending sorting

- downward sorting

By default, the sorting is downward.

0-1

triColonne

String:

reference

column of the

sorting

-


values:

- LibelleTypeEngagementJuridique

- NumeroEngagementJuridique

- IdentifiantStructureReceptrice

- LibelleStructureReceptrice


- LibelleServiceExecutant

- DateNotificationEJ

- LibelleEtatCourantEJ

- MontantTotalTtc

- DeviseEngagement

- TaillePJ

By default, the sorting is performed

on the field "DateNotificationEJ".

0-1

466 / 557


Output table

Attribute Subattribute Typing (tagger) Format Multiplicity


pageCourante Number: number of the




nbResultatsParpage Number: number of results


total Number: Number of results


listeEngagementJuridique Liste 0-n

idEngagement

Number: technical identifier

of the commitment number

within the CPP 2017 number

integer 1

libelleTypeEngagementJu

ridique

String: type of the

commitment number varchar(50) 1

numeroEngagementJuridi

que String: commitment number varchar(10) 1

structureReceptrice

String: designation of the

structure receiving the

commitment

varchar(201) 0-1

identifiantStructureRecep

trice

String: identifier of the

structure receiving the

commitment

varchar(18) 0-1

libelleStructureReceptrice


structure, which received

the commitment

varchar(100) 0-1

codeServiceExecutant String: Executing service

code varchar(100) 0-1

libelleServiceExecutant String: Executing service’s


dateNotificationEJ String: modification date of

the commitment

Date field:

AAAA-MM-

JJTHH:MM:SS

+HH:MM

0-1

libelleEtatCourantEJ String: current status of the

commitment varchar(20) 1

montantTotalTtc Number: global tax-included

amount of the commitment decimal(19,6) 0-1

deviseEngagement String : currency of the

commitment varchar(3) 0-1

taillePJ Number: size of the

publishable attachment decimal(19,6) 0-1

Error table

467 / 557





20000

GEJ_MSG_01.003 - The user {0} has not the

necessary clearances to consult the

commitment numbers of the structure {1}.

GEJ-CU-01-SER-01 Rechercher

engagement juridique [search for a

commitment]


{1}=Identifier of the structure

20001

GEJ_MSG_01.006 - The structure {0} has

not any payment request whose status is

"Mise en paiement" [Payment] in Chorus Pro.

Thus its commitment numbers are not

available.



commitment]


20002

GEJ_MSG_01.007 - The structures {0} and

{1} have not any payment request whose

status is "Mise en paiement" [Payment] in

Chorus Pro. Thus theirs commitment numbers

are not available.



commitment]

{0},{1} = designation of the structures

20003 GCU_MSG_00.038 - Please enter at least one

criterion for the research.



commitment]

20004 TRA_MSG_09.007 - The beginning date must

be earlier than the end date.



commitment]

20005

TRA_MSG_00.019 - The upper bound of an

amount must be equal or greater than the

lower bound.



commitment]

20006 TRA_MSG_00.024 - Please enter at least 3

charactersin the field {0}



commitment]

20007 TRA_MSG_00.015 - No result found



commitment]

468 / 557


2.6.3 Retrieve the status of a commitment

The method recupererEtatEngagementJuridique allows to retrieve the list of all the possible commitment status.

Input table



Output table


listeEtatEngage

mentJuridique List

0-n

etatEngagement

Juridique

String:

enumeration of

commitment

status

varchar(50)

Enumeration with 4

possible values:

- COMMANDE

- FACTURE

- CLOTURE

- SUPPRIME

1

469 / 557


2.6.4 Retrieve the type of a commitment

The method recupererTypeEngagementJuridique allows to retrieve all the possible commitment types.

Input table


Output table


listeTypeEngagem

entJuridique Liste

0-n

typeEngagement

Juridique

String:

enumeration of

commitment

type

varchar(100) Enumeration TypeEJ 1

470 / 557


2.7 Request management

2.7.1 Common services of all requests


- Add complementary informations in the request

- Search for issued requests

- Search for received requests

- Download requests

- Consult requests

2.7.1.1 Add complementary informations in the request

This method allows the request-issuing partner to add informations after the recipient requested complements

(EtatDeposant filled with "Attente informations complémentaires" or "Envoyée").

Input table



identifiantSollicitation

Integer : technical

identifier of the

request

integer

1

informationsComplementaires

Comment to add in

the request

varchar(4000)

1

pieceJointeId Integer : identifier of

the attachment of

the requesting obect

Integer

AjouterFichierDansSysteme

0-1

Output table


Multiplicity

Error table


20001 Addition of complementary informations

impossible: the user {1} has not created the

request {0}.

AUT_MSG_02.05

{0}= identifier of the request

{1}= name and surname of the user asking for

complementary informations

20002 The request {0} does not exist. AUT_MSG_02.03


20003 The status of the request {0} does not allow to

add complementary informations.

AUT_MSG_02.04


20004 Attachment {0} not found. GDP_MSG_11.041

{0} = identifier of the attachment

20005 The Request area is under maintenance. In case

of emergency, you can contact us at the

following address: {0}

AUT_MSG_29.06

{0}= contact email address defined in the

applicative parameters

471 / 557


2.7.1.2 Search for issued requests

The rechercherSollicitationsEmises method allows to search for a request among all these issued by a structure.

Input table


rules

Service

providing the

data

Multiplicity

idSollicitation Integer: Integer :

technical identifier of

the request

integer

0-1

numeroSollicitation

String: functional

identifier (reference)

of the request to

research

Varchar

(20)

0-1

idCategorie Integer : identifier of

the request category

integer The categories

MEMJUST and

REMBTIC are

forbidden.

RechercherCat

egorieSollicitat

ion 0-1

idSousCategorie Integer : identifier of

the request

subcategory

integer RechercherSo

usCategorieSo

llicitation

0-1

numeroObjet String: identifier of

the object number

(payment request,

commitment…)

associated to the

request

Varchar

(20)

0-1

statut String: identifier of

the request statuses

Varchar

(50)

Enumeration

with the

following

values :

ETAT_DEPOSANT_ENREGISTRE ETAT_DEPOSANT_AFFECTE ETAT_DEPOSANT_PRISE_EN_COMPTE ETAT_DEPOSANT_REPONDUE ETAT_DEPOSANT_REOUVERTE ETAT_DEPOSANT_EN_COURS ETAT_DEPOSANT_EN_ATTEN

TE_INFOS ETAT_DEPOSANT_REPONDUE_MAUVAISE_CATEGORIE ETAT_DEPOSANT_COMPLETE ETAT_DEPOSA

NT_CLOSE

0-1

472 / 557


periodeSaisieDu Date: beginning date

of the period of

researched request

entry

date

0-1

periodeSaisieAu Date: end date of the

period of researched

request entry

date

0-1

idStructureEmettrice

Integer : technical

identifier of the

issuing structure in

the CPP 2017 system


uniquely

identifies a

structure

within the

CPP 2017

system.

Required :

Technical

identifier of

the structure

OR

identifier type

of the

structure +

functional

identifier of

the structure

0-1

typeIdentifiantStructureEmettrice


of structure

Varchar

(15)

Enumeration

TypeIdentifian

t

Required:

technical

identifier of

the structure

OR

identifier type

+ Functional

identifier of

the structure

0-1

identifiantStructureEmettrice

String: functional

identifier of the

issuing structure

Varchar

(80)

Required:

technical

identifier of

the structure

OR

identifier type

+ Functional

identifier of

the structure

0-1

idStructureDestinataire

Integer: technical

identifier of the

recipient structure to

modify in the CPP

2017 system


uniquely

identifies a

structure

within the

0-1

473 / 557


CPP 2017

system.

Required :

Technical

identifier of

the structure

OR

identifier type

+ functional

identifier of

the structure

typeIdentifiantStructureDestinataire


of the recipient

structure

Varchar

(15)

Enumeration

TypeIdentifian

t

Required:

technical

identifier of

the structure

OR

identifier type

+ Functional

identifier of

the structure

0-1

identifiantStructureDestinataire

String: functional

identifier of the

issuing structure

varchar(80

)

Required:

technical

identifier of

the structure

OR

identifier type

+ Functional

identifier of

the structure

0-1


Integer : technical

identifier of the

concerned recipient

service (according to

the typeObjet).

Integer

0-1

creeePar String: name and

surname of the user

who created the

request.

Varchar

(80)

0-1

parmetragePagination

pageResultatDe

mandee

Number: number of


displayed


output is the

first page.

0-1

nbResultatsPar

Page

Number: number of

results per page

that can be returned

by the research


service returns

10 results per

page.

0-1

474 / 557


triSens String: sorting order Varchar

(10)

Enumeration

with two

possible

values:

- ascending

sorting

- downward

sorting

By default,

the sorting is

downward.

0-1

triColonne

String: reference

column of the sorting

Varchar

(80)

Enumeration

with the

attributes’

names of the

results’ list.

By default,

the sorting

order is

performed on

the first

attribute of

the results’

list.

0-1

Output table


Multiplicity

parametresRetour


current page

integer 1

pages Number: Number of


research

integer

1

nbResultatsParP

age

Number: number of

results per page

integer 1

total Number: Number of


research

integer

1

listeSollicitations The result of the research is a list of requests.

0-n

idSollicitation Integer : technical

identifier of the request

integer 1

numeroSollicitat

ion

String: functional

identifier (reference) of

the request to research

varchar(20

)

1

idCategorie Integer: identifier of the

request category

integer The requests on the categories MEMJUST and REMBTIC cannot be returned by the

1

475 / 557


RechercherSollicitationsEmises SXP.

codeCategorie String: code of the

request category

varchar(15

)

The requests on the categories MEMJUST and REMBTIC cannot be returned by the RechercherSollicitationsEmises SXP.

1

libelleCategorie String: label of the

request category

varchar(20

0)


1

idSousCategorie Integer: identifier of the

request subcategory

integer 1

codeSousCateg

orie

String: code of the

request subcategory

varchar(15

)

1

libelleSousCate

gorie


request subcategory

varchar(20

0)

1

numeroObjet String: identifier of the

request number object

varchar(20

)

0-1

statut String: identifier of the

request statuses

varchar(50

)

Enumeration EtatSollicitationEmise. The correspondence of the Mantis statuses is described in the rules.

1

dateSaisie Date: creation date of

the request

date 1

creeePar String: identifier of the

request author

varchar(80

)

1

idStructureEmet

trice

Integer: technical

identifier of the issuing


the CPP 2017 system

integer

1

idStructureDesti

nataire

Integer: technical

identifier of the recipient


the CPP 2017 system

0-1

Error table


20001 You are not connected to the structure linked to

the request.

AUT_MSG_03.10

20002 At least one of the research criteria must be

entered.

AUT_MSG_10.02

20003 The supplied category does not correspond to an

available category in this using mode.

AUT_MSG_01.09

20004 This subcategory does not exist. AUT_MSG_01.06

20005 This subcategory does not correspond to that

category.

AUT_MSG_01.07

20006 The beginning date must be earlier than the end

date.

TRA_MSG_09.007


476 / 557




GCU_MSG_00.062

20009 No active structure corresponds to the identifier

{0}.



{0} = Technical identifier ou functional

identifier of the issuing or recipient structure




AUT_MSG_29.06



477 / 557


2.7.1.3 Search for received requests

Le service permet de rechercher une sollicitation parmi l’ensemble des sollicitations reçues par un récipiendaire

Input table


rules

Service

providing the

data

Multiplicity

idSollicitation Integer: technical

identifier of the

request

integer

0-1

numeroSollicitation

String: functional

identifier

(reference) of the

request to research

Varchar

(20)

0-1

idCategorie Integer: identifier

of the request

category

integer The categories

MEMJUST and

REMBTIC are

forbidden.

RechercherCat

egorieSollicitat

ion 0-1

idSousCategorie Integer: identifier

of the request

subcategory

integer RechercherSo

usCategorieSo

llicitation

0-1

numeroObjet String: identifier of

the object number

(payment request,

commitment…)

associated to the

request

Varchar

(20)

0-1


the request

statuses

Varchar

(50)

Enumeration

with the

following

values :

ETAT_DEPOSANT_AFFECTE ETAT_DEPOSANT_PRISE_EN_COMPTE ETAT_DEPOSANT_REPONDUE ETAT_DEPOSANT_REOUVERTE ETAT_DEPOSANT_EN_COURS ETAT_DEPOSANT_EN_ATTENTE_INFOS ETAT_DEPOSANT_REPONDUE_MAUVAISE_CATEGORIE ETAT_DEPOSANT_COMPLETE ETAT_DEPOSA

NT_CLOSE

0-1

478 / 557


periodeSaisieDu Date: beginning

date of the period

of researched

request entry

date

0-1

periodeSaisieAu Date: end date of

the period of

researched request

entry

date

0-1


Integer: technical

identifier of the

issuing structure in

the CPP 2017

system


uniquely

identifies a

structure

within the

CPP 2017

system.

Required :

technical

identifier of

the structure

OR

identifier type

+ functional

identifier of

the structure

0-1


String: identifier

type of the issuing

structure

Varchar

(15)

Enumeration

TypeIdentifian

t

Required:

technical

identifier of

the structure

OU

identifier type

+ Functional

identifier of

the structure

0-1


String: functional

identifier of the

issuing structure

Varchar

(80)

Required:

technical

identifier of

the structure

OR

identifier type

+ Functional

identifier of

the structure

0-1


Integer: technical

identifier of the

recipient structure

to modify in the

CPP 2017 system


uniquely

identifies a

structure

within the

CPP 2017

system.

0-1

479 / 557


Required :

technical

identifier of

the structure

OR

identifier type

+ functional

identifier of

the structure


String: identifier

type of the

recipient structure

Varchar

(15)

Enumeration

TypeIdentifian

t

Required:

technical

identifier of

the structure

OU

identifier type

+ Functional

identifier of

the structure

0-1


String: functional

identifier of the

issuing structure

varchar(80) Required:

technical

identifier of

the structure

OR

Identifier type

+ functional

identifier of

the structure

0-1


Integer: technical

identifier of the

concerned recipient

service (according

to the typeObjet).

Integer

0-1

assigneeA String: name and

surname of the

user receiving the

request

Varchar

(80)

0-1

parmetragePagination

pageResultatDe

mandee

Number: number of

the result page to

be displayed


output is the

first page.

0-1

nbResultatsPar

Page

Number: number

of results per page

that can be

returned by the

research


service returns

10 results per

page.

0-1

480 / 557



order

Varchar

(10)

Enumeration

with two

possible

values:

- ascending

sorting

- downward

sorting

By default,

the sorting is

downward.

0-1

triColonne

String: reference

column of the

sorting

Varchar

(80)

Enumeration

with the

attributes’

names of the

results’ list.

By default,

the sorting

order is

performed on

the first

attribute of

the results’

list.

0-1

Output table


Multiplicity

parametresRetour


current page

integer 1

pages Number: Number of


research

integer 1

nbResultatsParP

age

Number: number of

results per page

integer 1

total Number: Number of


research

integer 1

listeSollicitations The result of the research is a list of requests.

0-n



integer 1

numeroSollicitat

ion

String: functional



varchar(20

)

1

idCategorie Integer: identifier of the

request category

integer The requests on the categories MEMJUST and REMBTIC cannot be returned by the

1

481 / 557


RechercherSollicitationsEmises SXP.

codeCategorie String: code of the

request category

varchar(15

)


1

libelleCategorie String: label of the

request category

varchar(20

0)


1

idSousCategorie Integer: identifier of the

request subcategory

integer 1

codeSousCateg

orie

String: code of the

request subcategory

varchar(15

)

1

libelleSousCate

gorie


request subcategory

varchar(20

0)

1


request number object

varchar(20

)

0-1

statut String: identifier of the

request statuses

varchar(50

)

1

dateSaisie Date: creation date of

the request

date 1

assigneeA


user receiving the

request

varchar(80

)

1

idStructureEmet

trice

Integer: technical

identifier of the issuing


the CPP 2017 system

integer 1

idStructureDesti

nataire

Integer: technical

identifier of the recipient


the CPP 2017 system

0-1

Error table



the request.

AUT_MSG_03.10

20002 At least one of the research criteria must be

entered.

AUT_MSG_10.02



AUT_MSG_01.09



category.

AUT_MSG_01.07

20006 The beginning date must be earlier than the

end date.

TRA_MSG_09.007




GCU_MSG_00.062

482 / 557



{0}.

"GCU_MSG_100.001 - Control required on the





AUT_MSG_29.06



483 / 557


2.7.1.4 Download requests

This method allows to download a request and its attachments in PDF format.

Input table



idSollicitation Number: technical

identifier of the

request within the

CPP 2017 system

integer

1

pieceJointe String:

downloading the

attachments of the

request

varchar(

5)


values:

- OUI [YES]

- NON [NO]

1

Output table


rules Multiplicity

sollicitationFichier String: PDF file generated

and base64-encoded

attachment

base64

1

listePieceJointe 0-n

pieceJointe String: file containing the

base64-encoded

attachmentof the request

base64

1

Error table



{0} = "IdSollicitation"


the request.

AUT_MSG_03.10

20002 Updating impossible. The status of the request

{0} does not allow an updating.

AUT_MSG_04.04

{0}= "IdSollicitation"

20003 Generation of PDF file failed. AUT_MSG_13.01




AUT_MSG_29.06



484 / 557


2.7.1.5 Consult requests

The consulterSollicitation method allows to consult a selected request, issued or received.

Input table



idSollicitation Number: technical

identifier of the

request within the

CPP 2017 system

integer

1

contexte

String: context of consultation

varchar(

5)

Enumeration with 2 possible values: - EMISE [ISSUED] - RECUE [RECEIVED]

1

Output table


rules Multiplicity

informationsGenera

les

numeroSollicitation String: functional



varchar(20)

1

statut String: request status varchar(50) 1

categorieId Number: technical

identifier of the category

integer 1

categorieCode String: code of the

request category

varchar(200

)

1

categorieLibelle String: label of the

request category

varchar(200

)

1

ssCategorieId Number: technical

identifier of the

subcategory

integer

1

ssCategorieCode String: code of the

request subcategory

varchar(200

)

1

ssCategorieLibelle String: label of the

request subcategory

varchar(200

)

1

dateDeSaisie Date: creation date of the

request

Date Date field: AAAA-MM-JJ or AAAA-MM-JJTHH:MM:SS+HH:MM

1

dateDeCloture Date: report date of the

request

Date Date field: AAAA-MM-JJ or AAAA-MM-JJTHH:MM:SS+HH:MM Only for received requests.

0-1

typeObjet String: type of the object

concerned by the request

varchar(201

)

Only for received requests.

0-1


object number (payment

varchar(20) 0-1

485 / 557


request, commitment…)

associated to the request

acteur String: name and

surname of the request

depositor

varchar(255

)

0-1

Issuing structure

structureEmettrice

idStructureEmettrice Number: technical


within the CPP 2017

system

integer

1


String: identifier type of

the structure

varchar(14) Enumeration of the identifier types

1


String: functional

identifier of the

structure

varchar(80)

1

designationStructureE

mettrice String: designation of

the structure

varchar(201

)

1

idServiceStructureEme

ttrice

Number: technical




uniquely identifies a service within the CPP 2017 system.

0-1

codeServiceStructureEmettrice

String: service code varchar(100

)

0-1

nomServiceStructureEmettrice

String: name of the

service

varchar(100

)

0-1

Recipient structure

structureDestinatai

re

idStructureDestinataire Number: technical


within the CPP 2017

system

integer

0-1


String: identifier type of

the structure

varchar(14) Enumeration of the identifier types

0-1


String: functional

identifier of the

structure

varchar(80)

0-1

designationStructureDestinataire


the structure

varchar(201

)

0-1

idServiceStructureDestinataire

Number: technical



integer This identifier uniquely

identifies a service within the CPP 2017 system.

0-1

codeServiceStructureDestinataire

String: service code varchar(100

)

0-1

nomServiceStructureDestinataire

String: name of the

service

varchar(100

)

0-1

Request

description String: description of the

request

long

varchar(400

0)

1

486 / 557


commentaire String: comments and

answer to the request

long

varchar(400

0)

0-1

historique String: request history long

varchar(400

0)

Technical data concatenated for each History associated to the request

0-1

HistoriqueDetaille

historiqueDetaille 0-1

ligneHistoriqueDetaille 0-n

Date : date of creation of

the history line date

Date format : AAAA-MM-JJ or AAAA-MM-JJTHH:MM:SS+HH:MM

0-1

String : name of the user

associated to the

historized operation

varchar(201

) 0-1

String : value of the

status preceding the


varchar(50) 0-1

String : value of the

status following the


varchar(50) 0-1

String : comment of the


long

varchar(400

0)

0-1

Attachment

pieceJointe String: file containing the

attachment of the

request, base64-encoded

base64

0-1

Error table


20001 You have not the necessary clearances to

consult the request {0}.

AUT_MSG_29.04

{0}= request identifier



20003 The request {0} does not exist in this context. AUT_MSG_29.05


20004

The Request area is under maintenance. In case



AUT_MSG_29.06



487 / 557


2.7.2 Issued requests

2.7.2.1 Enter a request

This method allows to enter and submit a request.

Input table


Service

providing

the data

Multiplicity


Number: technical

identifier of the

issuing structure to

modify in the CPP

2017 system

integer This identifier uniquely identifies a


Required :


OR

identifier type + identifier of the

structure

0-1



of the issuing

structure

Varchar

(15)

Enumeration TypeIdentifiant

Required:

Technical identifier of the structureOR

identifier type + functional identifier of

the structure

0-1


String: functional

identifier of the

issuing structure

Varchar

80)

Required:

technical identifier of the structure

OR

identifier type + functional identifier of

the structure

0-1

idServiceEmetteur

Number: technical

identifier of the

service to modify in

the CPP 2017 system

Integer This identifier uniquely identifies the

service of a structure issuing the request

within the CPP 2017 sytem.

0-1

idCategorie Number: technical

identifier of the

request category

integer The Category concept allows to save

request categories.

The categories MEMJUST and REMBTIC

are forbidden.

RecupererCa

tegorieSollici

tation 1

idSousCategorie

Number: technical

identifier of the

request subcategory

integer The Subcategory concept allows to

define the available subcategories

according to the connected access mode

and the request category.

RecupererSo

usCategorie

Sollicitation 1

description Description of the

request

Varchar

(4000)

1

typeObjet Functional object

type linked to the

request: invoice,

work invoice and

commitment

Varchar

(30)

Enumeration TypeObjet

- FACTURE [INVOICE]

- FACTURE_TRAVAUX [WORK INVOICE]

- EJ [COMMITMENT]

0-1

488 / 557


numeroObjet

Reference number of

the concerned object

(cf. typeObjet).

Varchar

(20)

This number allows to retrieve the

issuing service code if defined and to

retrieve the identifier of the recipient

structure and its service code.

0-1


Number: technical

identifier of the

recipient structure to

modify in the CPP

2017 system

integer This identifier uniquely identifies a


Required :


OR

identifier type + identifier of the

structure

The recipient structure is required for

the request category « Metier Autre »

[Other function].

0-1


String: énumération

des possible values

de type d'identifiant

Varchar

(15)

Enumeration TypeIdentifiant

Required:


OR

functional identifier of the structure +

identifier type



[Other function].

0-1


String: functional

identifier of the

issuing structure

Varchar

(80)

Required:


OR

functional identifier of the structure +

identifier type



[Other function].

0-1


Number: technical

identifier of the

concerned recipient

service (according to

the typeObjet).

Integer This identifier uniquely identifies the

recipient service.

The recipient service is required when

the recipient is the State.

0-1

pieceJointeId

Number:identifier of

the attachment of the

requesting obect

Integer AjouterFichie

rDansSystè

me

0-1

Output table

Attribute Typing (tagger) Format Managem

ent rules Multiplicity

identifiant Number: Technical identifier of the

created request integer

1

489 / 557


Error table


20002 This number does not correspond to any object. AUT_MSG_01.03


the object.

AUT_MSG_02.08

20004 You are not connected to the requesting

structure.

AUT_MSG_03.10

20005 The informations of recipient structures do not

allow to retrieve the recipient. Please check your

entry.

AUT_MSG_02.06



AUT_MSG_01.09


category.

AUT_MSG_01.07


20009 The recipient structure is required for the

request category whose type is {0}

AUT_MSG_03.06

{0} = Metier Autre [Other function]

20010 The recipient service is required when the

recipient is the State.

AUT_MSG_03.07

20011 The recipient service {0} does not correspond to

the recipient structure {1}.

GFT_MSG_01.033

{0} = Service

{1} = Structure

To control on the issuing and recipient services.

20012 The selected category requires the entry of the

type of object concerned by the request.

AUT_MSG_03.08



GCU_MSG_00.062 – Controls required on



{0}.



{0} = IdStructureEmettrice or

IdStructureDestinataire

20015 The attachment {0} has not been found. GDP_MSG_11.041

{0} = attachment identifier

20016 This category does not exist. AUT_MSG_01.05




AUT_MSG_29.06



490 / 557


2.7.3 Received requests

2.7.3.1 Answer a request

This method allows a recipient to answer a request.

Input table




identifier of the

request

integer

1


the request

statuses, viewable

by a recipient

Varchar

(50)


following values :

ETAT_DEPOSANT_AFFECTE ETAT_DEPOSANT_PRISE_EN_COMPTE ETAT_DEPOSANT_REPONDUE ETAT_DEPOSANT_REOUV

ERTE ETAT_DEPOSANT_EN_COURS ETAT_DEPOSANT_EN_ATTENTE_INFOS ETAT_DEPOSANT_REPONDUE_MAUVAISE_CATEGORIE ETAT_DEPOSANT_COMPLETE ETAT_DEPOSANT_CLOSE

1

commentaire Texte: comments

associated to the

update

Varchar

(4000)

AjouterFichierDansS

ysteme 1

pieceJointeId Integer: identifier

of the attachment

of the requesting

obect

Integer

0-1

Output table


rules Multiplicity

Error table



{0} = "IdSollicitation" [Request identifier]


the request.

AUT_MSG_03.10

20002 Updating impossible. The status of the request

{0} does not allow an updating.

AUT_MSG_04.04

{0}= "IdSollicitation" [Request identifier]

491 / 557


20003 Please enter at least 3 characters in the field

{0}.

TRA_MSG_00.024

{0} = "Commentaire" [Comments]

20004 The attachment {0} has not been found. GDP_MSG_11.041

{0} = PieceJointeId [Attachment identifier]




AUT_MSG_29.06



492 / 557


2.8 Cross-functional and reference services

2.8.1 Manage the attachments

This chapter indicates the input, output and error tables for the following service :

- Add file in the system

- Bind an attachment to a structure

- Bind an attachment to a user

- Search for an attachment in My account

- Search for an attachment in a structure

- Download an attachment

2.8.1.1 Add file in the system

The method ajouterFichierDansSysteme allows to add an attachment in the current user account and obtain its

technical identifier. The attachment size must be lower than 10 Mb. If not, an error 20003 will be returned.

Input table


pieceJointeFichier

String: file containing the

base64-encoded

attachment

file 1

pieceJointeNom

String: name of the

attachment without its

extension

varchar(50) 1

pieceJointeTypeMime

String: data format of the

attachment

Varchar

(255) 1

pieceJointeExtension

String: extension of the

attachment varchar(5)

List of extensions authorized by

Chorus Pro:

BMP;HTM;FAX;PNG;XHTML;BZ2;JPEG;

PPS;XLC;CSV;JPG;PPT;PPTX ;XLM;DOC

;ODP;RTF;XLS;GIF;ODS;SVG;XML;GZ;

ODT;TGZ;XSD;GZIP;P7S;TIF;XSL;HTM

L;PDF;TXT;ZIP ;TIFF,XLSX;DOC ;DOCX

1

Output table

Attribute Typing (tagger) Format Multiplicity

pieceJointeId Number: Technical identifier of the attachment

in the CPP 2017 system integer 0-1

Error table



or is not active.

GCU_MSG_05.009

20001 This file contains a virus. TRA_MSG_00.002

20002 The size of the file’s name (without

extension) is greater than 50 characters. TRA_MSG_00.004

493 / 557


20003 The size of the file is greater than the

maximum allowed one. TRA_MSG_00.003

20004 A file with this name already exists. TRA_MSG_00.013

20005 The extension of the attachment is not

allowed by the system. TRA_MSG_10.001

20006 The name of the attachment must be

entered. TRA_MSG_00.021

20007 The input-supplied file encoding does not

conform to the encoding standard (base64) TRA_MSG_00.020

494 / 557


2.8.1.2 Get attachment out

The method detacherPieceJointe allows to get an attachment out of a structure or a user account. A getting-out

attachment is deleted after a 24-hour delay.

Input table



idPieceJointeObjet


the link between the

attachment and the

functional concept

(structure, user, …)

in the CPP 2017

system

integer

RechercherPieceJoin

teStructure ou

RechercherPieceJoin

teSurMonCompte

1

Output table


Error table


20000 No attachment found. TRA_MSG_00.005

20001 The user {0} has not the necessary

clearances to delete the attachment {1}.

GDP_MSG_11.057 - SXP uniquement

{0} = Name and surname of the user

{1} = identifier of the object attachment

495 / 557


2.8.1.3 Bind an attachment to a structure

The method lierPieceJointeStructure allows to bind an attachment to a structure.

Input table



idPieceJointe Technical identifier of

the attachment integer


1

idStructure Technical identifier de

la structure integer

Required:

Technical

identifierORIdentifier

type +


RechercherStructure 0-1

typeIdentifian

tStructure

Identifier type of

structure

varchar(5

0)

Enumeration

"TypeIdentifiant"

Required:

Technical


type +


RecupererStructures

PourValideur 0-1



of the structure

varchar(8

0)

Required:

Technical


type +


RecupererStructuresPourValideur

0-1

designation Designation of the

attachment

varchar(2

55) 1

typePieceJointe


the attachment type integer

The attachment type

must have an object

type"structure"

(TypePieceJointe.type

Objet = STRUCTURE)

RecupererTypePieceJointe

1

Output table


496 / 557


Error table


20000 The structure does not exist. GCU_MSG_00.014

20001 The parametered attachment does not

exist. GDP_MSG_11.041

20002 The user {0} is not primary or secondary

manager of the structure {1}. GCU_MSG_06.003

20003



structure.


20004 The attachment type is not valid. TRA_MSG_00.029

20005 The quantity of free space available ({0}

Mb) in this structure is reached.

TRA_MSG_00.031

{0} =

FICHIER_TAILLE_DOSSIER_PJ_STRUC

20006 The attachment {0} is already used.

TRA_MSG_00.017

{0} = technical identifier of the

attachment

497 / 557


2.8.1.4 Bind an attachment to a user

The method lierPieceJointeUtilisateur allows to bind an attachment to the account of the primary manager linked to

the technical account..

Input table



idPieceJointe Technical identifier of

the attachment integer

AjouterFichierDansS

ysteme 1

designation

Designation of the attachment

varchar(2

55) 1

typePieceJointe


the attachment type integer

The attachment type

must have an object

type"utilisateur"

(TypePieceJointe.type

Objet =

UTILISATEUR).

RecupererTypePiece

Jointe 1

Output table


Error table


20000 The parametered attachment does not

exist. GDP_MSG_11.041

20001 The attachment type is not valid. TRA_MSG_00.029

20002

The quantity of free space available

({0} Mb) in this user account is

reached.

TRA_MSG_00.030

{0} =

FICHIER_TAILLE_DOSSIER_PJ_UTILISATEUR

20003 The attachment {0} is already used. TRA_MSG_00.017

{0} = technical identifier of the attachment

498 / 557


2.8.1.5 Search for an attachment on My account

The method rechercherPieceJointeSurMonCompte allows to search for an associated file to the user account.

Input table



Service

providing

the data

Multiplicity

pieceJointeTypeId

Integer:

Technical

identifier of the

attachment type

integer

recuperer

TypesPiec

eJointe

0-1

pieceJointeDesignation

String: free

description of

the attachment

Varchar

(100)

For this field, the

system authorizes the

jocker « * ».

0-1

codeLangue

String: code of

the language

used in the

multilingual

descriptions

varchar(2)


language is chosen or

supported by the

system, the

descriptions are

written in french.

0-1


parametresRecherche

0-1

pageResult

atDemande

e

Number:

number of the

result page to be

displayed



nbResultats

Parpage

Number:

number of

results per page

that can be

returned by the

research

integer

By default, the

service returns 10

results per page.

0-1


order varchar(10)


possible values:

- ascending sorting

- downward sorting

By default, the


0-1

triColonne

String:

reference

column of the

sorting

-

Enumeration with 4

possible values:

-

pieceJointeTypeCode

-

0-1

499 / 557


pieceJointeTypeLibelle

-

pieceJointeDesignatio

n

-

pieceJointeExtension

By default, the


on the field

"pieceJointeDesignati

on".

Output table


parametresRet

our

0-1



pages

Number: Number of


research

integer 0-1

nbResultatsP

arpage

Number: number of


total

Number: Number of


research

integer 0-1

List of attachments to be displayed

listePiecesJoint

es list 0-n

pieceJointeOb

jetId

Number: technical

identifier of the link

between the

attachment and the

functional concept

(structure, user, …) in

the CPP 2017 system

integer 1

pieceJointeId

Number: Technical ID

of the attachment in

the system CPP

integer 1

pieceJointeTy

peCode

String: code of

attachment’s type varchar(30) 1

pieceJointeTy

peLibelle

String: description of

the attachment’s type varchar(50)

Description of the

attachment’s type

depending on the

parametered language.

1

pieceJointeDe

signation

String: free description


pieceJointeEx

tension


attachment varchar(5) 1

500 / 557


pieceJointeUti

lisateurId

Number: technical

identifier of the user

within the CPP 2017

system

integer



the 2017 CPP system.

1

Error table


20000 No result found GCU_MSG_05.036



20002 The type of attachment is not CPP-referenced. GCU_MSG_05.034

501 / 557


2.8.1.6 Search for an attachment in a structure

The method rechercherPieceJointeStructure allows to search for an attachment associated to a structure connected

to the user.

Input table



Service

providing

the data

Multiplicity

idStructureCPP

Number:

technical

identifier of the

structure within

the CPP 2017

system. The

attachments will

be search in this

structure.

integer




CPP 2017 system.

rechercherS

tructure 1

pieceJointeTypeId

Integer:

Technical

identifier of the

attachment type

integer

recupererTy

pesPieceJoi

nte

0-1


String: free

description of

the attachment

Varchar

(100)

For this field, the

system authorizes the

jocker « * ».

0-1

codeLangue

String: code of

the language

used in the

multilingual

descriptions

Varchar

(2)


language is chosen or

supported by the

system, the

descriptions are written

in french.

0-1


parametresRecherche

0-1

pageResult

atDemande

e

Number:

number of the

result page to be

displayed



nbResultats

Parpage

Number:

number of

results per page

that can be

returned by the

research

integer



page.

0-1


order

varchar(

10)


possible values:

- ascending sorting

- downward sorting

0-1

502 / 557



is downward.

triColonne

String:

reference

column of the

sorting

-

Enumeration with 6

possible values:



-



-

pieceJointeStructureCo

de

-

pieceJointeStructureRai

sonSociale


is performed on the

field

"pieceJointeDesignation

".

0-1

Output table


parametresRe

tour

0-1



pages

Number: Number of


research

integer 0-1

nbResultatsP

arpage

Number: number of


total

Number: Number of


research

integer 0-1

List of attachments to be displayed

listePiecesJoi

ntes liste 0-n

pieceJointeOb

jetId

Number: technical

identifier of the link

between the attachment

and the functional

concept (structure, user,

…) in the CPP 2017

system

integer 1

pieceJointeId

Number: Technical ID of

the attachment in the

system CPP

integer 1

503 / 557


pieceJointeTy

peCode

String: code of

attachment’s type varchar(30) 1

pieceJointeTy

peLibelle

String: description of the

attachment’s type varchar(50)

Description of the

attachment’s type

depending on the

parametered language.

1

pieceJointeDe

signation

String: free description


pieceJointeEx

tension


attachment varchar(5) 1

pieceJointeSt

ructureId

Number: technical


within the CPP 2017

system

integer




2017 structure.

1

pieceJointeSt

ructureCode

String: functional

identifier of the structure varchar(80) 1

pieceJointeSt

ructureRaison

Sociale

String: corporate name

of the structure varchar(99) 0-1

Error table


20000 The user is not registered in the application. GCU_MSG_00.008

20001 No structure found for this identifier. GCU_MSG_00.014



20003 No result found GCU_MSG_00.027

20004 The type of attachment is not CPP-referenced. GCU_MSG_05.034

504 / 557


2.8.1.7 Download an attachment

The method telechargerPieceJointe allows a user to download the attachments whose types are the following :

requests, reimbursement requests, invoices, work invoices, justice costs, bank details, structure, mandate, (current)

user, commitment.

Input table


te

Sous-

Subattribut

e

Typing

(tagger) Format

Management

rules

Service

providing

the data

Multiplicity

objetPieceJoi

nte

Identifier of

tha

attachment

type to

download

varchar(

30)

Enumeration

with 7 possible

values:

-

DEMANDE_PAI

EMENT

-

ENGAGEMENT_

JURIDIQUE

-

SOLLICITATIO

N

-

STRUCTURE_PI

ECEJOINTE

-

STRUCTURE_M

ANDAT

-

STRUCTURE_C

OORDONNEE_

BANCAIRE

- UTILISATEUR

1

Request

sollicitation

Required if

"SOLLICITATIO

N" is entered in

the field

TypePieceJoint

e

0-1

idSollicitat

ion

Technical

identifier of

the request

within the CPP

2017 system

integer 1

pieceJoint

eSollicitati

on

Indicates if

the

attachments

must be

downloaded

varchar(

3)

Enumeration

with 2 possible

values:

- OUI [YES]

- NON [NO]

1

505 / 557


with the

request

Payment request

demandePaiement

Required if

"DEMANDE_PAI

EMENT"

entered in the

field

TypePieceJoint

e

0-1

format

Format of the

downloaded

invoices or

work invoices

varchar(

5)

Enumeration

with 2 possible

values:

- PDF

- PIVOT

1

avecPiece

sJointesCo

mplement

aires

Indicates if

the

complementa

ry

attachments

must be

retrieved

(only if

Format =

"PDF")

varchar(

3)

Ce paramètre

doit être

renseigné

uniquement si

Format = «

PDF ».

Enumeration

with 2 possible

values:

- OUI [YES]

- NON [NO]

If the

parametered

format is«

PIVOT »,the

attachments

are

downloaded.

0-1

listeFactur

e 1

idFacture

List of

technical

identifiers of

invoices and

work invoices

within the

CPP 2017

system

integer

(list)

These

identifiers

uniquely

identify the

invoices and

work invoices

within the CPP

2017 system.

1-n

506 / 557


Commitment

engagementJuridique

Required

if"ENGAGEMEN

T_JURIDIQUE"

entered in the

field

TypePieceJoint

e

numeroEn

gagement

Juridique

Technical

identifier of

the

commitment

within the

CPP 2017

system

integer

This identifier

uniquely

identifies the

commitment

within the CPP

2017 system.

0-1

Structure

structure

Required if

"STRUCTURE_

PIECEJOINTE"

or

"STRUCTURE_

MANDAT" or

"STRUCTURE_

COORDONNEE

_BANCAIRE"

selected

0-1

idStructure

Technical

identifier of

the structure

within the

CPP 2017

system

integer

This technical

identifier

uniquely

identifies the

structure within

the CPP 2017

structure

Required:

technical

identifier

OR

identifier type

of structure +

functional

identifier of

structure

RechercherS

tructure 0-1

typeIdentif

iantStructu

re

Identifier type

of structure

varchar(

50)

Enumeration

TypeIdentifiant

Required:

technical

identifier

OR

RechercherS

tructure 0-1

507 / 557


identifier type

of structure +

functional

identifier of

structure

identifiantS

tructure

Functional

identifier of

the structure

varchar(

80)

Required:

technical

identifier

OR

identifier type

of structure +

functional

identifier of

structure

RechercherS

tructure 0-1

Output table


pieceJointe

String: binary base64-encoded file

base64

If "DEMANDE_PAIEMENT" [PAYMENT_REQUEST] selected in the field TypePieceJointe then: • If "Format" = "PDF" and "AvecPiecesJointesComple

mentaires" = "OUI": if there is only one invoice, then the service returns a ZIP file with the PDF invoice and its complementary attachments. If not, the service returns a ZIP file with a directory per invoice which contains the PDF invoice and its complementary

attachments. • if "Format" = "PDF" and "AvecPiecesJointesComplementaires" = "NON":if there is only one invoice, the service returns the PDF file ; if not, the service returns a ZIP file with all the PDF invoices.. • if "Format" = "PIVOT": the service returns the

PIVOT file of the invoices with all their complementary attachments. If "ENGAGEMENT_JURIDIQUE" selected in the field TypePieceJointe then: the service returns a ZIP file containing : - the attachments of the

commitment if it have attachments ;

1

508 / 557


If "SOLLICITATION" selected in the field TypePieceJointe then:

the service returns a ZIP file containing : - a request file PDF-generated - the attachments if PieceJointeSollicitation = OUI and if the request have attachments ; If "STRUCTURE_PIECEJOINTE" selected in the

field TypePieceJointe then : the service returns a ZIP file containing: - the attachments of the structure if they exist ; If "STRUCTURE_COORDONNEE_BANCAIRE" selected in the field TypePieceJointe then :

the service returns a ZIP file containing : - the bank details of the structure if they exist ; If "STRUCTURE_MANDAT" selected in the field TypePieceJointe then : the service returns a ZIP file containing :

- the mandates of the structure if they exist ; If "UTILISATEUR" selected in the field TypePieceJointe then : the service returns a ZIP file containing : - the user attachments if they exist.

Error table


20001 No attachment found. TRA_MSG_00.005

TRA-CU-00-SER-03

20002 The field {0} is required.

GCU_MSG_05.019

{0}= label of the required field

20003 The user {0} has not the necessary

clearances to download the attachment {1}.

TRA_MSG_00.026

TRA-CU-00-SER-03

{0}= attachment type

{1}= user identifier

509 / 557


20004 {0} not found.

TRA_MSG_00.027

{0}= parametered identifier

20005 You have not the necessary clearances to

consult the request {0}.

AUT_MSG_29.04 - request


20006 The request {0} does not exist.



20007 Generation of PDF file failed. AUT_MSG_13.01 - request

20008

The Request area is under maintenance. In case






20009 The maximum number of payment requests

that can be downloaded is XX.

GDP_MSG_11.009 - invoice

GDP-CU-11-RGD-36

Maximum number of payment requests that

can be downloaded.

20010 The payment request {0} has not been

found.


{0}= parametered payment request

20011

The user has not the necessary clearances to

download.

The downloding of invoice requires a valid

connection between the user and one of the

following services and structures:

-

- Service or structure of the supplier ;

- Structure of the first validator ;

- Structure of the second validator ;

- Service or structure of the Porject

Manager ;

- Service or structure of the Contracting

Authority ;

- Recipient service or structure.

Moreover, the user must be « ACTIF

» [ACTIVE].

GDP_MSG_11.005 - facture

GDP-CU-11-RGD-54

20012

The status (DemandePaiement.etatCourant)

of the payment request in the database must

not be equal to:

- « BROUILLON » [DRAFT]

- « SUPPRIME » [DELETED]


20013 Returning an error or no response from the

SMA TRA_MSG_00.007 - invoice

20014 No structure found for the identifier {0}.

GCU_MSG_00.014 - structure

{0} = [identifier]


and a functional identifier of a structure. GCU_MSG_00.060 - structure

20016 The commitment {0} has not been found. GEJ_MSG_01.004 - ej

GEJ-CU-01-SER-02

510 / 557


{0}= parametered commitment identifier

20017

L'utilisateur {0} n'a pas les habilitations

nécessaires pour consulter les engagements

de la structure {1}

GEJ_MSG_01.003 - commitment

GEJ-CU-01-SER-02


{1}=Structure.identifiant

20018

The structure {0} has not any payment

request whose status is "Mise en paiement"

[Payment] in Chorus Pro. Thus its

commitment numbers are not available.

GEJ_MSG_01.006 - commitment

GEJ-CU-01-SER-02


511 / 557


2.8.2 Search for elements in the directory


- Search for a recipient

- Search for an executing service

- Retrieve executing services of the State

- Retrieve services by structure

- Retrieve active structures for recipient

- Retrieve active structures for work invoices

- Retrieve active structures for supplier

- Retrieve users of the service

2.8.2.1 Search for a recipient

The method rechercherDestinataire allows to search for the legal informations of a public structure.

Input table



Service

providing

the data

Multiplicity

identifiant

String:

identifier of the

recipient

structure

varchar(80

) Alphanumeric value 0-1

nomVilleCodePostal

String:string of

characters

corresponding

to:

- the corporate

name of the

structure

- the name of

the structure

deputy

- the city of

the structure

address

- the postal

code of the

structure

address

varchar(10

0)

The system searches

the recipients whose

informations contain

the string of

characters entered

here. The fields

among informations

are the following ::

- Structure.nom

[name of the

structure]

-

Structure.raisonSocial

e [registration name

of the structure]

-

Structure.adresse.vill

e [city of the

structure address]

-

Structure.adresse.cod

ePostal [postal code

of the structure

address]

The system

0-1

512 / 557


authorizes the joker «

* ».


parametresRec

herche

0-1

pageResultat

Demandee

Number:

number of the

result page to

be displayed



nbResultatsP

arpage

Number:

number of

results per

page that can

be returned by

the research

integer

By default, the

service returns 10

results per page.

0-1


order

varchar(10

)


possible values:

- ascending sorting

- downward sorting

By default, the


0-1

triColonne

String:

reference

column of the

sorting

-

Enumeration with 4

possible values:

- Siret

- NomDestinataire

- AdresseCodePostal

- AdresseVille

By default, the


on the field "Siret".

0-1

Output table


parametresRet

our

0-1



pages

Number: Number of

pages returned by

the research

integer 0-1

nbResultatsPar

page

Number: number of


total

Number: Number of

results returned by

the research

integer 0-1

513 / 557


List of recipients

listeDestinatair

es liste

Only public structures without

the indicator

estMOAuniquement [with

Contracting Authority only].

0-n

idStructureCPP

Number: technical

identifier of the


CPP 2017 system

integer


identifies the structure within

the CPP 2017 structure

1

siret String: identifier of

the structure

varchar(


nomDestinatair

e

String: corporate

name OR name of

the structure deputy

varchar(

100)


characters which corresponds to

the corporate name of the

structure or the name of its

deputy.

0-1

adresseCodePo

stal

String: postal code

of the structure

varchar(

10) 0-1

adresseVille String: city of the

structure address

varchar(

50) 0-1

Error table


20000 There is not any recipient corresponding to

the criteria entered. GDP_MSG_11.048

20001

The SIRET number is not registered in the

table of possible recipients. Please contact the

support service if you want to add it.

GDP_MSG_11.049

514 / 557


2.8.2.2 Search for an executing service

The method rechercherServiceExecutant permet de rechercher les services d’une structure publique

Input table



Service

providing

the data

Multiplicity

idDestinatair

eCPP

Number: technical

identifier of the

recipient within the CPP

2017 system

integer

This technical

identifier uniquely

identifies the


CPP 2017 structure

rechercherD

estinataire 1


String: code of the

recipient structure’s

executing service

varcha


nomServiceExecutant

String: name of the


executing service

varcha


actif

String: indicates if you

need only the active

services or the inactive

ones too.

If no value is entered in

this field, all the

services are returned.

Boolea

n Boolean 0-1


parametresRecherche

0-1

pageResul

tatDeman

dee


result page to be

displayed



nbResultat

sParpage

Number: number of



research

integer

By default, the

service returns 10

results per page.

0-1

triSens String: sorting order varcha

r(10)


possible values:

- ascending sorting

- downward sorting

By default, the


0-1



Enumeration with 2

possible values:

-

CodeServiceExecutant


0-1

515 / 557


By default, the


on the field

"CodeServiceExecuta

nt".

Output table



parametre

sRetour

0-1

pageCour

ante





nbResultat

sParpage





List of services to display

listeServic

es liste

List of services corresponding to

the input criteria and which are not

defined as the default service.

0-n

idServices

CPP


of the executing service

within the CPP 2017 system

integer



system.

1

codeServi

ceExecuta

nt

String: code of the recipient

structure’s executing service

varcha


nomServic

eExecutan

t

String: name of the


executing service

varcha


Error table



516 / 557


2.8.2.3 Retrieve executing services of the State

The method recupererServicesExecutantEtat allows to retrieve the identifying informations of all the executing

services of the State

Input table


rules


data Multiplicity

No input attribute

Output table


listeServices liste

List of the services whose status

is ACTIF [ACTIVE] and

belonging to the State whose

identifier is the following SIRET

number "11000201100044"

0-n

idServicesCPP

Number: technical

identifier of the


2017 system

integer



system.

1

codeService

String: code of the

executing service

whose structure has

been parametered

varchar(


nomService

String: name of the

executing service

whose structure has

been parametered

varchar(


Error table



517 / 557


2.8.2.4 Retrieve services by structure

The method recupererServicesParStructure allows to retrieve the identifying informations of all the services of a

structure to which a user is connected.

Input table


rules Service providing the data Multiplicity

idStructureCPP

Number: technical

identifier of the


CPP 2017 system

integer

This technical

identifier

uniquely

identifies the

structure

within the CPP

2017 structure

RechercherStructure

RecupererStructuresActivesPo

urFournisseur

RecupererFournisseursPourVal

ideur

RecupererStructuresActivesPo

urDestinataire

1

Output table


listeServices liste

List of the active services of the

structure to which the user is

connected.

0-n

idServicesCPP

Number: technical

identifier of the


2017 system

integer



system.

1

codeService

String: code of the

executing service

whose structure has

been parametered

varchar(


nomService

String: name of the

executing service

whose structure has

been parametered

varchar(


Error table




20001

The structure does not exist or is duplicated. GCU_MSG_05.029

20002 The user is not connected to the structure. GCU_MSG_05.026


2.8.2.5 Retrieve active structures for recipient

518 / 557


The method recupererStructuresActivesPourDestinataire allows to retrieve the list of active structures to which a user

is connected and authorized on « Factures reçues » [Received invoices] area.

Input table


Output table


listeStructures liste

List of the identifiers of


connected and authorized on

the "Factures reçues" [Received

invoices] area.

0-n

idStructureCP

P

Number: technical

identifier of the


CPP 2017 system

integer




1

identifiant

String: functional

identifier of the

structure

varchar(


designationSt

ructure


the structure

varchar(

201)






deputy.

1

Error table


20000 You are not authorized on the area factures POQ_MSG_02.022

519 / 557


2.8.2.6 Retrieve active structures for work invoices

The method recupererStructuresActivesPourFacturesTravaux allows to retrieve the list of active structures to which a

user is connected and has the necessary clearances on the « factures de travaux » [Work invoices] area.

Input table


rules


data Multiplicity

No input attribute

Output table



List of the identifiers of


connected and has the

necessary clearances on the

"Factures de travaux" [Work

invoices] area.

0-n

idStructureCP

P

Number: technical

identifier of the


CPP 2017 system

integer




1

identifiant

String: functional

identifier of the

structure

varchar(


designationSt

ructure


the structure

varchar(

201)






deputy.

1

Error table


20000 You are not authorized on the area POQ_MSG_02.022

520 / 557


2.8.2.7 Retrieve active structures for supplier

The method recupererStructuresActivesPourFournisseur allows to retrieve the list of active structures to which a suer

is connected and has the necessary clearances on the « Factures émises » [Issued invoices] area.

Input table


Output table



List of the identifiers of structures to which the user is connected and has the necessay clearances on the "Factures émises" [Issued invoices] area.

0-n

idStructureCP

P

Number: technical

identifier of the


CPP 2017 system

integer




1

identifiant

String: functional

identifier of the

structure

varchar(8

0) 1

designationSt

ructure

String: designation

of the structure

varchar(2

01)






deputy.

1

Error table


20000 You are not authorized on the “Issued

invoices”area POQ_MSG_02.022

521 / 557


2.8.2.8 Retrieve users of the service

The method utilisateursDuService allows to a manager connected to a service to retrieve the list of users connected

to this service.

Input table


idStructure

Number: technical

identifier of the

selected structure

integer



CPP 2017 structure

1

codeService String: code of the

selected service

varchar

(100) Code of the service 1


parametresRecherche

0-1

pageResultatD

emandee

Number: number of


displayed


page. 0-1

nbResultatsPa

rpage

Number: number of


can be returned by

the research




(10)


values:

- ascending sorting

- downward sorting


downward.

0-1

triColonne

String: reference

column of the

sorting

-


values:

- IdentifiantUtilisateur

- IdentifiantRattachement

- NomUtilisateur

- PrénomUtilisateur

- AdresseConnexionUtilisateur

- AdresseContactUtilisateur

- EtatCompteUtilisateur

- StatutRattachement

- DateActivation

- DateDernièreConnexion

- RôleUtilisateur

- DateDebutValiditeRattachement

- DateFinValiditeRattachement



"NomUtilisateur".

0-1

522 / 557


Output table


parametresRetour

0-1





nbResultatsParpage Number: number of results




List of the users connected to the selected service of the selected structure (if the current user is manager)

listeUtilisateursDuService liste 0-n

idUtilisateurDuService Number: technical identifier

of the service user integer 1

nomUtilisateurDuService String: name of the service

user varchar(100) 1

prenomCppUtilisateurDu

Service

String: surname of the

service user varchar(100) 1

adresseEmailConnexionC

ppUtilisateurDuService


service user varchar(200) 1

Error table



20001 The structure does not exist or is duplicated. GCU_MSG_05.029

20002 The user is not registered in the application. GCU_MSG_00.008



20004

There is no active service corresponding to

the service code entered in the selected

structure.

GCU_MSG_100.002

523 / 557


2.8.3 Table of references

This chapter indicates the input, output and error tables for the following services :

- Retrieve the invoicing framework

- Retrieve currencies

- Retrieve flow syntax

- Retrieve deposit mode

- Retrieve payment means

- Retrieve reason for VAT exemption

- Retrieve country

- Retrieve flow format

- Retrieve user statuses

- Retrieve VAT rates

- Retrieve types of payment request

- Retrieve types of work invoices

- Retrieve types of structure identifier

- Retrieve types of attachment

- Retrieve types of structure

- Retrieve valid bank details

- Search for request category

- Search for request subcategory

- Retrieve structures for user

2.8.3.1 Retrieve the invoicing framework

The method recupererCadreFacturation allows to retrieve the list of invoicing frameworks that can be entered during

an invoicing entry.

Input table


typeDemandePaiement

String: code of

the type of

payment request

varchar(26)


- FACTURE [INVOICE]

- FACTURE_TRAVAUX [WORK_INVOICE]

- MEMOIRE_JUSTICE [MEMORANDUM ON

JUSTICE COSTS]

- DEMANDE_REMBOURSEMENT

[REIMBURSMENT REQUESTS]

Depending on the type entered, the

corresponding frameworks are returned.

0-1

Output table


listeCadreFacturation list 0-n

codeCadreFacturation String: Invoicing frameworkinvoicing

framework code varchar(50) 1

Error table


524 / 557


2.8.3.2 Retrieve currencies

The method recupererDevise allows to retrieve the list of the currency codes that can be entered during an invoicing

entry (list ISO 4217).

Input table


codeLangue

String: code of the language

used in the multilingual

descriptions

varchar(2)


chosen or supported by the system,

the descriptions are written in

french.

0-1

Output table


Currency list

listeDevises 0-n

codeDevise String: currency

code varchar(3) 1

libelleDevise String: currency

description varchar(50)

Multilingual description: the returned

description depends on the

requested language in the service

parameters.

1

Error table


525 / 557


2.8.3.3 Retrieve flow syntax

The method recupererSyntaxeFlux allows to retrieve the list of XML formats that can be used according to the chosen

flow type (E1 or E2).

Input table



formatFlux

String: flow format

corresponding to

several flow syntaxes

varchar(15)

Enumeration with 2

possible values:

- IN_DP_E1_STRUCT

- IN_DP_E2_MIXTE

recupererFormatFlux 1

Output table


listeSyntaxe

Flux liste 0-n

syntaxeFlux String: flow syntax

code varchar(24)

If FormatFlux =

IN_DP_E1_STRUCT, the 4 possible

values are:


- IN_DP_E1_PES_FACTURE

- IN_DP_E1_CII_16B

If FormatFlux = IN_DP_E2_MIXTE,

the 6 possible values are:






1

Error table


526 / 557


2.8.3.4 Retrieve deposit mode

The method recupererModeDepot allows to retrieve the list of the deposit or entry modes of invoices.

Input table


rules


data Multiplicity

No input attributes

Output table


listeModeDepot liste 0-n

modeDepot String: deposit

modes varchar(50)


values:

- SAISIE_PORTAIL

- SAISIE_API

- DEPOT_PDF_PORTAIL

- DEPOT_PDF_SIGNE_PORTAIL

- DEPOT_PDF_API


- EDI

- UPLOAD_PORTAIL

- UPLOAD_API

- EDI_NUMERISATION

1

Error table


527 / 557


2.8.3.5 Retrieve payment means

The method recupererModeReglements allows to retrieve the list of values that can be entered during the invoicing

entry via API or on the Portal. These values are corresponding to the payment means of the supplier’s payment

request.

Input table


rules


data Multiplicity

No input attribute

Output table


listeModePaiem

ent liste 0-n

modePaiement String: payment

mode

varchar(

11)


values:

- CHEQUE

- PRELEVEMENT

- VIREMENT

- ESPECE

- AUTRE

- REPORT

1

Error table


528 / 557


2.8.3.6 Retrieve reason for VAT exemption

The method recupererMotifExonerationTva allows to retrieve the list of reason for VAT exemption that can be entered

during an invoicing deposit.

Input table


codeLangue



descriptions

varchar(2)



system, the descriptions are written

in french.

0-1

Output table


List of reasons

listeMotifsExon

erationTva list 0-n

codeMotifExo

nerationTva

String: code of reason

for VAT exemption

varchar(

5) 1

libelleMotifEx

onerationTva

String: reason

description for VAT

exemption

varchar(

50)

Multilingual description: the

returned description depends on

the requested language in the

service parameters.

1

Error table


529 / 557


2.8.3.7 Retrieve country

The method recupererPays allows to retrieve the list of country codes (ISO 3166 list)

Input table


codeLangue



descriptions

varchar(2)




written in french.

0-1

Output table


listePays

list of countries whose

parameter estActif is filled

with the value « Vrai »

0-n

codePays String: country code varchar(2) 1

libellePays String: label of the

country varchar(50)

Multilingual description: the

returned description depends

on the requested language

in the service parameters.

1

Error table


530 / 557


2.8.3.8 Retrieve flow format

The method recupererFormatFlux allows to retrieve the values of flow format that can be entered during an invoicing

deposit.

Input table


rules


data Multiplicity

No input attribute

Output table


listeFormatFlux list 0-n

formatFlux String: flow format varchar(

15)


values:

- IN_DP_E1_STRUCT

- IN_DP_E2_MIXTE

1

Error table


531 / 557


2.8.3.9 Retrieve flow statuses

The method recupererStatutsUtilisateur allows to retrieve the list of possible statuses for a user.

Input table



Service

providing the

data

Multiplicity

Output table

Attribute Subattributes Typing (tagger) Format Management rules Multiplicity

listeStatutsUtilisateur

0-n

statutUtilisateur Possible status

for a user

varchar(

30)

Enumeration

"EtatCompteFo" 1

Error table


532 / 557


2.8.3.10 Retrieve VAT rates

The method recupererTauxTva allows to retrieve the list of applicable VAT rates.

Input table


codeLangue



descriptions

varchar(2)



system, the descriptions are written

in french.

0-1

Output table


listeTauxTva list 0-n

codeTauxTva String: VAT rate code varchar(6) 1

libelleTauxTva String: label of the VAT rate depending on

language varchar(50) 1

valeurTauxTva String: value of the VAT rate decimal(5,2) 1

Error table


533 / 557


2.8.3.11 Retrieve types of payment request

The method recupererTypeDemandePaiement allows to retrieve the payment request types that can be entered in

the Chorus Pro system.

Input table


rules


data Multiplicity

No input attribute

Output table


listeTypeDema

ndePaiement list 0-n

typeDemande

Paiement

String: enumeration

of payment request

types

varchar(

50)


values:

- FACTURE [INVOICE]

- FACTURE_TRAVAUX [WORK

INVOICE]

- MEMOIRE_JUSTICE

[MEMORANDUM ON JUSTICE

COST]


[REIMBURSEMENT REQUEST]

1

Error table


534 / 557


2.8.3.12 Retrieve types of work invoices

The method recupererTypeFactureTravaux allows to retrieve the list of invoicing elements that can be entered during

a work invoicing file deposit.

Input table


rules


data Multiplicity

No input attribute

Output table



listeTypeFact

ureTravaux list 0-n

typeFactur

eTravaux

String:

enumeration of

work invoice

types

varchar(50)


- DP_DE_SOUSTRAITANT_TRAVAUX

- PROJET_DECOMPTE_MENSUEL

- ETAT_ACOMPTE


- PROJET_DECOMPTE_FINAL

- PROJET_DECOMPTE_GENERAL

-

PROJET_DECOMPTE_GENERAL_PROCE

DURE_TACITE

- DECOMPTE_GENERAL

- DECOMPTE_GENERAL_SIGNE

-

DECOMPTE_GENERAL_DEFINITIF_TAC

ITE

-

DECOMPTE_GENERAL_DEFINITIF_PRO

CEDURE_TACITE

1

Error table


535 / 557


2.8.3.13 Retrieve types of structure identifiers

The method recupererTypeIdentifiantStructure allows to retrieve the identifier types that can be entered by a supplier

or a validator.

Input table


rules


data Multiplicity

No input attribute

Output table


listeTypeIdentif

iant list 0-n

typeIdentifian

tStructure

String:

enumeration of

structure

identifier types

varchar(14)


values:

- SIRET

- RIDET

- TAHITI

- HORS_UE

- UE_HORS_FRANCE

- PARTICULIER

- AUTRE

1

Error table


536 / 557


2.8.3.14 Retrieve types of attachment

The method recupererTypesPieceJointe allows to retrieve the types of attachment that can be deposited depending

on the area to which the object can be connected.

Input table


typeObjet

String: type of the object

whose attachment types are

researched

varchar (30)

Possible valuesPossible values:

- STRUCTURE

- UTILISATEUR

- CB

- MANDAT

- FICHE_RACCORDEMENT

- EJ

- MEMOIRE

- DMD_RBST

- TRANSVERSE

- FACTURE_TRAVAUX

- FACTURE

- DMDE_CPTE_DEV_SI_EXT

- DMDE_ACCES_PORTAIL_TIERS

If not entered, all the types will be

returned.

0-1

codeLangue



descriptions

varchar(2)


chosen or supported by the system,

the descriptions are written in

french.

0-1

Output table


listeTypepieceJ

ointe liste

Retrieve the list of attachment

types (TypepieceJointe table)

depending on:

- the parametered type of

object (all the types if the

TypeObjet attribute is not

filled).

0-n

idTypepieceJo

inte

Integer: technical

identifier of the

attachment type in

the CPP 2017 system

Integer 1

codeTypepiec

eJointe

String: code of the

attachment type

varchar(

30) 1

libelleTypepie

ceJointe


attachment type

varchar(

50)

Label of the attachment type

depending on the parametered

language (FR if not entered).

1

537 / 557


typeObjet

String: type of the

object whose

attachment types are

researched

varchar

(30)

Possible values of the

enumeration TypeObjet

1

Error table


538 / 557


2.8.3.15 Retrieve types of structure

The method recupererTypeStructure allows to retrieve the types of the structures that can be active in the Chorus

Pro system.

Input table


rules


data Multiplicity

No input attribute

Output table


listeTypeStruct

ure list 0-n

typeStructure String: structure

type varchar(15)

Possibles values for the

enumeration "TypeStructure":

PRIVEE [PRIVATE]

PUBLIQUE [PUBLIC]

1

Error table


539 / 557


2.8.3.16 Retrieve valid bank details

The method recupererCoordonneesBancairesValides allows to retrieve the list of entered bank details for a structure

to that the current user is connected.

Input table


idStructure


of the structure in the CPP

2017 system

integer



CPP 2017 structure

1

Output table


listeCoordonneeBancaire liste 0-n

idCoordonneeBancaire Number: unique technical identifier

of the bank detail integer 1

nomCoordonneeBancaire String: name of the supplier’s bank

details

varchar(

255) 1

Error table


540 / 557


2.8.3.17 Search for request category

Le service rechercherCategorieSollicitation allows to search for the referenced values of request category,

parametered for the connected mode.

Input table


Service

providing

the data

Multiplicity

codeCategorie

String: code of the

request category

varchar(

50)

Alphanumeric

value

If no value is

entered, then the

research will be

performed

whatever the

code.

0-1

libelleCategorie


request category

varchar(

50)

Alphanumeric

value

If no value is

entered, then the

research will be

performed

whatever the

label.

0-1

estActif Booléen: category

status

boolean TRUE = the value

is active ;

FALSE = the value

is inactive ;

Empty = active or

inactive.

0-1


pagination

pageResultatDe

mandee

Number: number

of the result page

to be displayed


output is the first

page.

0-1

nbResultatsParPa

ge

Number: number

of results per page

that can be

returned by the

research

integer By default, th

service returns 10

results per page.

0-1


order

varchar(

10)

Enumeration with

two possible

values:

- ascending

sorting

- downward

sorting

0-1

541 / 557


By default, the

sorting is

downward.


column of the

sorting

varchar(

20)

Enumeration with

the attributes’

names of the

results’ list. By

default, the

sorting order is

performed on the

first attribute of


0-1

Output table


pagination 1

pageCourante



pages

Number: Number of


research

integer 1

nbResultatsParPage

Number: number of


total

Number: Number of


research

integer 1

listeCategorie

s

0-n

idTechnique Number: technical


category

integer Technical identifier of the referenced value

1

codeCategorie Text: code of the request

category

varchar(5

0)

The categories MEMJUST and REMBTIC are forbidden.

1

libelleCategorie Text: label of the request

category

varchar(5

0)

Label of the referenced value

1

dateCreation Date: creation date of the

request category

date Creation date of the referenced value

1

dateDerniereModification

Date: date of the last

modification of the request

category

date Date of the last modification of the referenced value

1

estActif Boolean: category status boolean The value is ACTIVE or INACTIVE

1

Error table



542 / 557


2.8.3.18 Search for request subcategory

Le service rechercherSousCategorieSollicitation allows to search for the referenced values of request subcategory,

parametered for the connected mode.

Input table


Service

providing

the data

Multiplicity

idTechniqueCategorie

Number: technical

identifier of the

request category

integer Empty = all

categories

Rechercher

CategorieSo

llicitation

0-1

code String: code of the

request subcategory

varchar(

50)

Alphanumeric value

If no value is

entered, then the

research will be

performed whatever

the code.

0-1

libelle String: label of the

request subcategory

varchar(

50)

Alphanumeric value

If no value is

entered, then the

research will be

performed whatever

the label.

0-1

estActif Boolean: category

status

booléen TRUE = the value is

active ;

FALSE = the value

is inactive ;

Empty = active or

inactive.

0-1


pagination

pageResultatD

emandee

Number: number of

the result page to

be displayed


output is the first

page.

0-1

nbResultatsPar

Page

Number: number of

results per page

that can be returned

by the research


service returns 10

results per page.

0-1

triSens String: sorting order varchar(

10)

Enumeration with


- ascending sorting

- downward sorting

By default, the

sorting is

downward.

0-1

543 / 557



column of the

sorting

varchar(

20)

Enumeration with

the attributes’

names of the

results’ list. By


order is performed

on the first attribute

of the results’ list.

0-1

Output table


Subattribute Typing (tagger) Format

Management

rules Multiplicity

pagination 1

pageCourante

Number: number of

the current page integer 1

pages

Number: Number of

pages returned by

the research

integer 1

nbResultatsParPage

Number: number of


total

Number: Number of

results returned by

the research

integer 1

listeSousCat

egories

0-n

categorie

idTechniqueCa

tegorie

Number: technical

identifier of the

request category


1

codeCategorie Text (50 characters) varchar(50

)

The categories MEMJUST and REMBTIC are forbidden.

1

libelleCategori

e

Text (50 characters) varchar(50

)

Label of category

1

ssCategorie

idTechniqueCa

tegorie

Number: technical

identifier of the

request subcategory


1

code Text: code of the

request subcategory

varchar(50

)

Code of the referenced value

1

libellé Text: label of the

request subcategory

varchar(50

)

Label of the referenced value

1

dateCreation Date: creation date

of the request

category

date Creation date of

the referenced value

1

dateDerniereM

odification

Date: date of the last

modification of the

request category

date Last modification date of the referenced value.

1

EstActif Boolean: status of

the category

booléen The value is active/inactive.

1

Error table


544 / 557



545 / 557


2.8.3.19 Retrieve structures for user

This method searches for structures connected to a user which has the necessary clearances on an area. If nothing

is inputed, then the SXP returns the list of structures and services to that the user is connected, directly or not.q

Input table



espaceFo

Number: technical

identifier of the FO

environment

integer

0-1

Output table


Multiplicity

listeStructures 0-*

idStructure

Number: technical

identifier of the


CPP 2017 system

integer

This technical identifier uniquely identifies the structure within the CPP 2017 structure

1

typeIdentifiantSt

ructure

String: identifier

type of the structure varchar(14) Enumeration

TypeIdentifiant 1

identifiantStructu

re

String: functional

identifier of the

structure

varchar(80) Alphanumeric value 1

designationStruc

ture

String: designation

of the structure

varchar(201

)

This data is a string of characters which corresponds to the corporate name of the structure or the concatenated name and surname of its deputy.

1

Error table


20001 Addition of complementary informations not

allowed : the user {1} is not the author of the

request {0}.

AUT_MSG_02.05


{1}= name and surname of the requestor



20003 The status of the request {0} does not allow to

add complementary informations.

AUT_MSG_02.04


20004 Attachment {0} not found. GDP_MSG_11.041

{0} = attachment identifier

546 / 557


2.8.4 References tables for processing received invoices


- Retrieve the status by type of payment request

- Retrieve possible statuses for processing

2.8.4.1 Retrieve the status by type of payment request

The method etatParTypeDemandePaiement allows to retrieve all the statuses that can be applied to a payment request

depending on the type of payment request.

Input table


typeDemandePaiement

String: type code of



- FACTURE [INVOICE]

- FACTURE_TRAVAUX [WORK INVOICE]

- MEMOIRE_JUSTICE [MEMORANDUM ON

JUSTICE COST]


[REIMBURSMENT REQUEST]

1

Output table


e

Typing


listeEtatDeman

dePaiement list 0-n

etatDemand

ePaiement

String:

possible

status of the

payment

request

varchar(50)

- if FACTURE [INVOICE] then : A_VALIDER_1 [TO VALIDATE 1] / A_VALIDER_2 [TO VALIDATE 2] SUSPENDUE [PAUSED] / A_RECYCLER [TO RECYCLE] ABSENCE_VALIDATION_1_HORS_DELAI [ABSENCE OF VALIDATION 1 AFTER DEADLINE] ABSENCE_VALIDATION_2_HORS_DELAI [ABSENCE OF VALIDATION 2 AFTER DEADLINE] COMPLETEE [COMPLETED] / COMPTABILISEE [ACCOUNTED] DEPOSEE [DEPOSITED] / EN_COURS_ACHEMINEMENT [BEING DELIVERED] ERREUR_COTRAITANT_SUR_VALIDEUR [ERROR ON VALIDATOR BY COCONTRACTOR] / ERREUR_FOURNISSEUR_SUR_VALIDEUR [ERROR ON VALIDATOR BY SUPPLIER] MISE_A_DISPOSITION [AVAILABLE TO RECIPIENT] / MISE_A_DISPOSITION_COMPTABLE [AVAILABLE TO ACCOUNTANT] MISE_EN_PAIEMENT [PAYMENT] /REJETEE [REJECTED] REFUSEE_1 [REFUSED 1] / REFUSEE_2 [REFUSED 2] SERVICE_FAIT [SERVICE RENDERED] / SUPPRIMEE [DELETED] SUSPENDUE [PAUSED] / VALIDEE_1 [VALIDATED 1]

1

547 / 557


VALIDEE_2 [VALIDATED 2] - if FACTURE_TRAVAUX [WORK INVOICE] then : BROUILLON [DRAFT] A_VALIDER_1 [TO VALIDATE 1] ERREUR_FOURNISSEUR_SUR_VALIDEUR [ERROR ON VALIDATOR BY SUPPLIER] ABSENCE_VALIDATION_1_HORS_DELAI [ABSENCE OF VALIDATION 1 AFTER DEADLINE] REFUSEE_1 [REFUSED 1] VALIDEE_1 [VALIDATED 1] A_VALIDER_2 [TO VALIDATE 2] ERREUR_COTRAITANT_SUR_VALIDEUR [ERROR ON VALIDATOR BY COCONTRACTOR]

ABSENCE_VALIDATION_2_HORS_DELAI [ABSENCE OF VALIDATION 2 AFTER DEADLINE] REFUSEE_2 [REFUSED 2] VALIDEE_2 [VALIDATED 2] A_ASSOCIER_MOE [TO ASSOCIATE WITH PROJECT MANAGER] ERREUR_DE_MOE [ERROR ON PROJECT MANAGER] REFUSEE_MOE [REFUSED BY PROJECT MANAGER] MISE_A_DISPOSITION_MOE [AVAILABLE TO PROJECT MANAGER] PRISE_EN_COMPTE_MOE [TAKEN IN ACCOUNT BY PROJECT MANAGER] A_ASSOCIER_MOA [TO ASSOCIATE WITH CONTRACTING AUTHORITY] ERREUR_DE_MOA [ERROR ON CONTRACTING AUTHORITY] REFUSEE_MOA [REFUSED BY CONTRACTING AUTHORITY] MISE_A_DISPOSITION_MOA [AVAILABLE TO CONTRACTING AUTHORITY] PRISE_EN_COMPTE_MOA [TAKEN IN ACCOUNT BY CONTRACTING AUTHORITY] A_ASSOCIER_FOURNISSEUR [TO ASSOCIATE WITH SUPPLIER] REFUSEE_FOURNISSEUR [REFUSED BY SUPPLIER] SUSPENDUE [PAUSED] A_COMPLETER [TO COMPLETE] ASSOCIEE [ASSOCIATED] DEPOSEE [DEPOSITED] MISE_A_DISPOSITION [AVAILABLE TO RECIPIENT] A_RECYCLER [TO RECYCLE] COMPLETEE [COMPLETED] REJETEE [REJECTED] SERVICE_FAIT [SERVICE RENDERED] MANDATEE [MANDATED] COMPTABILISEE [ACCOUNTED] MISE_A_DISPOSITION_COMPTABLE [AVAILABLE TO ACCOUNTANT] MISE_EN_PAIEMENT [PAYMENT]

MISE_A_DISPOSITION_MOE [AVAILABLE TO PROJECT MANAGER] - if DEMANDE_REMBOURSEMENT [REIMBURSMENT REQUEST] then (GDR-CU-01-RGD-26) then : BROUILLON [DRAFT] SUPPRIMEE [DELETED] DEPOSEE [DEPOSITED] EN_COURS_ACHEMINEMENT [BEING DELIVERED] COMPLETEE [COMPLETED]

548 / 557


SUSPENDUE [PAUSED] MISE_A_DISPOSITION [AVAILABLE TO RECIPIENT] REJETEE [REJECTED] MISE_EN_PAIEMENT [PAYMENT] VALIDEE_1 [VALIDATED 1] - if MEMOIRE_JUSTICE [MEMORANDUM ON JUSTICE COST] then : BROUILLON [DRAFT] SUPPRIMEE [DELETED] DEPOSEE [DEPOSITED] EN_COURS_ACHEMINEMENT [BEING DELIVERED] COMPLETEE [COMPLETED] SUSPENDUE [PAUSED]

MISE_A_DISPOSITION [AVAILABLE TO RECIPIENT] A_RECYCLER [TO RECYCLE] REJETEE [REJECTED] MISE_EN_PAIEMENT [PAYMENT]

Error table


549 / 557


2.8.4.2 Retrieve possible statuses for processing

The method recupererEtatsPossiblesPourTraitement allows to retrieve the list of statuses that can be entered by a

recipient who wants to process an invoice depending on the current status of this payment request.

Input table


statutCourant String: current status of

the payment request varchar(50)


- MISE_A_DISPOSITION [AVAILABLE

TO RECIPIENT]

- SERVICE_FAIT [SERVICE RENDERED]

- MANDATEE [MANDATED]

- MISE_A_DISPOSITION_COMPTABLE

[AVAILABLE TO ACCOUNTANT]



- COMPLETEE [COMPLETED]


1

Output table


listeStatutsPos

siblesPourTrait

ement

liste 0-n

statutPossible

PourTraiteme

nt

String: possible

status for the

processing of this

payment request

varchar(50)


values (GFR-CU-01-RGD-

185Bis)

• MISE_A_DISPOSITION

[AVAILABLE TO RECIPIENT]

• SUSPENDUE [PAUSED]

• REJETEE [REJECTED]

• MANDATEE [MANDATED]

• MISE_EN_PAIEMENT

[PAYMENT]

• COMPTABILISEE

[ACCOUNTED]

•

MISE_A_DISPOSITION_COMPTA

BLE [AVAILABLE TO

ACCOUNTANT]

• A_RECYCLER [TO RECYCLE]

1

Error table


550 / 557


551 / 557


3 TRACK CHANGES

Version - Date Issuer Status/Track changes

V4.10

14/11/2018 AIFE

Modification of the services consulterFactureParFournisseur,

completerFacture, refuserFactureTravaux and recyclerFactureTravaux :

Update of the input data table (deletion of the attributes numeroFacture,

identifiantFournisseur and typeIdentifiantFournisseur)

Correction of the service recyclerFacture :

Addition of the following error messages : from 20004 to 20014

Correction of the service soumettreFacture :

The pieceJointePrincipaleId attribute can also be provided by the service


Update of the input data table (management rules and multiplicity of the

montantTtcTotal attribute, management rules of the montant RemiseGlobaleTtc

attribute)

Update of the error messages table (errors 20013, from 20303 to 20305)

Correction of the service soumettreFactureTravaux :

Update of the error messages table (addition of the following errors : from 20003

to 20005, 20042, 20064, 20065, from 20127 to 20129, from 20131 to 20134)

Correction of the service rechercherFactureParFournisseur :


periodeDateHeureEtatCourantDu and periodeDateHeureEtatCourantAu, deletion

of the attribute idUtilisateurCourant)




Correction of the service rechercherFactureParRecipiendaire :






Update of the error messages table (addition of the errors 200, 400 and 20001)

Correction of the service rechercherFactureTravaux :







Correction of the service rechercherDemandePaiement :

Update of the input data table (addition of the attributes rechercheSirenDestinataire

and rechercheSirenFournisseur)

Update of the output data table (addition of the attribute commentaireEtatCourant)


Correction of the service consulterSollicitation :

Update of the output data table (addition of the attribute historiqueDetaille and

update of the attribute historique)

Update of the services rechercherSollicitationsEmises,

rechercherSollicitationsRecues, repondreSollicitation:


attribute statut)

Update of the service consulterSollicitation:

552 / 557



attribute statut)

V4.01

14/09/2018 AIFE

Modification of the management rule applied on the attribute

numeroFactureSaisi of the service soumettreFacture. The numeroFacture is

automatically generated by the Chorus Pro system (2.2.1.4)

Modification of the description of service deposerFluxFacture : the maximal

size of compressed flow is 30 Mo if and 10 Mo if the flow is not compressed

(2.2.1.1)

Modification of the calculation method for the field montantTtcTotal of the

service soumettreFacture (2.2.1.4)

V4.00

04/06/2018 AIFE

Addition of a summary table on API § 2.1

Addition of references to every API method for each API

Removal of the management rule G2.10 relating to the intra-community

VAT number

Transfer of Chapter 6 from External Specification Chorus Pro document

introducing API services and sequence charts (§ 1)

Correction of the service RechercherServicesStructures:

Removal of the attribute nbrResultatMaximum

Removal of part 1.2.2 User Assistance

Removal of part 1.2.5 Input and output tables of the API services

Removal of part 1.2.6 Flow monitoring

Removal of part 1.2.7 Commitment management

Removal of part 1.2.8 Input and output tables of referentials and transversal

services

Removal of the CII14B references

V3.4bis

18/04/2018 AIFE

Addition of formats structured and minimal CII16B and Factur-X:

Correction of the services deposerFluxFacture, consulterCR,

recupererSyntaxeFlux and recupererFormatFlux

V3.4bis

09/03/2018 AIFE

Correction of the service consulterFactureParRecipiendaire:

Addition of output parameters CoordBancairesCodeGuichet and

CoordBancairesBicSwift

Correction of the service rechercherFactureTravaux:

Removal of the reference of the A11 framework from the input table

V3.4

21/02/2018 AIFE

Addition of the following services:

rechercherDemandePaiement

rechercherFactureATraiterParValideur

ajouterEspace

rechercherEspaces

modifierStructure

lierPieceJointeUtilisateur

lierPieceJointeStructure

supprimerServiceStructure

consulterInformationSIRET

rechercherUtilisateursGeresParGestionnaire

recupererStructuresGereesParGestionnaire

consulterCompteUtilisateur

demanderAbonnementsMonCompteUtilisateur

recupererAbonnementsMonCompteUtilisateur

recupererRattachementsMonCompteUtilisateur

supprimerAbonnementsMonCompteUtilisateur

supprimerRattachementsStructureMonCompteUtilisateur

rechercherDemandeAbonnementEnAttenteParGestionnaire

recupererServicesPourDemandeDeRattachementEnAttente

553 / 557


refuserRattachementUtilisateur

consulterDetailEngagementJuridique

detacherPieceJointe

recupererStatutsUtilisateur

consulterCRDetaille

Update of the service RecyclerFacture:

Addition of the attributes « reference » and « numeroBonCommande »

Update of the service recyclerFactureTravaux:

Update of the description of the service

Removal of the attribute « commentaire »

Update of the Error codes

Update of the description of the services rechercherServicesStructure and

consulterServiceStructure

Update of the service ConsulterCR:

Update of the attributes « dateDepot », « syntaxeFlux » and

« designationPartenaire »

Removal of the Error codes 200 and 400

Update of the Error code 20002

V3.3

24/10/2017 AIFE

Addiction of the following services:

traiterFactureAValider

consulterFactureParValideur

corrigerValideurFacture

rechercherFactureParValideur

recupererMotifsRefusFactureAValider

recupererStatutsFacturesVisiblesParValideur

telechargerPieceJointe

consulterStructureAvecTVAIntraCommunautaire

telechargerAnnuaireDestinataire Modification of the functional identifier format of supplier, validator, Project

Manager, Contracting Authority, issuing and recipient structures ::

The format is now varchar(80) and no longer varchar(18

Update of the service consulterFactureParFournisseur:

Deletion of attributes « LignePosteUniteCode » and « LignePosteUniteLibelle »

Addition of the attribute « LignePosteUnite » whose format is varchar(50)

Update of the serviceconsulterFactureParRecipiendaire:

Deletion of the attributes LignePosteUniteCode and LignePosteUniteLibelle

Addiction of the attribute LignePosteUnite whose format is varchar(50)

Update of the service consulterFactureParValideur:

Deletion of the attributes LignePosteUniteCode and LignePosteUniteLibelle

Addition of the attribute LignePosteUnite whose format is varchar(50)

Update of the service soumettreFacture:

Addition of a management rule for the attribute « codeServiceExecutant »

Update of the service rechercherEngagementJuridique:

Modification of the management rule of the attribute

« codeEngagementJuridique », addition of the codes « BAUX »,

« DECISIONS_DIVERSES », « LISTE_DE_PRIX » and « SUBVENTIONS »

Update of the service telechargerPieceJointe:

Modification of the attribute « demandeDePaiement » ; the new denomination is

« demandePaiement »

Update of the service recupererEtatParTypeDemandePaiement:

Addition of the following payment request statuses

« MISE_A_DISPOSITION_MOA » [AVAILABLE TO CONTRACTING AUTHORITY] et

« PRISE_EN_COMPTE_MOA » [TAKEN IN ACCOUNT BY CONTRACTING

AUTHORITY]

554 / 557


V3.2 bis

14/09/2017 AIFE

Correction of the following service descriptions:

rechercherUtilisateursRatatchesService

saisirGeneralitesStructure

supprimerUtilisateurRattacheStructure

consulterStructure

Update of the service consulterCR:

Modification of the attribute numeroFluxDepot

Update of the service rechercherEngagementJuridique:

Modification of the parameters of the attribute TriColonne

Update of the service recupererServicesParStructure:

Modification of the service denomination and descriptionUpdate of the service

recupererTypesPieceJointe:

Modification of the occurrences « recupererTypePieceJointe » ; the new

denomination is « recupererTypesPieceJointe »

Update of the service recupererModeReglements:

Modification of the occurrences « recupererModeReglement » ; the new

denomination is « recupererModeReglements »

Update of the service traiterFactureRecue:

Addition of the parameter « numeroDpMandat)

Deletion of the parameter « idutilisateurCourant »

Deletion of the reference to the management rule « TDI-CU-03-RGD-01Ter »

Update of the service rechercherCategorieSollicitation:

Correction of the management rule of the outputed attribute « triColonne »

Update of the service rechercherSousCategorieSollicitation:

rrection of the management rule of the outputed attribute « triColonne »

Update of the chapter 4:

Modification of the denomination, from « Qualification des flux » to « Suivi des

flux »

V3.2

30/06/2017 AIFE

Addition of the following services:

saisieSollicitation

repondreSollicitation

ajouterInformationComplementaire

rechercherSollicitationsEmises

rechercherSollicitationsReçues

telechargerSollicitationEmises

consulterSollicitation

rechercherCategorieSollicitation

rechercherSousCategorieSollicitation

rechercherStructuresPourUtilisateur

Update of the service consulterCR, addition of the following inputed

attributes:

datedepot

syntaxeFlux

V3.1 –

24/05/2017 AIFE

Deletion of the following services:

supprimerFacture

consulterDemandesAbonnementparGestionnaire

consulterMonCompteUtilisateur

consulterUtilisateurParGestionnaire

desactiverMonCompteUtilisateur

reactiverMonCompteUtilisateur

saisirGeneraliteNouvelUtilisateur

modifierMonCompteUtilisateur

Update of the service rechercherUtilisateursRattachésStructure

Format of outputed dates

555 / 557


Update of error messages (from 20002 to 20006)

Update of the service ajouterFichierDansSysteme

Modification of the attachment name size to varchar (50) for the service


Update of the service soumettreFacture

Modification of the type of inputed attribute lignePosteUnite from integer to

varchar(20)

Update of the service consulterCR

Addition of the possible values that can be entered in the outputed field

etatCourantFlux

V3.0

Update of the service Compléter facture

- Update of the outputed attributesFrom identifiantFactureCPP to NumeroFacture

- From identifiantFactureCPP to DateTraitement

Update of the service Consulter facture par fournisseur

- Update of the outputed attributes From fournisseurs to fournisseur

- Modification of the following attributes (becoming Required)destinataire

- attributes of the supplier address: adresseFournisseurDetail,

adresseFournisseurCodePostal, adresseFournisseurVille, adresseFournisseurCodePays,

adresseFournisseurLibellePays

- cadreDeFacturation

- typeFacture

- recapitulatifDeTva

- the outputed attributes of the structure montant Total

- lignesDePoste

- typeTva

Modification of the enumeration of the possible values of the attribute type

Facture

- deletion of the value ACOMPTE

Update of the service ConsutlerFactureParRecipiendaire

- Modification of the following attributes (becoming Required) Facture

- Modification of the following attributes (becoming Optional) RecapitulatifDeTva

- LignesDePoste facultatifs

Deletion of the value ACOMPTE from the enumeration of the attribute type

Facture

Update of the outputed attributes of the service

- PiecejointePrincipale à pieceJointePrincipale

Deletion of the inputed attributeIdUtilisateurCourant

Deltion of the outputed attributedestinataireEtat

Update of the management rule of the outputed attribute cadreFacturation

Addition of the following outputed attributes:

- IdMoe


- IdentifiantMoe

- RaisonSocialeMoe

- NomMoe

- PrenomMoe

- IdServiceMoe

- CodeServiceMoe

- NomServiceMoe

- IdMoa

- IdentifiantMoa

- RaisonSocialeMoa

- IdServiceMoa

- CodeServiceMoa

- NomServiceMoa

- IdMoe

- CadreFacturationPiecePrecedente

- IdPiecePrecedente

- NumeroPiecePrecedente

- IdDestinatairePiecePrecedente

- IdentifiantDestinatairePiecePrecedente

- RaisonSocialeDestinatairePiecePrecedente

556 / 557


- IdServiceExecutantPiecePrecedente

- CodeServiceExecutantPiecePrecedente

- NomServiceExecutantPiecePrecedente

- CadreFacturationPieceSuivante

- IdPieceSuivante

- NumeroPieceSuivante


- NumeroDpMandat

Update of the service DéposerFluxFacture

Modification of the enumeration of the attribute triColonne

Update of the attribute from fournisseur to designationFournisseur

- Modification of the following attributes (becoming Optional) CodeDestinataire


- TypeFacture

- LignesDePoste

- Montants

- IdUtilisateurCourant

- Modification of the following attributes (becoming Required) MontantTTC

- MontantAPayer

Update of the servicerechercherFactureParFournisseur

Update of the service inputed attributes:

- ListeIdDestinataire à ListeDestinataire

- ListeTypeFacture à TypeFacture

- Modification of the following attributes (becoming Required) codeDestinataire


- typeFacture

- montantHT

- montantTTC

- montantAPayer

- nomPrenomUtilisateurCreateur

Update of the servicerechercherFactureParRécipiendaire

Modification of the following attributes (becoming Optional)


- Modification of the following attributes (becoming Required) MontantTTC

- MontantAPayer

Addition of the invoicing framework A5 in the enumeration of attribute

cadreDeFacturation

Deletion of the attribute ParametresRetour

Deletion of the default value of the parameter typeFacture

Update of the enumeration of statutCourant and typeFactureTravaux

Update of the service RecyclerFacture

Udpate of the field dateDepot from AAAA-MM-JJ HH:MI to AAAA-MM-JJ

V2 –

03/11/2016 AIFE

Addition of the description of methods relative to the work invoices:

Consulter factures de travaux

Demander recyclage Pièce précédente

Rechercher facture de travaux

Rechercher facture Travaux A Traiter

Soumettre Facture Travaux

Prendre en compte Une facture de travaux

Compléter MOE

Recycler Facture Travaux

Compléter Facture Travaux

Consulter Dossier de Facturation

Refuser Facture Travaux

Addition of the description of Cross-functional methods:



RechercherPieceJointeSurMonCompte

RechercherPieceJointeSurStructure

RechercherServiceExecutant

RecupererCadreFacturation

557 / 557


RecupererCoordonneesBancairesValides

RecupererDevises


RecupererEtatsPossiblesPourTraitement

RecupererFormatFlux

RecupererModeDepot

RecupererModeReglements

RecupererMotifsExonerationTva

RecupererPays

RecupererServicesExecutantEtat

RecupererServicesParStructure

RecupererStructuresActivesPourDestinataire

RecupererStructuresActivesPourFactureTravaux

RecupererStructuresActivesPourFournisseur

RecupererSyntaxeFlux

RecupererTauxTva

RecupererTypeDemandePaiement

RecupererTypeFactureTravaux

RecupererTypeIdentifiantStructure

RecupererTypesPieceJointe

RecupererTypeStructure

RecupererUtilisateursDuService

Update of the following services, according to the implementation of the methods relative to the work invoices: ConsulterHistoriqueFacture

ConsulterStructure


RechercherFactureAtraiterParRecipiendaire

RechercherStructure


TraiterFactureRecue

V1 –

29/07/2016 AIFE Addition of the input and output tables of the services available in API

mode, from the chapter 6 of the External Specifications

Date post:	08-Jan-2023
Category:	Documents
Upload:	khangminh22
View:	0 times
Download:	0 times

EXTERNAL SPECIFICATION CHORUS PRO API ...

Documents