Doc

En bref

10 opérations sur 10 chemins. Routes héritées, sans préfixe /v2. Authentification JWT (voir Démarrer).

Routes héritées

Les chemins de ce groupe ne portent pas le préfixe /v2 : ils proviennent de la surface historique du connecteur, publiée dans la même spécification. Pour une intégration neuve, préférez l'équivalent /v2 (voir Conventions).

Opérations

Méthode	Chemin	Rôle
GET	/doc/baremes/appliquer/{DO_Type}/{DO_Piece}	Appel GET sur doc/baremes/appliquer
POST	/doc/pdf/token	Appel POST sur doc/pdf/token
POST	/doc/pdf/{DO_Type}/{DO_Piece}	Appel POST sur doc/pdf
GET	/doc/pdf/{Dossier}/{DO_Type}/{DO_Piece}	Appel GET sur doc/pdf
GET	/doc/taxes/{DO_Type}/{DO_Piece}	Appel GET sur doc/taxes
GET	/doc/transform/commander/{DO_Piece}	Appel GET sur doc/transform/commander
GET	/doc/transform/facturer/{DO_Piece}	Appel GET sur doc/transform/facturer
GET	/doc/transform/livrer/{DO_Piece}	Appel GET sur doc/transform/livrer
GET	/doc/transform/preparer/{DO_Piece}	Appel GET sur doc/transform/preparer
POST	/doc/transform/{DO_Type}	Appel POST sur doc/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 /doc/baremes/appliquer/{DO_Type}/{DO_Piece}

Appel GET sur doc/baremes/appliquer.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
DO_Piece	path	string	oui	-
DO_Type	path	integer (int32)	oui	-

Réponses

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

Exemple

curl -s -X GET "https://<votre-connecteur>/doc/baremes/appliquer/<DO_Type>/<DO_Piece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /doc/pdf/token

Appel POST sur doc/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>/doc/pdf/token" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"token": "…", "dO_Piece": "…", "dO_Type": 0}'

POST /doc/pdf/{DO_Type}/{DO_Piece}

Appel POST sur doc/pdf.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
DO_Piece	path	string	oui	-
DO_Type	path	integer (int32)	oui	-

Réponses

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

Exemple

curl -s -X POST "https://<votre-connecteur>/doc/pdf/<DO_Type>/<DO_Piece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

GET /doc/pdf/{Dossier}/{DO_Type}/{DO_Piece}

Appel GET sur doc/pdf.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
Dossier	path	string	oui	-
DO_Piece	path	string	oui	-
DO_Type	path	integer (int32)	oui	-

Réponses

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

Exemple

curl -s -X GET "https://<votre-connecteur>/doc/pdf/<Dossier>/<DO_Type>/<DO_Piece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

GET /doc/taxes/{DO_Type}/{DO_Piece}

Appel GET sur doc/taxes.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
DO_Type	path	integer (int32)	oui	-
DO_Piece	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>/doc/taxes/<DO_Type>/<DO_Piece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

GET /doc/transform/commander/{DO_Piece}

Appel GET sur doc/transform/commander.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
DO_Piece	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>/doc/transform/commander/<DO_Piece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

GET /doc/transform/facturer/{DO_Piece}

Appel GET sur doc/transform/facturer.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
DO_Piece	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>/doc/transform/facturer/<DO_Piece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

GET /doc/transform/livrer/{DO_Piece}

Appel GET sur doc/transform/livrer.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
DO_Piece	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>/doc/transform/livrer/<DO_Piece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

GET /doc/transform/preparer/{DO_Piece}

Appel GET sur doc/transform/preparer.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
DO_Piece	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>/doc/transform/preparer/<DO_Piece>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /doc/transform/{DO_Type}

Appel POST sur doc/transform.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
DO_Type	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>/doc/transform/<DO_Type>" \
  -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

Voir aussi

• Démarrer avec l'API v2
• Conventions de payload
• Tous les groupes