Ce dossier documente les ressources de l’API Sage 100:

• Description métier de la ressource
• Propriétés de la ressource,
• Liste des énumérations autorisées pour les propriétés avec énumération,
• Relations avec les autres ressources,
• Principales routes de l’API,
• Contraintes pour suppression,
• Informations complémentaires sur l’utilisation de certaines propriétés.

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

Notez que pour les relations 1..1 ou 1..?, il sera possible de récupérer les informations depuis la ressource principale en utilisant le paramètre OData $expand avec la valeur correspondant au nom de la relation. </div>

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

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
idS	string	Id
dateModificationS	datetime	Date de modification
dateCreationS	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
numeroN	string	Numéro de tiers

Paramètres à passer à l’API Sage 100

A l’exception de la route companies et de la route me, toutes les routes de l’API attendent au minimum un paramètre.

La liste des routes vous propose le nom à utiliser dans Power Apps. Ce nom vous indiquera les paramètres attendus.

Exemple :

Verbe	Power Automate	Power Apps
GET	Liste de tous les articles	GetByDatasetid
GET	Retourne un article par son Id	GetByIdAndDatasetid

Le nom des méthodes est structuré de la manière suivante : RessourceOpérationByParamètres

• Ressource : Correspond aux entités exposées par l’API Sage 100 (BonsAPayer , Clients , Devises …)
• Opération : Correspond à l’action de la méthode (Get , Post , Put , Patch , Delete ou à une action métier, par exemple : Accepter pour la ressource BonsAPayer).
  
• ByParamètres : Correspond aux paramètres d’entrée de l’opération (certaines opérations ne requièrent aucun paramètre d’entrée).