Wiki1000 - Contributions de l'utilisateur [fr]

Ressource (sdata)

2026-09-16T11:34:30Z

Cesru : ajout de l'exemple "Statuts de paiement d'une facture avec l'API SData"

__TOC__

{{tip|Voir aussi l'[[API Json (SData)|API en mode JSON]], qui permet d'encapsuler d'avantage les appels de service.}}

==Prérequis==
Les requêtes SData sont exécutées sur [[SData|le point d'accès SData du service]].

La forme simplifiée des urls est

<pre>http://hostname/sdata/ressource?paramètres</pre>

ou

<pre>http://hostname/sdata/societe/ressource?paramètres</pre>

Les requêtes sont authentifiées par un jeton d'authentification placé dans l'entête Authorization de la requêtes.

[[Gestion des jetons d'authentification (Administration)|Le jeton d'authentification peut être géré par le client dans l'administration.]]

Les requêtes doivent comporter les entêtes suivantes :

{|class="wikitable"
|-
|accept
|application/json
|-
|Authorization
|Bearer token
|}

Les url des requêtes doivent être encodées, par exemple :

<pre>https://.../sdata/Société 1/ttiers...</pre>

doit être transmis encodé en

<pre>https://.../sdata.Soci%C3%A9t%C3%A9%201/ttiers....</pre>

==Sélection de version==
Il es possible d'indiquer un numéro de version dans l'url de la requête.

Placez le numéro de version derrière le préfix sdata :

<pre>
https://.../sdata/1/....
</pre>

En absence de numéro de version la dernière version sera utilisée.

==Informations de version==
Utilisez la fonction $version pour retrouver les informations de version

<pre>
GET http://localhost:8080/sdata/$version
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 0,
"debug": true,
"shareEnable": true
}
</pre>

<pre>
GET https://localhost/sdata/$version?select=details
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 1,
"debug": true,
"minors": [
{
"minor": 1,
"details": [
"Fix $batch : Error in commit don't return message and continue execution",
"Fix time measure decimal format use . instead of local",
"Add extension information to $schema",
"Add operations to $schema",
"Add select options to $schema"
]
},
{
"minor": 0,
"details": [
"Add version information"
]
}
]
}
</pre>

Le paramètre select accepte les options suivantes :

{|class="wikitable"
|-
!option
!usage
|-
|details
|Détails des modifications des versions mineurs
|-
|patches
|Liste des patches installés
|}

==Mise au point==
Vous pouvez activer l'enregistrement des messages SDATA dans le répertoire de log du service, en [[[[Fichier_de_configuration_(server)#Logs|configurant le fichier de service]] ou bien en utilisant l'interface de configuration du service.

[[image:Sdata-conf-log.png|600px]]

==Ressource (GET)==
Dans l'interface SData les ressources sont les objets de l'application.

Une ressource est identifié par son uri qui représente le chemin de la ressource.

L'uri est composé du chemin de la classe et d'un sélecteur qui est l'oid de l'objet.

'''Exemple :'''

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')
Response: 200 OK
{
"$baseUrl":"http://localhost:8080/sdata/l1000/gentiers/-/",
"$title":"TTiers - -",
"$updated":"2020-12-22T08:10:09.740Z",
"$resources":[
{
"$url":"TTiers('9D33A23CFA6A005500F6000000285DAE')",
"$title":"ABI Jardin",
"$updated":"2010-03-23T15:37:46.000Z",
"$etag":"9D33A23CFA6A005500F6000000285DAE-000002C60000421C",
"$key":"9D33A23CFA6A005500F6000000285DAE",
"$baseUrl":"http://localhost:8080/sdata/l1000/GenTiers/-/",
"stamp":"000002C60000421C",
.... Attribute list ...
}
]
}
</pre>

===Sélecteur de ressource===

Un sélecteur permet de retrouver une ressource spécifique, il est possible de rechercher une ressource par clé ou clause

{|class="wikitable"
|-
!Sélecteur
!Exemple
|-
|Clé
|TTiers('9D33A23CFA6A005500F6000000285DAE')
|-
|clause
|TTiers(code eq 'ABI 007')
|}

===Code de retour HTTP===

{|class="wikitable"
|-
!Code
!Résultat
|-
|200
|La ressource existe
|-
|404
|La ressource n'existe pas
|}

===Gestion des rôles dans les ressources===
La gestion des rôles de la ressource dépend du type et de la nature du rôle :

{|class="wikitable"
|-
!Type de rôle
!Nature
!Retour
|-
|Référence,Liste
|Composition
|Les ressources composants sont retournées dans le corps de la ressource composée
|-
|Référence
| -
|La ressource référencée est retournée par référence dans le corps de la ressource
|-
|Liste
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe référencée filtrée sur la référence réciproque.
|-
|Association
|Avec suppression en cascade
|Les ressources associées sont considérées comme des composants et retournées dans le corps de la ressource composée.
|-
|Association
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe associée filtrée sur la classe d'association
|}

{{tip|Utilisez une vue pour retourner directement les attributs liés par des références, voir le paramètre select}}

===Gestion du périmètre société===
Par défaut, les requêtes s'exécutent dans le contexte société défini dans le jeton d'authentification.

Vous pouvez définir le contexte société dans le l'url de la requête :

<pre>
METHOD https://host/sdata/society/package/class ...
</pre>

{{tip|Définir le contexte société dans l'url n'est utilisable que sur une base supportant le multi-société. Pour connaitre le statut multi-société, utilisez la requête $version ou bien interrogez [[Utilisation_du_contrôleur_de_partage_(API)|le contrôleur de partage]]}}

==Requête sur les ressources (GET)==
Une requête sur les ressources est une requête sur une classe du modèle.

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?parameters
</pre>

===Paramètres de la requête===

{|class="wikitable"
|-
!Paramètre
!valeur
!Usage
|-
|select
|liste d'attributs séparés par des virgules
|Liste des attributs à retourner
|-
|where
|Expression objet
|Filtre de la requête
|-
|orderBy
|Attribut de tri
|Ordre de tri de la requête
|-
|count
|Taille de page (*)
|Pagination : Taille de page
|-
|startIndex
|Index de page
|Pagination par page : Numéro de page (0 première)
|-
|startKey
|Valeur de clé ou de tri
|Pagination par clé : Clé de position
|-
|keyDirection
|lt,le,gt,ge
|Pagination par clé : direction par rapport à startKey
|-
|dateFormat
|noTime, locale, utc
|Indique le format de date retourné pour les types de données date comptable
|}

(*) Il existe une limite par défaut si la valeur de count n'est pas précisée.

Les valeurs passées en paramètre doivent être encodées en HTML

Exemple :

where=code eq 'ABI 007'

doit être encodée en :

where=code%20eq%20%27ABI%20007%27

====Select====
Select permet de définir les attributs à retourner, par défaut tous les attributs non vide sont retournés

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code,caption
</pre>

La présence du paramètre select conditionne la façon d'exécuter la requête.

Les formats possibles sont :

{|class="wikitable"
|-
!format
!Usage
!Génère l'utilisation d'une vue
|-
|x
|Attribut x de la ressource
|non
|-
|x.y
|Attribut y de la ressource lié par de référence x (jointure exacte)
|oui
|-
|x.+y
|Attribut y de la ressource lié par de référence x (jointure externe)
|oui
|-
|x as y
|Attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y)
|Opération sur l'attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y;z)
|Opération sur les attributs y et z de la ressource retourné sous l'alias x
|oui
|}

Une vue sera utilisée si au moins un des membres de select nécessite l'utilisation d'une vue.

Pour les opérateurs utilisables consultez [[Vue_locale_(langage)|la page sur les vues locales]]

Notes :

* La sélection d'attribut référencé non défini peut générer l'absence de ressources dans le résultat, pour éviter ceci utilisez un spécificateur de jointure externe.
* La sélection d'attribut référencé par un rôle liste peut générer plusieurs ressources dans le résultat correspondant à chaque ressource liée par la relation.
* La séparation des paramètres pour les opérateurs ayant plusieurs paramètres utilise le séparateur ; et pas ,
* Lorsqu'une vue est utilisée, les filtres et ordre de tri sont exprimés par rapport à la vue.

Par exemple :
* TCompteGeneral?select=codeCompte&where=codeCompte ge '4'&orderBy=codeCompte
mais
* TCompteGeneral?select=code as codeCompte&where=code ge '4'&orderBy=code

====Dates comptables====
Le paramètre dateFormat permet de définir le format des dates comptables retournées par l'API

{|class="wikitable"
|-
!Version API
!dateFormat
!Exemple
!Format
!Représente
!Temps UTC
|-
|1.6
|
|2021-05-31T22:00:00Z
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|
|2021-06-01T00:00:00+02
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|locale
|2021-06-01T00:00:00
|Format heure locale
|Un instant heure locale
|
|-
|1.7
|noTime
|2021-06-01
|Format date locale
|Une date locale
|
|-
|1.7
|UTC
|2021-05-31T22:00:00Z
|Format heure UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

====Filtre====

'''Opérateurs:'''

{|class="wikitable"
|-
!opérateur
!équivalence
!exemple
!encoded
|-
|eq
|=
|where=code eq 'ABI 007'
|where=code%20eq%20%27ABI%20007%27
|-
|ne
|<>
|
|
|-
|lt
|<
|
|
|-
|le
|<=
|
|
|-
|gt
|>
|
|
|-
|ge
|>=
|
|
|-
|like
|like
|where=code like 'ABI %'
|where=code%20like%20%27ABI %25%27
|-
|in
|in
|
|
|}

'''Valeurs des paramètres:'''

Les valeurs des paramètres sont passées en littérale

{|class="wikitable"
|-
!Type de donnée
!exemple
|-
|Chaîne
|code eq 'xxx'
|-
|boolean
|flag eq true
|-
|numérique
|value eq 1
|-
|flottant
|value eq 1.0
|-
|date (voir format)
|$updated > '2019-12-31T23:00:00Z'
|-
|enum (par index)
|value eq 1
|-
|enum (par constant)
|value eq sens_credit
|}

Format des paramètres date :

{|class="wikitable"
|-
!format
!décodage
!Exemple (1 jan. 2020 France)
|-
|AAAA-MM-DDTHH:MM:SS.MMMZ
|ISO-8601 UTC
|2019-12-31T23:00:00Z
|-
|AAAA-MM-DDTHH:MM:SS.MMM+OFFSET
|ISO-8601 avec timezone
|2019-12-31T23:00:00+1
|-
|AAAA-MM-DDTHH:MM:SS.MMM
|ISO-8601 sans timezone
|2020-01-01T00:00:00
|-
|AAA-MM-DD
|Date au format ISO-8601
|2020-01-01
|-
|DD/MM/AAAA
|Date au format local
|01/01/2020
|}

====Ordre de tri====

Tri ascendant :

orderby=code

Tri descendant :

orderby=code%20desc

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?orderBy=code%20desc
</pre>

====Pagination par page====

Utiliser orderBy, count et startIndex

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=0
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=10
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=20
...
</pre>

{{tip|Incrémentez startIndex du nombre de ressource retourné par la requête}}

====Pagination par clé====

Utiliser orderBy, startKey et keyDirection

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startKey=1B28EFFFF1C3000200F6000000230893&keyDirection=lt
</pre>

==Création de ressource (POST)==
<pre>
POST http://localhost:8080/sdata/gentiers/ttiers
Request:
{
"code":"SYFRE1",
"caption":"syfre 1",
"sitesList":[
{
"code":"SITE1",
"caption":"site1 de syfre1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E20022",
"$url": "http://localhost:8080/sdata/l1000/gentiers/-/TTiers('9D33A23CFA6A005500F6000001E20022')",
... attribute list ...
}
]
}
</pre>

===Gestion du périmètre de partage===

Le niveau de partage d'une ressource de niveau activité peut être contrôlé par des propriétés de contrôle au niveau de la définition de la ressource :

{|class="wikitable"
|-
!Contrôle
!Usage
|-
|$shareId
|Valeur du périmètre sur lequel créer l'objet
|-
|$shareLevel
|Niveau de partage sur lequel créer l'objet (0:dossier,1:activité ou 2:société)
|}

<pre>
POST https://localhost/sdata/S3/gentiers/ttiers
Request:
{
"$shareLevel":2,
"code":"SYFRES3-2",
"caption":"syfre S3-2",
"sitesList":[
{
"code":"SITE1",
"caption":"site 1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response : 201 OK
</pre>

{{Tip|Par défaut la ressource sera créée au niveau activité}}

===Gestion des rôles===

La création de ressource dans les rôles dépend de la nature du rôle.

* Pour les rôles de type composition les ressources liées sont créés simultanément.
* Pour les rôles qui ne sont pas des compositions les ressources liées sont rattachés.

'''Identification des références'''

'''Par clé:'''
<pre>
{
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
</pre>

'''Par uri:'''
<pre>
{
"pays":{
"$url":TPays("9D33A23CFA6A005500150000001700FD")
}
}
</pre>

'''Par expression:'''
<pre>
{
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
</pre>

Lorsqu'une expression est utilisée la première ressource retournée par l'expression est utilisée.

===Gestion des dates comptables===
Pour les dates comptables, le serveur convertit la date reçu en heure locale puis conserve la partie date.

{|class="wikitable"
|-
!Format
!Représente
!Exemple
!Interprète
|-
|locale
|Une heure locale
|2021-06-01T00:00:00
|Conserve l’heure reçue en heure locale et conserve la date, la date sera toujours celle transmise.
|-
|noTime
|Une date sans heure
|2021-06-01
|Conserve la date reçue sans conversion, la date sera toujours celle transmise.
|-
|UTC
|Un instant universel UTC
|2021-05-31T22:00:00Z
2021-05-31T22:00:00+02
|Convertit l’heure UTC en heure locale du service et conserve la date reçue, la date peut être différente de la date transmise si le client et le service ne sont pas dans le même fuseau horaire.
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

==Modification de ressource (PUT)==
<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request:
{
"codeSIRET":"12345678"
}
Response: 200 OK
[
{
.... resource modified ...
}
]
</pre>

===Modification de rôle liste composition===
Par défaut les rôles composition sont gérés en remplacement, pour contrôler le mode de gestion des rôles utilisez un élément de contrôle "$" pour le rôle :

'''Exemple : Modification du rôle par remplacement des composants :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites has been removed.
... There is one site left in the list
]
]
}
</pre>

'''Exemple : Modification du rôle par ajout de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["create"]
},
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites are not affected
... There is one site more in the list
}
]
]
}
</pre>

'''Exemple : Modification du rôle par mise à jour de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["update"]
},
"sitesList":[
{
"$key":"9D33A23CFA6A005500F6000001E30019",
"caption":"Site maj",
}
]
}
</pre>

{|class="wikitable"
|-
!contrôle
!action
|-
|create
|Les nouvelles ressources sont ajoutées au rôle
|-
|update
|Les ressources existantes dans le rôle sont mise à jour
|-
|delete
|Les ressources existantes et non présentes dans la requête sont supprimées
|}

La valeur par défaut est "create","update","delete"

===Modification des attributs privés===
Par défaut les attributs privés sont modifiés sur le niveau de partage correspondant au périmètre société, pour contrôler le niveau de partage des attributs privés utilisez un élément de contrôle $sharePrivateLevel.

{|class="wikitable"
|-
!sharePrivateLevel
!Périmètre de définition
|-
|absent
|Périmètre courant de l'objet
|-
|0
|Dossier
|-
|1
|Activité
|-
|2
|Société
|}

{{tip|Le périmètre courant de l'objet dépend de l'état de l'objet. Par exemple, si l'objet est de niveau activité et n'a pas de propriété défini pour la société courante, le périmètre courant sera l'activité, mais si l'objet a des propriétés définies pour la société courante alors le périmètre courant sera la société. Ne pas définir explicitement le niveau de partage peut amener à des ambiguïtés.}}

'''Modification de la valeur de l'attribut privé pour les sociétés de l'activité du Tiers (le tiers n'a pas de propriété défini pour la société S3):'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"modeReglementDecaissement":{"$where":"code eq 'CHQ'"},
}
</pre>

'''Modification de la valeur de l'attribut privé pour la société S3 :'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"$sharePrivateLevel":2,
"modeReglementDecaissement":{"$where":"code eq 'CBB'"},
}
</pre>

==Suppression de ressource (DELETE)==
<pre>
DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Response: 200 OK
</pre>

==Opération sur une ressource (POST)==

Les opérations des ressources correspondent aux méthodes publiques de cette ressource.

===Méthode d'instance de ressource===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/wfclassea('B5A28A92EB0C00020010000000DB0006')/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Méthode de classe de ressource, ou méthode de classe non persistante===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Passage des paramètres===
Les paramètres sont passés par nom et valeur.

Les types de paramètres et de retour supportés sont :

{|class="wikitable"
|-
!Type
!Exemple
|-
|Chaîne
|"p":"xxx"
|-
|Entier
|"p":1
|-
|Boolean
|"p":true
|-
|Flottant
|"p":1.1
|-
|Datetime
|"p":"2020-12-25T01:01:01"
|-
|Enuméré (par valeur)
|"p":1
|-
|Liste d'objets
|"p":[ {$key:"key", $uuid:"uuid", $where:"expression"}, ...],
|}

{{tip|Les références des objets passés dans des listes peuvent être définies par clé ($key), identifiant appelant ($uuid) ou expression ($where)
Exemple :
<pre>
{
"paramList":[
{"$key":"B5A28A92EB0C00020010000001F500A1"},
{"$where":"uneChaine like 'cN%'"}
]
}
</pre>
}}

===Résultat de type ressource===
Lorsque l'opération retourne un objet ou une liste d'objets ceux-ci sont retournés sous forme de ressource.

Par exemple :

<source lang="delphi">
//class Function GetWFClasseA(const iCode:string):WFClasseA;
begin
Result := WFClasseA.Find('(unCode = %1)','unCode',True,[iCode]);
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassea
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:41:41.015Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
}
]
}
}
</pre>

<source lang="delphi">
//Class Function GetWFClasseA(const iCodeLike:string):WFClasseAList;
begin
Result := WFClasseA.CreateListWhere('(unCode like %1)','','unCode',True,-1,[iCodeLike]);
end;
</source>

<pre>

POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassealist
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:49:14.061Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
},
{
"$key": "B5A28A92EB0C00020010000001B4000E",
"$etag": "B5A28A92EB0C00020010000001B4000E-0000025000000025",
"stamp": "0000025000000025",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaalb",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 2,
"title": "Etat 2"
},
"unStatus": 0
},
{
"$key": "B5A28A92EB0C00020010000001B4001A",
"$etag": "B5A28A92EB0C00020010000001B4001A-0000018B0000001A",
"stamp": "0000018B0000001A",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaale",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 0,
"title": "Initial"
},
"unStatus": 0
},
......
]
}
}
</pre>

===Initialisation de la ressource===
Il est possible d'initialiser la ressource avant d'exécuter la méthode, par exemple pour un processus :

<source lang="delphi">
Type
TmyProcessus = class
public
procedure Execute(p:string);
property attString:string;
property attInt:Integer;
property attRef:TRefClass;
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/execute
Request:
{
"$resource":{
"attString":"value 1",
"attInt":100,
"attRef":{"$url":"TRefClass('xxx')"},
},
"p":"value",
}
Response: 200 OK
{
"result":""
}
</pre>

==Requête Batch (POST $batch)==
Une requête Batch permet de réaliser plusieurs opérations de type GET,POST/PUT/DELETE/EXEC en une seule fois.

Une requête Batch contient un tableau de ressources, pour chaque ressource l'action et l'uri doivent être précisées :

<pre>
POST http://.../sdata/$batch
{
"$resources":[
{
"$httpMethod":"POST",
"$url":"gentiers/ttiers",
"code":"SYFRE2",
"caption":"syfre 2",
"sitesList":[
{
"code":"SITE1",
"caption":"site2 de syfre2",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
]
}
</pre>

{{tip|Le format d'url complet de $Batch est https://hostname/service/server/sdata/l1000/-/-/$batch}}

===Gestion de la transaction dans un batch===
Par défaut les opérations réalisées sont unitaires (une transaction par ressource).

Pour réaliser une opération Batch atomique (une seule transaction longue) utilisez un élément de contrôle transaction :

Lorsque l'opération est atomique la réponse contient un élément $batch indiquant le statut de l'opération.

Le code de retour http est le code de retour de la dernière opération réalisée.

<pre>
POST http://localhost:8080/sdata/$batch
{
"$": {"$transaction":["atomic"]},
"$resources":[
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')",
"$uuid":"1",
"capital":{"value":7200,"CodeDevise":"USD"}
},
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$uuid":"2",
"capital":{"value":1000,"CodeDevise":"EUR"}
}
]
}
Response : 401
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "PUT",
"$httpMessage": "OK",
"$etag": "9D33A23CFA6A005500F6000000285DAE-0000018C00000001"
},
{
"$httpStatus": 410,
"$httpMessage": "Already Deleted",
"$uuid": "2",
"$url": "gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis"
}
]
}
}
],
"$batch": {
"$httpStatus": 400,
"$httpMessage": "ROLLBACK",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis",
"entry": {
"number": 2,
"uuid": "2"
}
}
]
}
}
}
</pre>

'''$transaction :'''

{|class="wikitable"
|-
!Commande
!Action
|-
|atomic
|Démarre une transaction longue
|-
|flush
|Force un batch de la transaction longue
|-
|commit
|Valide la transaction longue
|}
{{Tip|L'élément de contrôle de transaction peut être placé au niveau d'un ordre du lot.}}

===Execution de méthode dans un batch===
Utiliser le verbe EXEC pour exécuter une méthode

<pre>
POST http://localhost:8080/sdata/$batch
{
"$resources":[
{
"$httpMethod":"EXEC",
"$url":"testsyfrewf/wfprocessus/testmethod",
"$resource":{
"uneChaine":"value 1"
},
"p":"value 2"
}
]
}
Response : 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "POST",
"$httpMessage": "Executed",
"$url": "testsyfrewf/wfprocessus/testmethod",
"$uuid": "",
"result": "value 1 value 2"
}
]
}
</pre>

==Schéma d'une ressource (GET $schema)==
Le schéma d'une ressource retourne la structure de la classe.

<pre>
GET http://localhost:8080/sdata/testsyfrewf/wfclassea/$schema
Response : 200 OK
{
"title": "Libellé de la Classe A",
"stereotype": "persistent",
"properties": {
"unBool": {
"type": "boolean",
"title": "Un Bool"
},
"unCode": {
"type": "string",
"title": "Un code"
},
"unCompteur": {
"type": "string"
},
"unDerive": {
"type": "string",
"title": "Un dérivé"
},
"unDouble": {
"type": "double",
"title": "Un double"
},
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEmail": {
"type": "string",
"title": "Un email"
},
"unEntier": {
"type": "int",
"title": "Un Entier"
},
"unEtat": {
"type": "integer",
"title": "Un Etat"
},
"unStatus": {
"type": "int",
"title": "Statut de l'objet (Panel)"
},
"WFClasseBRef": {
"type": {
"$ref": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseB/$schema",
"$relationship": "reference"
},
"title": "Référence B"
},
"WFClasseCList": {
"type": "array",
"item": {
"title": "Classe C",
"properties": {
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEntier": {
"type": "int",
"title": "un entier"
}
}
}
}
},
"$url": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseA/$schema"
}
</pre>

Le contenu de la réponse peut être configurée avec le paramètre "select", à défaut toutes les informations sont retournées.

{|class="wikitable"
|-
!Paramètre
!Usage
|-
|extensions
|Retourne uniquement les attributs issus d'extension
|-
|properties
|Retourne la liste de tous les attributs
|-
|selfProperties
|Retourne uniquement les attributs de la classe elle même
|-
|operations
|Retourne les opérations de la classe
|-
|compositions
|Retourne le schéma des classes composants
|}

Exemple : Retrouver uniquement les attributs d'extension d'une classe :

<pre>
GET http://localhost:8080/sdata/ttiers/$schema?select=extensions
{
"title": "Tiers",
"stereotype": "persistent",
"extensions": [
{
"class": "TTiers_esmPackage",
"title": "Extension de TTiers",
"package": "esmPackage"
}
],
"properties": {
"esmCode": {
"type": "string",
"extension": "TTiers_esmPackage",
"title": "un code esm"
}
},
"$url": "http://localhost:8080/sdata/gentiers/TTiers/$schema"
}
</pre>

==Modèle de ressource (GET $template)==
Le modèle de ressource retourne une ressource initialisée

<pre>
GET http://localhost:8080/sdata/gcimport/TImportContratCommercial/$template
Response : 200 OK

{
"$url": "http://localhost:8080/sdata/l1000/gcimport/-/TImportContratCommercial",
"stamp": "000001D900000001",
"acompte": 0,
"affaire": "",
"budget": "",
"Caption": "",
"commandeEngagement": false,
"commercial": "",
"coursDevise": {
"value": 1,
"CodeDevise": "",
"Date": "1899-12-30T00:00:00.000Z",
"TCConv": "",
"TCValue": 0,
"RPConv": "",
"RPValue": 0
},
"coursNegocie": false,
"dateCommande": "1899-12-30T00:00:00.000Z",
"dateLivraison": "1899-12-30T00:00:00.000Z",
"devise": "",
"donneeEDI1": "",
"donneeEDI2": "",
"donneeEDI3": "",
"donneeEDI4": "",
"donneeEDI5": "",
"echeancement": "",
"etablissement": "",
"exonereTaxe": "",
"exonereTVA": "",
"gestionTransport": {
"value": 0,
"title": "Automatique"
},
"immobilisation": {
"value": 0,
"title": "B&S"
},
"ImportCCDetailList": [],
"importeGMAO": false,
"importerRemisePied": false,
"ImportSiteAdresse": {},
"incoterm": "",
"MentionExonerationTVA": "",
"posteBudgetaire": "",
"pourcentAcompte": {
"value": 0,
"Decimales": 2
},
"pourcentRemisePied": {
"value": 0,
"Decimales": 2
},
"reference": "",
"referenceMandat": "",
"regimeTVA": "",
"roleTiers": "",
"roleTiersLivre": "",
"SessionImportation": {},
"typeFacturation": {
"value": 0,
"title": "HT"
}
}
</pre>

Voir aussi :

* [[SData|Point d'accès et url SData]]
* [[Gestion des jetons d'authentification (Administration)|Gestion des jetons d'authentification]]
* [[API Json (SData)|API SData en mode json]]
* [[Fichier_de_configuration_(server)#Logs|Enregistrement des messages SDATA]]

Voir aussi les exemples suivants :

* [[Utilisation du contrôleur de partage (API)|Utilisation du contrôleur de partage]]
* [[Interrogation des écritures (API)|Interrogation des écritures avec l'API SData]]
* [[Interrogation des fournisseurs (API)|Interrogation des fournisseurs avec l'API SData]]
* [[Creation d'un fournisseur (API)|Création d'un fournisseur avec l'API SData]]
* [[Import_de commandes_(API)|Import de commandes avec l'API SData]]
* [[Import_d%27écritures_(API)|Import d'écritures avec l'API SData]]
* [[Gestion des réceptions fournisseurs (API)|Gestion des réceptions fournisseurs avec l'API SData]]
* [[Facturation d'un bon de livraison (API)|Facturation d'un bon de livraison avec l'API SData]]
* [[Creation_d%27un_Tiers_et_son_compte_bancaire_(API)|Creation_d'un Tiers et son compte bancaire (API)]]
* [[Statuts de paiement d'une facture (API)|Statuts de paiement d'une facture avec l'API SData]]
[[Category:SData]]

Statuts de paiement d'une facture (API)

2026-09-16T11:30:58Z

Cesru : ajout de la catégorie

Cette page décrit comment une gestion commerciale externe peut récupérer les statuts '''Encaissée''' générés dans FRP 1000 pour une facture comptable.

L'application externe utilise ces informations pour piloter et réaliser elle-même la transmission des statuts vers son propre destinataire. L'API SData est consultée en lecture seule.

== Principe ==

FRP 1000 génère un événement de cycle de vie `212`, correspondant au statut '''Encaissée''', pour chaque règlement lettré sur une facture.

Une facture peut posséder :

* un règlement unique ;
* plusieurs règlements partiels ;
* un événement d'annulation après délettrage d'un règlement.

La réponse doit donc être traitée comme un '''historique d'événements''', et non comme le statut courant unique de la facture.

== Pré-requis ==

* Connaître la référence de la facture (`oid`, `numeroPiece`, `reference`, `referenceExterne`, etc.).
* La pièce doit appartenir au flux '''e-invoicing'''.

== Identifier la facture ==

Dans les exemples à venir, la requête recherche une facture grâce à `referenceOrigine`.

Cette valeur doit être celle fournie par la gestion commerciale lors de l'intégration de la facture dans FRP 1000. En pratique, il s'agit généralement du numéro de facture de la gestion commerciale.

Exemple : si la facture externe porte le numéro `FAC-2026-000123`, la pièce FRP 1000 doit avoir :

<source lang="delphi">
TPiece.referenceOrigine = 'FAC-2026-000123'
</source>

== Requête SData ==

<source lang="text">
GET http://localhost:8080/sdata/cptmouvement/tpiece?
where=typeFlux eq 1
and codeStatut eq '212'
and referenceOrigine eq 'FAC-2026-000123'
&select=referenceOrigine,
idStatut as StatutFEList.oid,
dateStatut as StatutFEList.DateStatut,
codeStatut as StatutFEList.StatutCycleVie.code,
idStatutAnnule as StatutFEList.oidStatutAnnule,
StatutFEList.dataContent
&orderBy=StatutFEList.DateStatut
</source>

''Cette présentation est destinée à la lisibilité.''

=== Paramètres de requête ===

{| class="wikitable"
! Paramètre
! Rôle
|-
| where
| Filtre les pièces du flux `e-invoicing`, les statuts « Encaissé » et la référence externe de facture.
|-
| select
| Limite la réponse aux informations utiles au consommateur.
|-
| orderBy
| Trie les événements par date de statut croissante.
|}

=== Informations retournées ===

{| class="wikitable"
! Champ
! Description
! Usage par l'application externe
|-
| referenceOrigine
| Référence externe de la facture.
| Rattacher l'événement à la facture de la gestion commerciale.
|-
| idStatut
| Identifiant unique du statut de paiement.
| Identifiant d'idempotence : conserver les statuts déjà transmis.
|-
| dateStatut
| Date et heure de création du statut dans FRP 1000.
| Ordonner l'historique des événements.
|-
| codeStatut
| Code du statut de cycle de vie.
| Vaut `212` pour « Encaissée ».
|-
| idStatutAnnule
| Identifiant du statut d'encaissement annulé.
| Présent uniquement pour une annulation.
|-
| dataContent
| Snapshot JSON du règlement.
| Désérialiser pour obtenir les informations à transmettre.
|}

=== Contenu de `dataContent` ===

`dataContent` est une chaîne contenant un tableau JSON. Il fournit notamment :

{| class="wikitable"
! Propriété
! Description
|-
| InvoiceID
| Identifiant de la facture.
|-
| isCreditNote
| Indique si la facture est un avoir.
|-
| isDiscount
| Indique si le règlement est un escompte.
|-
| isDownpayment
| Indique si la facture est un acompte.
|-
| isPurchase
| Indique si la facture relève d'un flux d'achat.
|-
| isSale
| Indique si la facture relève d'un flux de vente.
|-
| IssueDate
| Date de la facture.
|-
| Payment.Amount
| Montant encaissé.
|-
| Payment.Currency
| Devise du règlement.
|-
| Payment.Date
| Date du règlement.
|-
| Payment.SubTotals
| Ventilation TVA.
|-
| typeCode
| Code du type de flux, par exemple `MEN`.
|}

Exemple de contenu :

<source lang="javascript">
[
{
"InvoiceID": "FAC-2026-000123",
"isCreditNote": false,
"isDiscount": false,
"isDownpayment": false,
"isPurchase": 0,
"isSale": 1,
"IssueDate": "2026-09-14",
"Payment": {
"Amount": 1000.0000,
"Currency": "EUR",
"Date": "2026-09-14",
"SubTotals": [
{
"Percent": 20.00,
"TaxableAmount": 1000.00
}
]
},
"typeCode": "MEN"
}
]
</source>

== Cas 1 — Facture réglée en une fois ==

La facture `FAC-2026-000123` possède un encaissement de 1000 EUR.

<pre style="white-space: pre-wrap; overflow-wrap: anywhere;">
GET http://localhost:8080/sdata/cptmouvement/tpiece?
where=typeFlux eq 1
and codeStatut eq '212'
and referenceOrigine eq 'FAC-2026-000123'
&select=referenceOrigine,
idStatut as StatutFEList.oid,
dateStatut as StatutFEList.DateStatut,
codeStatut as StatutFEList.StatutCycleVie.code,
idStatutAnnule as StatutFEList.oidStatutAnnule,
StatutFEList.dataContent
&orderBy=StatutFEList.DateStatut

Response: 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/cptmouvement/",
"$title": "TPiece - -",
"$updated": "2026-09-16T10:46:51.428+02:00",
"$resources": [
{
"$url": "TPiece('860D26D2C52800A007CC0000240A0053')",
"$title": "860D26D2C52800A007CC0000240A0053",
"$updated": "2026-09-14T17:45:10.000+02:00",
"$etag": "860D26D2C52800A007CC0000240A0053-000028B2000000EA",
"$shareId": "860D26D2C52800A007220000024D000B",
"$shareInfo": "S1",
"$shareLevel": 2,
"$key": "860D26D2C52800A007CC0000240A0053",
"stamp": "000028B2000000EA",
"codeStatut": "212",
"dataContent": "[{\"InvoiceID\":\"FAC-2026-000123\",\"isCreditNote\":false,\"isDiscount\":false,\"isDownpayment\":false,\"isPurchase\":0,\"isSale\":1,\"IssueDate\":\"2026-09-14\",\"Payment\":{\"Amount\":1000.0000,\"Currency\":\"EUR\",\"Date\":\"2026-09-14\",\"SubTotals\":[{\"Percent\":20.00,\"TaxableAmount\":1000.00}]},\"typeCode\":\"MEN\"}]",
"dateStatut": "2026-09-14T18:02:43.000+02:00",
"idStatut": "860D26D2C52800A072AB0000240A0090",
"referenceOrigine": "FAC-2026-000123"
}
]
}
</pre>

== Cas 2 — Facture réglée en plusieurs fois ==

La facture `FAC-2026-000123` est réglée par deux encaissements : 1 000 EUR, puis 200 EUR.

<pre style="white-space: pre-wrap; overflow-wrap: anywhere;">
GET http://localhost:8080/sdata/cptmouvement/tpiece?
where=typeFlux eq 1
and codeStatut eq '212'
and referenceOrigine eq 'FAC-2026-000123'
&select=referenceOrigine,
idStatut as StatutFEList.oid,
dateStatut as StatutFEList.DateStatut,
codeStatut as StatutFEList.StatutCycleVie.code,
idStatutAnnule as StatutFEList.oidStatutAnnule,
StatutFEList.dataContent
&orderBy=StatutFEList.DateStatut

Response: 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/cptmouvement/",
"$title": "TPiece - -",
"$updated": "2026-09-16T10:46:18.876+02:00",
"$resources": [
{
"$url": "TPiece('860D26D2C52800A007CC0000240B000C')",
"$title": "860D26D2C52800A007CC0000240B000C",
"$updated": "2026-09-15T14:59:32.000+02:00",
"$etag": "860D26D2C52800A007CC0000240B000C-000028B300000057",
"$shareId": "860D26D2C52800A007220000024D000B",
"$shareInfo": "S1",
"$shareLevel": 2,
"$key": "860D26D2C52800A007CC0000240B000C",
"stamp": "000028B300000057",
"codeStatut": "212",
"dataContent": "[{\"InvoiceID\":\"FAC-2026-000123\",\"isCreditNote\":false,\"isDiscount\":false,\"isDownpayment\":false,\"isPurchase\":0,\"isSale\":1,\"IssueDate\":\"2026-09-14\",\"Payment\":{\"Amount\":1000.0000,\"Currency\":\"EUR\",\"Date\":\"2026-09-14\",\"SubTotals\":[{\"Percent\":20.00,\"TaxableAmount\":1000.00}]},\"typeCode\":\"MEN\"}]",
"dateStatut": "2026-09-15T15:01:18.000+02:00",
"idStatut": "860D26D2C52800A072AB0000240B002B",
"referenceOrigine": "FAC-2026-000123"
},
{
"$url": "TPiece('860D26D2C52800A007CC0000240B000C')",
"$title": "860D26D2C52800A007CC0000240B000C",
"$updated": "2026-09-15T14:59:32.000+02:00",
"$etag": "860D26D2C52800A007CC0000240B000C-000028B300000057",
"$shareId": "860D26D2C52800A007220000024D000B",
"$shareInfo": "S1",
"$shareLevel": 2,
"$key": "860D26D2C52800A007CC0000240B000C",
"stamp": "000028B300000057",
"codeStatut": "212",
"dataContent": "[{\"InvoiceID\":\"FAC-2026-000123\",\"isCreditNote\":false,\"isDiscount\":false,\"isDownpayment\":false,\"isPurchase\":0,\"isSale\":1,\"IssueDate\":\"2026-09-14\",\"Payment\":{\"Amount\":200.0000,\"Currency\":\"EUR\",\"Date\":\"2026-09-15\",\"SubTotals\":[{\"Percent\":20.00,\"TaxableAmount\":200.00}]},\"typeCode\":\"MEN\"}]",
"dateStatut": "2026-09-15T15:02:24.000+02:00",
"idStatut": "860D26D2C52800A072AB0000240B0032",
"referenceOrigine": "FAC-2026-000123"
}
]
}
</pre>

Les deux éléments sont deux événements distincts. Le second encaissement ne remplace pas le premier.

== Cas 3 — Annulation d'un paiement ==

Une annulation est produite lorsque le règlement précédemment lettré est délettré, puis que la tâche '''Génération des statuts de paiement''' est exécutée.

La réponse contient alors :

* le statut d'encaissement initial ;
* un nouveau statut `212` ;
* la propriété `idStatutAnnule`, qui référence l'identifiant du statut initial.

<pre style="white-space: pre-wrap; overflow-wrap: anywhere;">
GET http://localhost:8080/sdata/cptmouvement/tpiece?
where=typeFlux eq 1
and codeStatut eq '212'
and referenceOrigine eq 'FAC-2026-000123'
&select=referenceOrigine,
idStatut as StatutFEList.oid,
dateStatut as StatutFEList.DateStatut,
codeStatut as StatutFEList.StatutCycleVie.code,
idStatutAnnule as StatutFEList.oidStatutAnnule,
StatutFEList.dataContent
&orderBy=StatutFEList.DateStatut

Response: 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/cptmouvement/",
"$title": "TPiece - -",
"$updated": "2026-09-16T10:45:31.403+02:00",
"$resources": [
{
"$url": "TPiece('860D26D2C52800A007CC0000240B0035')",
"$title": "860D26D2C52800A007CC0000240B0035",
"$updated": "2026-09-16T10:31:27.000+02:00",
"$etag": "860D26D2C52800A007CC0000240B0035-000028B300000095",
"$shareId": "860D26D2C52800A007220000024D000B",
"$shareInfo": "S1",
"$shareLevel": 2,
"$key": "860D26D2C52800A007CC0000240B0035",
"stamp": "000028B300000095",
"codeStatut": "212",
"dataContent": "[{\"InvoiceID\":\"FAC-2026-000123\",\"isCreditNote\":false,\"isDiscount\":false,\"isDownpayment\":false,\"isPurchase\":0,\"isSale\":1,\"IssueDate\":\"2026-09-16\",\"Payment\":{\"Amount\":1000.0000,\"Currency\":\"EUR\",\"Date\":\"2026-09-16\",\"SubTotals\":[{\"Percent\":20.00,\"TaxableAmount\":1000.0000}]},\"typeCode\":\"MEN\"}]",
"dateStatut": "2026-09-16T10:32:53.000+02:00",
"idStatut": "860D26D2C52800A072AB0000240B004F",
"referenceOrigine": "FAC-2026-000123"
},
{
"$url": "TPiece('860D26D2C52800A007CC0000240B0035')",
"$title": "860D26D2C52800A007CC0000240B0035",
"$updated": "2026-09-16T10:31:27.000+02:00",
"$etag": "860D26D2C52800A007CC0000240B0035-000028B300000095",
"$shareId": "860D26D2C52800A007220000024D000B",
"$shareInfo": "S1",
"$shareLevel": 2,
"$key": "860D26D2C52800A007CC0000240B0035",
"stamp": "000028B300000095",
"codeStatut": "212",
"dataContent": "[{\"InvoiceID\":\"FAC-2026-000123\",\"isCreditNote\":false,\"isDiscount\":false,\"isDownpayment\":false,\"isPurchase\":0,\"isSale\":1,\"IssueDate\":\"2026-09-16\",\"Payment\":{\"Amount\":1000.0000,\"Currency\":\"EUR\",\"Date\":\"2026-09-16\",\"SubTotals\":[{\"Percent\":20.00,\"TaxableAmount\":1000.0000}]},\"typeCode\":\"MEN\"}]",
"dateStatut": "2026-09-16T10:35:13.000+02:00",
"idStatut": "860D26D2C52800A072AB0000240B0051",
"idStatutAnnule": "860D26D2C52800A072AB0000240B004F",
"referenceOrigine": "FAC-2026-000123"
}
]
}
</pre>

Dans cet exemple, le statut `860D...004F` est annulé par le statut `860D...0051`.

L'application externe doit transmettre l'annulation selon son propre protocole et conserver les deux événements dans son historique.

== Cas sans encaissement ==

Lorsqu'aucun statut `Encaissé` (`212`) ne correspond à la facture recherchée, la réponse HTTP est réussie (`200`) et le tableau `$resources` est vide :

<pre>
Response: 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/cptmouvement/",
"$title": "TPiece - -",
"$updated": "2026-09-16T11:47:32.384+02:00",
"$resources": []
}
</pre>

[[Category:SData]]

Statuts de paiement d'une facture (API)

2026-09-16T11:29:39Z

Cesru : Page créée avec « Cette page décrit comment une gestion commerciale externe peut récupérer les statuts '''Encaissée''' générés dans FRP 1000 pour une facture comptable. L'applicatio... »

Travailler sur une branche git

2020-07-01T08:14:04Z

Cesru : Correction mot manquant

==Principe==

Il s'agit de créer une branche, de développer sur cette branche et de pousser les modifications dans BitBucket pour partager cette branche avec l'équipe.

==Mise en oeuvre==

===Création de branche dans le concepteur===
====Dans le concepteur de modèle ajouter un nouvelle branche====

"add new branch"=crée une branche ; "Checkout new branch"=crée une branche et se positionne dessus)

[[image:git_branch0.png]]

====Choisir le type de branche et la nommer====

{{tip|Le type de branche influe sur les pulls requests}}

[[image:git_branch2.png]]

La branche apparaît dans les branches locales

[[image:git_branch30.png]]

La branche courante apparaît dans le titre de l'onglet Git

[[image:git_branch50.png]]

===Obtenir une branche distante===

Si on souhaite travailler sur une branche qu'on a pas créée (crée dans JIRA ou créée par un autre membre de l'équipe dans le concepteur), il faut faire un refresh des branches distantes pour la voir apparaître et faire un checkout pour se positionner dessus.

[[image:git_branch14.png]]

[[image:git_branch15.png]]

===Voir les modifications effectuées===

Pour voir les modification de source dans Git, penser à enregistrer les modifications

[[image:git_branch40.png]]

Voir les modifications apportées

[[image:git_branch6.png]]

===Commiter son travail===

Ajouter les fichiers modifiés dans l'index

[[image:git_branch7.png]]

Les fichiers apparaissent dans l'index

[[image:git_branch8.png]]

effectuer un commit

[[image:git_branch10.png]]

Le commit apparaît sur la branche

[[image:git_branch9.png]]

===Pousser sa branche sur le répertoire distant===

[[image:git_branch11.png]]

[[image:git_branch12.png]]

La branche est visible dans BitBucket, les autres membres de l'équipe peuvent travailler dessus en faisaint un "pull" dans le concepteur de modèle et en faisant un "checkout" sur cette branche

[[image:git_branch13.png]]

[[Category:Git]]
[[Category:Développement]]
[[Category:Version910]]

Parameters (type)

2019-09-30T08:20:50Z

Cesru :

Le type de données « Paramètres » permet de stocker dynamiquement des [[Parameter (type)|paramètres]] qui ne sont pas connu à l'avance.

Le type paramètres est stocké sous forme de document XML

Le type [[Parameter (type)|paramètre]] peut être utilisé pour stocker des couple clé/valeur.

===Propriétés===
{|class="wikitable"
|-
|[[Count (parameters type)|Count]]
|Retourne le nombre de paramètre
|}

===Méthodes===
{|class="wikitable"
|-
|[[Clear (parameters type)|Clear]]
|Vide la liste des paramètres
|-
|[[Names (parameters type)|Names]]
|Accède au nom des paramètres
|-
|[[Values (parameters type)|Values]]
|Accède au valeur des paramètres
|-
|[[ValueByIndex (parameters type)|ValueByIndex]]
|Accède au valeur des paramètres par leur index
|-
|[[NameExists (parameters type)|NameExists]]
|Test si un paramètre existe.
|-
|[[IndexOfName (parameters type)|IndexOfName]]
|Retourne l'index d'un paramètre
|-
|[[Add (parameters type)|Add]]
|Ajoute un paramètre
|-
|[[Find (parameters type)|Find]]
|Retourne un paramètre par son nom
|-
|[[Remove (parameters type)|Remove]]
|Supprime un paramètre
|-
|[[Merge (parameters type)|Merge]]
|Fusionne une liste de paramètre
|-
|[[Replace (parameters type)|Replace]]
|Remplace les valeurs par une liste de paramètre
|-
|[[Items (parameters type)|Items]]
|Retourne un paramètre par son index
|-
|[[LogEvent (parameters type)|LogEvent]]
|Transmet le contenu comme évènement.
|}

Exemple :

<source lang="delphi">
unit TestSYFREWF;
interface

Type
Facade1 = Class(TitObject)
public
keyvalue: TFrameWorkDataType;
Procedure AddKeyValue;
Class Procedure TestFacade1;
end;

Implementation

{Facade1}

Procedure Facade1.AddKeyValue;
//Procedure AddKeyValue;
begin
keyvalue.Add('source','key1',100);
//
if keyvalue.Find('source','key1').Value=100
then showMessage('OK')
else showMessage('failed');

if keyvalue.Names[0]='key1'
then showMessage('Names ok')
else showMessage('Names failed');

if keyvalue.Values['key1']=100
then showMessage('Values ok')
else showMessage('Values failed');

if keyvalue.ValueByIndex[0]=100
then showMessage('ValueByIndex ok')
else showMessage('ValueByIndex failed');

if keyvalue.NameExists('key1')
then showMessage('NameExists ok')
else showMessage('NameExists failed');

if keyvalue.IndexOfName('key1')<>-1
then showMessage('IndexOfName ok')
else showMessage('IndexOfName failed');

if keyvalue.Items[keyvalue.IndexOfName('key1')].Value=100
then showMessage('Items ok')
else showMessage('Items failed');
end;

Class Procedure Facade1.TestFacade1;
//Class Procedure TestFacade1;
begin
showMessage('Test Facade1');
end;

end.
</source>

Voir aussi :

* [[Parameter (type)|Type paramètre]]

[[Category:Type de donnée Paramètres]]
[[category:Types]]
[[Category:Version700]]

TSelectorConstraint (selector)

2016-11-17T15:08:27Z

Cesru :

{{latest}}
<source lang='delphi'>TSelectorConstraint:TObject;</source>

Cet objet matérialise une contrainte posée sur un sélecteur.

Une contrainte permet de définir une jointure et de poser des conditions sur cette jointure.

===Attributs===

{|class="wikitable"
|-
!Attribut
!Usage
|-
|[[Nom (TSelectorConstraint)|Nom]]
|Nom de la contrainte
|-
|[[Parent (TSelectorConstraint)|Parent]]
|Objet parent de la contrainte
|-
|[[ClassName (TSelectorConstraint)|ClassName]]
|Nom de la classe sur laquelle porte la sélection
|-
|[[Left (TSelectorConstraint)|Left]]
|Nom de l'attribut gauche
|-
|[[Right (TSelectorConstraint)|Right]]
|Nom de l'attribut droit
|-
|[[Where (TSelectorConstraint)|Where]]
|Clause Where de la contrainte
|-
|[[ArgCount (TSelectorConstraint)|ArgCount]]
|Nombre d'arguments de la clause where
|-
|[[Args (TSelectorConstraint)|Args[]]]
|Argument de la clause where
|}

===Méthodes d'instance===

{|class="wikitable"
|-
!Méthode
!Usage
|-
|[[AliasOf (TSelectorConstraint)|AliasOf]]
|Retourne la colonne préfixée d'un attribut de la classe de la contrainte
|-
|[[Delete (TSelectorConstraint)|Delete]]
|Supprime la contrainte
|}

===Exemples d'utilisation de contrainte===

[[image:selector_constraint_1.jpg]]

'''Contrainte venant d'une référence'''

<source lang="delphi">
function doSelector(const iCodeA:string; const iCodeB:string):Integer;
var selA:TSelector; obj:TSelectorConstraint;
begin
selA := ClassA.CreateSelector('unCodeA=%1','unCodeA',True,[iCodeA]);
obj := selA.AddConstraint(nil, 'ClassB','oid','refB','unCodeB=%1',[iCodeB]);
Result := selA.Count;
end;
</source>

'''Contrainte venant d'une référence inversée'''

<source lang="delphi">
function doSelector(const iCodeA:string; const iCodeB:string):Integer;
var selB:TSelector; obj:TSelectorConstraint;
begin
selB := ClassB.CreateSelector('unCodeB=%1','unCodeB',True,[iCodeB]);
obj := selB.AddConstraint(nil, 'ClassA','refB','oid','unCodeA=%1',[iCodeA]);
Result := selB.Count;
end;
</source>

'''Contrainte en cascade'''

<source lang="delphi">
function doSelector(const iCodeA:string; const iCodeB:string):Integer;
var selA:TSelector; obj:TSelectorConstraint;
begin
selA := ClassA.CreateSelector('unCodeA=%1','unCodeA',True,[iCodeA]);
obj := selA.AddConstraint(nil, 'ClassB','oid','refB','unCodeB=%1',[iCodeB]);
obj := selA.AddConstraint(obj, 'ClassA2','refB','oid','AliasOf(''ClassA'',''unCodeA'')=unCodeA',[]);
Result := selA.Count;
end;
</source>

'''Contrainte entre classes'''

<source lang="delphi">
function doSelector(const iCodeA:string; const iCodeB:string):Integer;
var selB:TSelector; obj:TSelectorConstraint;
begin
selB := ClassB.CreateSelector('unCodeB=%1','unCodeB',True,[iCodeB]);
obj := selB.AddConstraint(nil, 'ClassA','refB','oid','',[]);
obj := selB.AddConstraint(nil, 'ClassA2','refB','oid','(AliasOf(''ClassA'',''unCodeA'')=unCodeA2) and (unCodeA2=%1)',[iCodeA]);
Result := selB.Count;
end;
</source>

'''Mise à jour'''

<source lang="delphi">
function doSelector(const iCodeA:string; const iCodeB:string):Integer;
var selA:TSelector; obj:TSelectorConstraint;
begin
selA := ClassA.CreateSelector('unCodeA=%1','unCodeA',True,[iCodeA]);
obj := selA.AddConstraint(nil, 'ClassB','oid','refB','unCodeB=%1',[iCodeB]);
withP long transaction do
begin
Result := selA.Update(['unEntierA'],[0]);
end;
end;
</source>

'''Mise à jour en utilisant un attribut de la contrainte'''

<source lang="delphi">
function doSelector(const iCodeA:string; const iCodeB:string):Integer;
var selA:TSelector; obj:TSelectorConstraint;
begin
selA := ClassA.CreateSelector('unCodeA=%1','unCodeA',True,[iCodeA]);
obj := selA.AddConstraint(nil, 'ClassB','oid','refB','unCodeB=%1',[iCodeB]); // obj.Name='C1'
obj := selA.AddConstraint(obj, 'ClassA2','refB','oid','AliasOf(''ClassA'',''unCodeA'')=unCodeA2',[]); // obj.Name='C2'
withP long transaction do
begin
Result := selA.Update(['unEntierA'],['C2.unEntierA2']);
end;
end;
</source>

Voir aussi :

* [[AddConstraint (selector)|Ajouter une contrainte]]
* [[AliasOf (exp)|AliasOf]]

{{Footer|Selecteur (tech)}}
[[category:Sélecteur]]