Documents.Processus¶

En bref

10 opérations sur 10 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).

Opérations¶

Méthode	Chemin	Rôle
`GET`	`/v2/documents/baremes/appliquer/{doType}/{doPiece}`	Appel `GET` sur `documents/baremes/appliquer`
`POST`	`/v2/documents/pdf/token`	Appel `POST` sur `documents/pdf/token`
`POST`	`/v2/documents/pdf/{doType}/{doPiece}`	Appel `POST` sur `documents/pdf`
`GET`	`/v2/documents/pdf/{dossier}/{doType}/{doPiece}`	Appel `GET` sur `documents/pdf`
`GET`	`/v2/documents/taxes/{doType}/{doPiece}`	Appel `GET` sur `documents/taxes`
`GET`	`/v2/documents/transform/commander/{doPiece}`	Appel `GET` sur `documents/transform/commander`
`GET`	`/v2/documents/transform/facturer/{doPiece}`	Appel `GET` sur `documents/transform/facturer`
`GET`	`/v2/documents/transform/livrer/{doPiece}`	Appel `GET` sur `documents/transform/livrer`
`GET`	`/v2/documents/transform/preparer/{doPiece}`	Appel `GET` sur `documents/transform/preparer`
`POST`	`/v2/documents/transform/{doType}`	Appel `POST` sur `documents/transform`

Rôle déduit

La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.

Détail¶

`GET /v2/documents/baremes/appliquer/{doType}/{doPiece}`¶

Appel GET sur documents/baremes/appliquer.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
`doType`	path	`integer` (int32)	oui	—
`doPiece`	path	`string`	oui	—

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/documents/baremes/appliquer/<doType>/<doPiece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/documents/pdf/token`¶

Appel POST sur documents/pdf/token.

Corps de la requête (application/json)

Schéma DownloadPdfDto — 4 propriétés (détail : Schémas).

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/documents/pdf/token" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"token": "…", "dO_Piece": "…", "dO_Type": 0}'

`POST /v2/documents/pdf/{doType}/{doPiece}`¶

Appel POST sur documents/pdf.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
`doType`	path	`integer` (int32)	oui	—
`doPiece`	path	`string`	oui	—

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/documents/pdf/<doType>/<doPiece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`GET /v2/documents/pdf/{dossier}/{doType}/{doPiece}`¶

Appel GET sur documents/pdf.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
`dossier`	path	`string`	oui	—
`doType`	path	`integer` (int32)	oui	—
`doPiece`	path	`string`	oui	—

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/documents/pdf/<dossier>/<doType>/<doPiece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`GET /v2/documents/taxes/{doType}/{doPiece}`¶

Appel GET sur documents/taxes.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
`doType`	path	`integer` (int32)	oui	—
`doPiece`	path	`string`	oui	—

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/documents/taxes/<doType>/<doPiece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`GET /v2/documents/transform/commander/{doPiece}`¶

Appel GET sur documents/transform/commander.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
`doPiece`	path	`string`	oui	—

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/documents/transform/commander/<doPiece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`GET /v2/documents/transform/facturer/{doPiece}`¶

Appel GET sur documents/transform/facturer.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
`doPiece`	path	`string`	oui	—

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/documents/transform/facturer/<doPiece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`GET /v2/documents/transform/livrer/{doPiece}`¶

Appel GET sur documents/transform/livrer.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
`doPiece`	path	`string`	oui	—

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/documents/transform/livrer/<doPiece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`GET /v2/documents/transform/preparer/{doPiece}`¶

Appel GET sur documents/transform/preparer.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
`doPiece`	path	`string`	oui	—

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/documents/transform/preparer/<doPiece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

`POST /v2/documents/transform/{doType}`¶

Appel POST sur documents/transform.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
`doType`	path	`integer` (int32)	oui	—

Corps de la requête (application/json)

Schéma TransformDto — 4 propriétés (détail : Schémas).

Réponses

Code	Description	Schéma de `data`
`200`	OK	—
`401`	Unauthorized	—
`403`	Forbidden	—

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/documents/transform/<doType>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"target_base": [], "DO_TypeDest": 0, "ConserveDocuments": false}'

Schémas¶

Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.

DownloadPdfDto¶

DownloadPdfDto — 4 propriétés

Propriété	Type	Notes
`token`	`string`	nullable
`dO_Piece`	`string`	nullable
`dO_Type`	`integer` (int32)	—
`target_base`	`string`	nullable

TransformDto¶

TransformDto — 4 propriétés

Propriété	Type	Notes
`target_base`	tableau de `string`	nullable
`DO_TypeDest`	`integer` (int32)	nullable
`ConserveDocuments`	`boolean`	—
`object_data`	tableau de `TransformLineDto`	nullable

Documents.Processus¶

Opérations¶

Détail¶

GET /v2/documents/baremes/appliquer/{doType}/{doPiece}¶

POST /v2/documents/pdf/token¶

POST /v2/documents/pdf/{doType}/{doPiece}¶

GET /v2/documents/pdf/{dossier}/{doType}/{doPiece}¶

GET /v2/documents/taxes/{doType}/{doPiece}¶

GET /v2/documents/transform/commander/{doPiece}¶

GET /v2/documents/transform/facturer/{doPiece}¶

GET /v2/documents/transform/livrer/{doPiece}¶

GET /v2/documents/transform/preparer/{doPiece}¶

POST /v2/documents/transform/{doType}¶

Schémas¶

DownloadPdfDto¶

TransformDto¶

Voir aussi¶

`GET /v2/documents/baremes/appliquer/{doType}/{doPiece}`¶

`POST /v2/documents/pdf/token`¶

`POST /v2/documents/pdf/{doType}/{doPiece}`¶

`GET /v2/documents/pdf/{dossier}/{doType}/{doPiece}`¶

`GET /v2/documents/taxes/{doType}/{doPiece}`¶

`GET /v2/documents/transform/commander/{doPiece}`¶

`GET /v2/documents/transform/facturer/{doPiece}`¶

`GET /v2/documents/transform/livrer/{doPiece}`¶

`GET /v2/documents/transform/preparer/{doPiece}`¶

`POST /v2/documents/transform/{doType}`¶