Vue d'ensemble ressources API

Ce dossier documente les ressources de l’API Sage Business Cloud Comptabilité:

Chaque page est également en lien avec la documentation de référence de l’ API qui documente la totalité des routes disponibles et la liste exhaustive de toutes les propriétés de chaque ressource.

L’url actuelle de l’API Sage Business Cloud Comptabilité est :

L’url actuelle du Bureau Sage Business Cloud permettant d’administrer les sociétés et utilisateurs est :
https://dev-app-bureausaas.sagedatacloud.com
Depuis ce bureau vous trouverez aussi pour chaque société le lien direct pour lancer l’application Comptabilité Sage Business Cloud Comptabilité.

</div>

Syntaxes utilisées

Ci-dessous sont décrites les différentes syntaxes utilisés dans la documentation des ressources.

Cardinalité des relations

Une ressource peut être en relation avec plusieurs autres ressources. A l’exemple d’une écriture comptable en relation avec un compte, éventuellement un tiers, un journal, éventuellement une taxe, etc.
Selon la relation le nombre d’éléments de la ressource à lier sera différent.
Exemples : on doit avoir obligatoirement un compte et un seul lié à une ligne d’écriture comptable mais on peut avoir aucun ou plusieurs contacts lié à un Tiers.
Le tableau ci-dessous documente la notation utilisée pour décrire la nature de la relation.

Cardinalité $expand Nb d’éléments pouvant être liés
1..1 Oui Obligatoirement un
1..? Oui Aucun ou un
1..+   Aucun ou un ou plusieurs
1..*   Un ou plusieurs
1..10   Un ou plusieurs avec un maximum de 10

Valeurs de propriétés obligatoires

Les propriétés dont la valeur est obligatoire lors de la création de la ressource sont identifiées par une astérisque.
Les énumérations, identifiées par des puces, sont aussi des propriétés dont la valeur est obligatoire mais elle ne sont pas identifiées par une astérisque puisqu’il faudra choisir obligatoirement une des valeurs de l’énumération.

Exemples : numero est obligatoire et identifiable par une astérisque, type est implicitement obligatoire car sa valeur ne peut être que Client, Fournisseur, Salarie ou Autre, et n’a pas besoin d’être identifiée par une astérisque.

Propriétés Type Description
numero string Numéro de tiers

Valeurs par défaut en création

Certaines propriétés peuvent éventuellement avoir une valeur par défaut implicite si elles ne sont pas affectées lors de la déclaration des propriétés pour la création d’un enregistrement. Les propriétés avec valeur par défaut lors de la création de la ressource sont identifiées par la lettre D en rouge.

Exemple : la propriété modeReglement de la ressource Clients / Règlements aura une valeur par défaut si elle n’est pas affectée.

Propriétés Type Description
modeReglement single-valued navigation mode de règlement dans modesReglement

Propriétés système non modifiables

Certaines propriétés ne peuvent pas être affectées en création ou modification. Elles correspondent à des informations système automatiquement attribuées par l’application et sont identifiables par la lettre S en rouge.
Exemples : id, dateModification, dateCreation sont des propriétés système non modifiables.

Propriétés Type Description
id string Id
dateModification datetime Date de modification
dateCreation datetime Date de création

Propriétés non modifiables après création

Certaines propriétés peuvent être affectées en création mais ne peuvent plus ensuite être modifiées.
Elles sont identifiables par la lettre N en rouge.
Exemple : numero est une propriété pouvant être affectée en création mais plus modifiable ensuite.

Propriétés Type Description
numero string Numéro de tiers

Propriétés non visibles dans l’interface du produit

Certaines rares propriétés peuvent être affectées mais ne seront pas visibles dans l’interface du produit.
Elles sont identifiables par le terme Inv en rouge.
Exemple : siret est une propriété techniquement présente pour la ressource Tiers Salariés mais fonctionnellement non présente dans l’interface du produit.

Propriétés Type Description
siret string SIRET

Propriétés de type single-valued navigation

Certaines propriétés sont à affecter avec une valeur unique de navigation d’un élément d’une ressource à lier.
Exemple : Propriété compteTaxe. Lors de la création d’une taxe, il est nécessaire d’associer la taxe à un compte existant du plan comptable.
Il faudra alors affecter la propriété de type single-valued navigation avec la syntaxe [email protected] et affecter cette propriété avec une valeur unique de navigation correspondant au compte du plan comptable à associer.

Propriétés Type Description
compteTaxe single-valued navigation compte de la taxe dans comptes
Navigation Destination Cardinalité $expand
compteTaxe comptes 1..1 Oui

Voir : Concepts clés / OData - Propriétés de Navigation