Aller au contenu

Comptabilite.BonAPayer

En bref

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

Opérations

Méthode Chemin Rôle
GET /v2/bonapayer Lister les enregistrements
POST /v2/bonapayer Créer l'enregistrement
PUT /v2/bonapayer Mettre à jour l'enregistrement
DELETE /v2/bonapayer Supprimer l'enregistrement
GET /v2/bonapayer/count Compter les enregistrements
POST /v2/bonapayer/count Compter les enregistrements
POST /v2/bonapayer/recherche Rechercher des enregistrements
POST /v2/bonapayer/save Créer ou mettre à jour l'enregistrement (upsert)

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/bonapayer

Lister les enregistrements.

Paramètres

Nom Emplacement Type Obligatoire Description
sort query string non -
where query string non -

Réponses

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

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/bonapayer?sort=<sort>&where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/bonapayer

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma BonAPayerDto - 4 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

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

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/bonapayer" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"autorisation": 0, "idResponsable": 0, "facture": 0}'

PUT /v2/bonapayer

Mettre à jour l'enregistrement.

Corps de la requête (application/json)

Schéma BonAPayerDto - 4 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

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

Exemple

curl -s -X PUT "https://<votre-connecteur>/v2/bonapayer" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"autorisation": 0, "idResponsable": 0, "facture": 0}'

DELETE /v2/bonapayer

Supprimer l'enregistrement.

Corps de la requête (application/json)

Schéma BonAPayerDto - 4 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

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

Exemple

curl -s -X DELETE "https://<votre-connecteur>/v2/bonapayer" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"autorisation": 0, "idResponsable": 0, "facture": 0}'

GET /v2/bonapayer/count

Compter les enregistrements.

Paramètres

Nom Emplacement Type Obligatoire Description
where query string non -

Réponses

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

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/bonapayer/count?where=<where>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/bonapayer/count

Compter les enregistrements.

Réponses

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

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/bonapayer/count" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/bonapayer/recherche

Rechercher des enregistrements.

Réponses

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

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/bonapayer/recherche" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /v2/bonapayer/save

Créer ou mettre à jour l'enregistrement (upsert).

Corps de la requête (application/json)

Schéma BonAPayerDto - 4 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

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

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/bonapayer/save" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"autorisation": 0, "idResponsable": 0, "facture": 0}'

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.

BonAPayerDto

BonAPayerDto - 4 propriétés
Propriété Type Notes
autorisation integer (int32) Type d'autorisation (eBAPAutorisationType : Aucun=0, Financier=1, LesDeux=2).
idResponsable integer (int32) Identifiant du collaborateur responsable (CO_No).
facture integer (int32) Factures concernées (eBAPAValider : ToutesFactures=0, SelonMontant=1).
seuilValidation number (double) Seuil de validation (montant).

Voir aussi

Documentation de SenSaaS v2. Chaque page est écrite à partir du produit livré ; ce qui reste à vérifier y est signalé.