Documents.Processus

En bref

15 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/baremes/appliquer/{doType}/{doPiece}	Appel POST 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
POST	/v2/documents/transform/commander/{doPiece}	Appel POST sur documents/transform/commander
GET	/v2/documents/transform/facturer/{doPiece}	Appel GET sur documents/transform/facturer
POST	/v2/documents/transform/facturer/{doPiece}	Appel POST sur documents/transform/facturer
GET	/v2/documents/transform/livrer/{doPiece}	Appel GET sur documents/transform/livrer
POST	/v2/documents/transform/livrer/{doPiece}	Appel POST sur documents/transform/livrer
GET	/v2/documents/transform/preparer/{doPiece}	Appel GET sur documents/transform/preparer
POST	/v2/documents/transform/preparer/{doPiece}	Appel POST 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/baremes/appliquer/{doType}/{doPiece}

Appel POST 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 POST "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"

POST /v2/documents/transform/commander/{doPiece}

Appel POST 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 POST "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"

POST /v2/documents/transform/facturer/{doPiece}

Appel POST 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 POST "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"

POST /v2/documents/transform/livrer/{doPiece}

Appel POST 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 POST "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/preparer/{doPiece}

Appel POST 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 POST "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

Voir aussi

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

Écrans qui utilisent ce groupe

• Archives
• Documents d'achat
• Documents de stock
• Documents de vente
• Documents internes
• Filtres et accès
• Modèles d'impression