Passer au contenu principal
Adaptive Planning
Dernière mise à jour : 2023-06-23
updateAccounts

updateAccounts

Pris en charge dans l'API v20 +
Catégorie
Modification de métadonnées
Description
Mettez à jour un ensemble de comptes GL existants ou créez de nouveaux comptes GL. Plusieurs comptes avec plusieurs valeurs peuvent être mis à jour en un seul appel. En cas de réussite, l’API renvoie les détails des comptes qui ont été mis à jour/créés. Si l’API échoue, une liste complète des erreurs et de leurs causes est retournée.
Autorisations obligatoires pour pouvoir être appelées
Modèle et autorisations à chaque niveau
Paramètres requis sur demande
Identifiants
La demande de cette méthode contient un marqueur d’identifiants pour désigner et autoriser l’utilisateur auteur de l’appel. L'utilisateur doit avoir le « Modèle » Concept : ensembles d’autorisations et l’autorisation requise pour administrer les comptes mis à jour.
Bonne pratique : appelez exportAccounts pour récupérer les
Adaptive Planning
Identifiants de compte nécessaires pour votre demande de mise à jourAccounts. Faites de votre mieux pour réduire le temps entre les appels de exportAccounts et les demandes de mise à jour de UpdateAccount.
HTTP
Description
Method
Post
Content-Type
texte/xml

Exemple de boucle

curl -H "Content-Type: text/xml" -d @C:/temp/updateAccounts.xml -X POST https://api.adaptiveplanning.com/api/v20
Contenu de updateAccounts.xml

Format de demande

<?xml version='1.0' encoding='UTF-8'?> <call method="updateAccounts" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <accounts proceedWithWarnings="0"> <account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1" exchangeRateType="E" isIntercompany="0" planBy="DELTA" timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE" subType="CUMULATIVE" enableActuals="1"> <account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1" exchangeRateType="E" isIntercompany="0" planBy="DELTA" timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE" subType="CUMULATIVE" enableActuals="1" propagateToDescendants="1"> <attribute name="SEC Reporting" value="Yes" /> <attribute name="GAAP Reporting" value="No" /> </account> </account> </accounts> </call>
Pour les charges utiles importantes, vous pouvez publier des fichiers XML compressés (zIP). Découvrez comment ici.
Les conditions suivantes s’appliquent à updateAccounts :
  • Les comptes sont repérés pour la mise à jour par leur numéro d’identifiant interne.
  • Pour créer de nouveaux comptes, attribuez-leur une propriété d’identifiant vide ou manquante.
    • Vous pouvez déplacer un élément existant (qui n’est pas un nouveau) pour qu’il devienne un enfant d’un nouvel élément. Cela crée le nouvel élément et déplace l’élément existant en tant qu’enfant.
    • Pour l’API v31 et les versions plus récentes, vous pouvez créer un nouveau compte parent entre un compte parent existant et ses comptes enfants.

Redéfinir la parenté des comptes

  • updateAccounts
    génère des erreurs si la valeur d’attribut d’un enfant n’est pas compatible avec le nouvel attribut parent. Exemple : l’attribut reparentedAccount1 a la valeur de rapport Seg avec la valeur Non et n’est pas compatible, car la valeur de rapport NewParentAccount2 avec la valeur Sécurité de rapport est Oui.
  • updateAccounts
    corrige les valeurs d’attribut non compatibles pour qu’elles correspondent à leur nouveau parent lors de la nouvelle parenté lorsque
    proceedWithWarnings=1.
  • Redéfinir la parenté des comptes ne peut pas créer une relation cyclique.
  • Redéfinir la parenté est interdit pour les comptes racines générés par le système :
    Assets, Liabilities and Equities, Net Income, PL Income, Non-Operating Income, PL COGS, PL Expense, Non-Operating Expenses
    .
Selon la version de l’API,
updateAccounts
permet de créer un nouveau compte parent entre un compte parent existant et ses comptes enfants :
Compte source
Déplacé sous
API v30 et antérieure
API v31 +
racine
racine
empêché
empêché
racine
parent
empêché
empêché
racine
feuille
empêché
empêché
parent
racine
autorisé
autorisé
parent
parent
autorisé
autorisé
parent
une feuille existante comme premier enfant
empêché
empêché
parent
une feuille existante qui n’est pas le premier enfant
autorisé
autorisé
parent
un nouveau premier compte enfant d’un parent existant
empêché
autorisé
parent
un nouveau compte non prioritaire qui est un enfant d’un parent existant
autorisé
autorisé
feuille
racine
autorisé
autorisé
feuille
parent
autorisé
autorisé
feuille
une feuille existante comme premier enfant
empêché
empêché
feuille
une feuille existante qui n’est pas le premier enfant
autorisé
autorisé
feuille
un nouveau premier compte enfant d’un parent existant
empêché
autorisé
feuille
un nouveau compte non prioritaire qui est un enfant d’un parent existant
autorisé
autorisé
feuille
un nouveau premier compte enfant d’une feuille existante
empêché
empêché
feuille
un nouveau compte non prioritaire qui est un enfant d’une feuille existante
autorisé
autorisé

Enfants du compte feuille

  • Le premier enfant d’un compte feuille peut uniquement être un nouveau compte. Un compte GL existant ne peut pas être déplacé sous un compte feuille existant.
  • Lorsqu’un compte reçoit son premier enfant lors de la nouvelle parenté, le mappage de comptes dans Intégration > Importer des mappages de comptes est supprimé.
  • Lors de la redéfinition de la parenté des comptes,
    balanceType
    Et
    subType
    les propriétés sont héritées de leur compte GL parent.

Comptes cubes et données entrées par cube

  • Les comptes cube de saisie peuvent être rattachés à nouveau aux parents.
  • Seuls les comptes sans données entrées en cube dans leurs sous-arborescence source et de destination peuvent être rattachés à une nouvelle parenté.
  • Les comptes CUBE/MEXED ACCOUNT ne peuvent pas être parents à nouveau.
  • Les nouveaux comptes sous un compte CUBE ACCOUNT ne sont pas autorisés. Les nouveaux comptes rattachés à un compte STANDARD/ rendre compte d’un compte MEXIQUE sont autorisés.

Format de demande pour la création d'un nouveau compte

Pour créer un nouveau compte, incluez son parent par son identifiant. Par exemple, pour ajouter un nouveau compte enfant sous la L
ocalAssets
compte
id 1441
, vous pouvez utiliser :
<?xml version='1.0' encoding='UTF-8'?> <call method="updateAccounts" callerName="Steve C"> <credentials login="sampleuser@company.com" password="my_password"/> <accounts> <account id="1441"> <account id="" code="newLocalAssets" name="new Local Assets" description="new local assets account for this area" shortName="" > </account> </account> </accounts> </call>
Cette méthode ne change rien au compte
id 1441
. Il crée un nouvel enfant nommé
new Local Assets
pour
id 1441
. Tous les enfants non précisés de
LocalAssets
passer à la fin de la liste des enfants. Cela équivaut à "définir le parent" pour le nouveau compte.

Traitement de plusieurs changements de nom dans un seul appel updateAccounts

Plusieurs renouvellements de noms de la même entité peuvent avoir lieu dans un système distant entre
updateAccounts
les appels. Les noms des entités du système distant peuvent être échangés pour les mêmes identifiants d’entité. Quand
updateAccounts
les appels ont lieu après l’échange de noms, les
updateAccounts
appel gère ces changements en suivant les identifiants pour tous les changements de nom. L’appel peut également traiter l’introduction d’un nouvel identifiant qui utilise un nom existant.
Pour que chacun des exemples réussisse, l’échange complet des identifiants doit avoir lieu avec des valeurs uniques.
Exemple 1 : un simple échange de noms dans le système distant.
ID Unique Value New Unique Value 1 AA BB 2 BB AA
Exemple 2 : une séquence de trois noms dans le système distant.
ID Unique Value New Unique Value 1 AA BB 2 BB CC 3 CC AA
Exemple 3 : une nouvelle entité utilisant une valeur unique existante.
ID Unique Value New Unique Value 4 AA 1 AA BB 2 BB Old BB
élément de données d'identification
Nom du marqueur
données d'identification
Description
Tous les appels d’API doivent contenir un élément d’identification unique pour identifier l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action afin que l’appel d’API puisse être exécuté réussir.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
ouvrir une session
Y
Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour invoquer la méthode.
sampleuser@company.com
mot de passe
Y
Le mot de passe de l’utilisateur qui invoque la méthode API.
my_password
paramètres régionaux
N
Indiquez les paramètres régionaux à utiliser pour interpréter les numéros et les dates entrants et pour mettre en forme les numéros et les dates sortants (à l’aide du séparateur des milliers, des noms de mois et du format de date appropriés). Les paramètres régionaux sont également utilisés pour préciser la langue dans laquelle tous les messages de système de la réponse doivent être affichés. Si cette valeur n’est pas précisée, la valeur en_US (rubrique en anglais américain) est utilisée.
fr_FR
instanceCode
N
Si l’utilisateur indiqué dans les données d’identification a accès à plusieurs instances de Adaptive Planning, cet attribut peut être utilisé pour indiquer que l’utilisateur a l’intention d’accéder à une instance autre que celle par défaut. Si elle n’est pas précisée, l’instance par défaut de l’utilisateur sera utilisée. Pour déterminer les codes d’instances disponibles, utilisez l’API exportInstances.
MYINSTANCE1
Contenu de l'élément
(aucun)
élément des comptes
Nom du marqueur
comptes
Description
Une seule demande d'élément de compte est autorisée par charge utile. Il contient un ou plusieurs éléments de compte.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
poursuivreAvertir
N
proceedWithWarnings="1" indique que l’API updateAccounts doit ajuster l’attribut et les propriétés du compte en fonction des changements pour la parenté de nouveau.
proceedWithWarnings="0" indique que l’API updateAccounts ne doit pas ajuster l’attribut et les propriétés du compte en fonction des changements de la nouvelle parenté. UpdateAccounts génère des erreurs avec un message indiquant le motif de l’échec. Par exemple, le mappage d’attributs ne deviendra pas valide après le redéfinition des parents.
La valeur par défaut est 0 si manquante.
1
MaintainExistingOrder
Disponible dans API v26 +
N
MaintainExistingOrder="1" indique que l’API updateAccounts doit ignorer l’ordre des éléments dans les données utiles XML et que l’ordre défini existant sera conservé.
MaintainExistingOrder="0" indique que l’API updateAccounts doit mettre à jour l’ordre des éléments en fonction de la position du marqueur par rapport aux autres enfants de mêmes parents dans la charge utile XML.
L'attribut MaintainExistingOrder est ignoré dans les versions d'API antérieures à l'API v26.
La valeur par défaut pour MaintainExistingOrder est « 0 » pour v26. Pour les versions d’API v27 et ultérieures, la valeur par défaut pour MaintainExistingOrder est « 1 ».
1
displayNameEnabled
Disponible uniquement dans l’API v32+ pour les instances qui activent le nom d’affichage.
N
displayNameEnabled=1 indique que updateAccounts doit respecter les propriétés du nom d'affichage de
code
,
displayNameType
, et
description
lorsque l’option Activer le nom d’affichage est ACTIVÉE pour l’instance.
displayNameEnabled=0 indique que l’API updateAccounts doit continuer à suivre le contrat de l’API antérieure à la version 32, même lorsque l’option Activer le nom d’affichage est ACTIVÉE pour l’instance. L'API updateAccounts ignore les propriétés du nom d'affichage
code
,
displayNameType
Et
description
.
La valeur par défaut pour displayNameEnabled est « 0 ».
1
Contenu de l'élément
Contient un ou plusieurs éléments de compte.
élément de compte
Nom du marqueur
compte
Description
Indique un compte à créer.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
identifiant
Y
Il s’agit du numéro d’identifiant de système interne pour le compte.
16
code
N
Le code du compte, les caractères alphanumériques et les tirets bas uniquement. Ne doit pas fournir un attribut de code pour les groupes de comptes.
Cur_Assets
nom
Y
Le nom du compte, tel qu’il apparaît sur les rapports et les feuilles.
Actifs à court terme
shortName
N
Le nom abrégé du compte.
CA
description
N
Description textuelle du compte. Le nombre maximum de caractères est 2 048.
Total des actifs courants
subType
N
Indique si le compte est PRIVÉ ou CUMULÉ. Si un compte est périodique, sa valeur dans un mois donné est égale à l’activité nette du mois. Les exemples incluent les comptes de produits et de charges. Si un compte est cumulatif, sa valeur est égale au solde de clôture d’un mois donné. Il s’agit de la valeur du mois précédent plus ou moins toute activité au cours du mois donné. Les comptes de bilan sont cumulatifs. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.
Lecture seule, identifié en fonction de son compte parent.
Cumulé
planBy
N
Pour les comptes Cumulatif, indique si le compte est un plan par solde (BALANCE) ou un plan par delta (DELTA).
Par défaut : Delta.
Le remplacement de planBy en Deltata N’est pas autorisé lorsque le compte comporte des fractionnements dans des versions qui ne sont pas des chiffres réels.
S'applique uniquement aux comptes de feuille. L'erreur UpdateAccounts s'affiche lorsque l'utilisateur tente de définir PlanBy pour un compte non feuille.
DELTA
actualsBy
N
Pour les comptes cumulés, indique si le compte est des chiffres réels par solde (BALANCE) ou des chiffres réels par delta (DELTA).
Par défaut : BALANCE.
S'applique uniquement aux comptes de feuille. L'erreur updateAccounts s'affiche lorsque l'utilisateur tente de définir actualsBy pour un compte non feuille.
BALANCE
enableActuals
N
0 pour afficher uniquement les données du plan pour le compte. 1 pour importer les chiffres réels dans le compte. Pour les comptes liés, la valeur 0 affichera les chiffres réels uniquement si le compte lié en contient, et la valeur 1 activera les chiffres réels pour le compte lié. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs. L'interface utilisateur de l'administrateur Planning GL utilise le terme « superposition des chiffres réels ».
La valeur par défaut est 0 lorsque le compte actuel est un groupe. Par défaut, la valeur est 1 lorsque le compte actuel est une feuille
1
balanceType
Mis à jour dans l'API v33
N
Indique le type de solde d’un compte : DÉbit ou crédit. balanceType est vide si aucun type de solde n'est associé au compte.
Seuls les comptes GL ont un type de solde.
Pour les API v32 et les versions antérieures, balanceType est une propriété en lecture seule identifiée sur son compte parent.
Pour l’API v33+, les comptes enfants peuvent utiliser un balanceType différent de celui de leurs comptes parents.
C DÉPENSE
timeStratum
N
Le code de la strate de temps du compte. Pour les comptes modélisés et cubes, ceci est hérité de la feuille propriétaire du compte.
Voir : Étapes : modifier les calendriers pour en savoir plus sur la structure temporelle et les codes de période temporelle.
Propriété en lecture seule sélectionnée dans la structure de temps, la feuille modélisée ou la feuille cube.
mois
displayAs
N
Le paramètre d’affichage de sortie du compte : NUMBER, DEVISE ou PERCENT. Fourni uniquement pour les comptes qui ont une propriété Afficher sous forme d’administration du compte.
Propriété en lecture seule pour les comptes GL.
NUMBER
decimalPrecision
N
Le nombre de décimales à afficher pour les numéros dans ce compte.
La valeur spéciale de 99 indique un compte lié qui hérite de la précision décimale de sa cible. La valeur -1 indique que le compte est un compte de devises et utilise la précision de la devise qu’il affiche.
Valeurs autorisées : -1, 0, 1-9, 99
La valeur par défaut est 0.
0
exchangeRateType
N
Présent uniquement pour les instances pour lesquelles l’option multidevise est activée et pour les comptes avec displayAs="curRENCY". Valeurs possibles : l’un des codes de type de taux de change présents dans l’instance, tels que configurés dans Gérer les devises. « A » = Moyenne mensuelle, « E » = Fin du mois.
Si cette valeur est manquante, utilisez A pour PÉRIODE et E pour CUMULÉ.
E
supprimeZéros
N
Indique si le compte autorise les utilisateurs à supprimer les zéros sur les feuilles. Si la valeur est 0, les utilisateurs ne peuvent pas supprimer les zéros. Si 1, les utilisateurs peuvent supprimer les zéros. Fourni uniquement pour les comptes pour lesquels la propriété Suppress on Sheets est activée dans l'administration des comptes.
Si manquant, la valeur par défaut est 1.
1
startdéveloppé
N
Indique si un compte et ses enfants démarrent avec un état développé lorsque la feuille est chargée pour la première fois. S’applique uniquement aux comptes parents.
1 pour Développé, 0 pour Réduit.
Si manquant, la valeur par défaut est 1.
1
dataEntryType
mis à jour dans l’API v29
N
Indique le type de saisie de données pour un compte feuille. STANDARD ou CUBE.
Si le parent dataEntryType est CUBE, un nouveau compte sera par défaut dataEntryType CUBE. Sinon, les nouveaux comptes sont définis par défaut sur dataEntryType Standard.
Les changements dataEntryType apportés aux comptes non feuilles sont ignorés. Le système calcule automatiquement la nouvelle valeur dataEntryType pour tous les comptes non feuilles.
L'API v29 et les versions plus récentes prennent en charge l'ajout de nouveaux comptes avec dataEntryType=CUBE.
STANDARD
hasSalaryDetail
N
Indique si ce compte comporte des fractionnements qui nécessitent l'autorisation Accès au détail du salaire pour être affichés. Vide si ne s'applique pas à ce compte.
hasSalaryDetail=1 n’est pas autorisé pour un groupe de comptes/un compte non feuille.
Pour rendre hasSalaryDetail=1 :
  • dataEntryType doit être STANDARD
  • accountType doit être GL
Les erreurs sont survenues lorsque dataEntryType est NOT STANDARD.
Les erreurs sont survenues lorsque dataEntryType=1 pour les comptes non feuilles.
Erreurs corrigées pour les comptes autres que GL et personnalisés.
1
dataPrivacy
N
Indique à quel niveau les valeurs du compte sont publiques et référencables dans d’autres niveaux lors de l’écriture de formules. PRIVÉ indique que les valeurs du compte sont privées. Public_TOP indique que les valeurs du compte sont publiques uniquement au niveau supérieur, ou Public_ALL afin que les valeurs du compte soient publiques à tous les niveaux. Les hypothèses sont toujours publiques et n’ont pas de paramètre dataPrivacy.
Lorsqu’elle est manquante, la valeur par défaut est PRIVÉ.
Erreurs expirées pour le groupe de comptes et les comptes d'hypothèse.
PRIVÉ
isIntercompany
N
Indique si le compte est un compte intersociétés ou non.
Les modifications apportées à la propriété isIntercompany ne sont pas prises en charge.
0
propagateToDescendants
N
Indique la étendue des modifications du mappage d’attributs aux descendants.
Lorsqu’elle est manquante, la valeur par défaut est 0.
Sortie d’erreurs si vide ou contient une valeur autre que 1 ou 0.
Propriétés qui se répercutent dans les descendants :
  • subType
  • planBy
  • displayAs
  • actualsBy
  • decimalPrecision
  • exchangeRateType
  • accountTypeCode
1
Contenu de l'élément
Un élément d’attributs facultatif si vous souhaitez modifier un ou plusieurs attributs de compte associés au compte.
élément d'attribut
Nom du marqueur
attribut
Description
Indique un attribut à mettre à jour. Marque le compte avec l’attribut si le modèle comporte des attributs de compte.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
nom
Y
Le nom de l'attribut.
Des erreurs se sont écoulées si le nom n'existe pas déjà dans le système.
Les erreurs sont survenues si le nom existe, mais que l'attribut n'est pas un attribut de compte.
Des erreurs sont survenues si le nom de l'attribut est vide ou manquant.
Emplacement
valeur
mis à jour dans l’API v34
Y
La valeur d'attribut pour cet attribut.
Autorise soit une valeur vide pour supprimer la valeur actuelle, soit l’une des valeurs d’attributs de compte définies.
La valeur de l'attribut doit être compatible avec l'attribut affecté au compte.
Pour les API v32 et v33, cet attribut n’est significatif que lorsque le paramètre Nom d’affichage est désactivé pour l’instance.
Pour l’API v34 et les versions plus récentes :
  • Pris en charge lorsque le paramètre Nom d'affichage en vigueur est ACTIVÉ.
  • La présence de valueCode et de valueName générera une erreur.
  • Lorsque l’importation de compte crée automatiquement des valeurs d’attributs est activée, la chaîne de valeur devient le code et le nom si la valeur n’existe pas déjà.
Définissez value="" pour supprimer le marquage de cet attribut.
170
valueCode
Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d’affichage.
Non pris en charge dans l'API v34.
Y
Le code unique de la valeur de l'attribut.
L’entrée valueCode n’est significative que lorsque DisplayNameEnabled=1 et que le paramètre Nom d’affichage est ACTIVÉ pour l’instance dans l’API v32 et l’API v33.
Codes de valeur d'attribut non autorisés :
  • this
  • noms se terminant par (+) ou (-)
  • nom d'attribut
  • tout/-tout/tout/tout-/-tout-
Définissez valueCodee="" pour supprimer le marquage de cet attribut.
SFO
valueName
Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d’affichage.
Non pris en charge dans l'API v34.
N
Le nom d'une valeur d'attribut nouvellement créée automatiquement.
L’attribut valueName est significatif uniquement quand :
  • valueCode contient une valeur d'attribut qui n'existe pas.
  • Le paramètre Nom d’affichage est ACTIVÉ pour l’instance.
  • displayNameEnabled=1
  • En appel d’API v32 et d’API v33.
valueName est ignoré lorsque valueCode contient une valeur d'attribut existante.
San Francisco
Contenu de l'élément
(aucun)

Traitement des données utiles de haut en bas

Les attributs de compte regroupent les valeurs et marquent les comptes de manière logique. Étant donné que l’API updateAccounts traite les données utiles XML de haut en bas, affectez l’attribut de compte pour un compte parent avant de changer les attributs du compte enfant. Les comptes enfants peuvent être marqués avec n’importe quelle valeur d’attribut lorsque la valeur de l’attribut du compte parent est vide. Si les attributs de compte enfant ne sont pas alignés avec l’attribut parent, une erreur de validation de comptabilité se produit.
Tenez compte de la structure arborescente ci-dessous où le parent «  Ligne de produit » a deux comptes enfants « A » et « B-Ste ». Les comptes "A" et "B-Ste" sont apparentés.
Product Line
|__A __A |__B-Ste __B-Ste |__B1 __Product B-1 |__B2 __Product B-2 |__B3 __Product B-3

Exemple d’un fichier XML de demande initial avec attributs de compte

Notez que la valeur d’attribut de compte "A" est affectée à la fois à "Autres comptes" et à "Swiss Bank".
<accounts> <account id="60" code="70140" name="Other Accounts"> <attribute name="Product Line" value="A" /> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="A" /> </account> </account> </accounts>

Exemple d’ordre incorrect pour le traitement des données utiles

Les données utiles XML ci-dessous génèrent une erreur, "
The attribute value B-1 is not compatible with the parent's attribute value
". Le traitement de la charge utile de haut en bas considère que le parent « Autres comptes » a la valeur « A » du bloc de code précédent et traite « B-1 » comme l’enfant de « A ». L'erreur est générée parce que l'enfant "Swiss Bank" ne peut avoir que les valeurs d'attribut "A" ou "B-Ste" comme indiqué dans l'arborescence.
<accounts> <account id="60" code="70140" name="Other Accounts"> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="B-1" /> </account> <attribute name="Product Line" value="B-Ste" /> <!-- Account Attribute change ignored due to placement order--> </account> </accounts>

Exemple d’ordre valide pour le traitement des données utiles

Le fait de réorganiser l’ordre de positionnement de « B-Ste » sous « Autres comptes » permet à l’API de traiter d’abord l’attribut de compte parent « B-Ste », ce qui permet à « Swiss Bank » d’avoir les valeurs de « B-Ste » ou de l’un de ses enfants.
<accounts> <account id="60" code="70140" name="Other Accounts"> <attribute name="Product Line" value="B-Ste" /> <!-- Account Attribute change processed due to correct placement order--> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="B-1" /> </account> </account> </accounts>

Format de réponse

<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <messages> <message type="INFO">Accounts were saved successfully.</message> </messages> <output> <accounts> <account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets"displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="true" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true"> <account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="true" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true"> </account> </accounts> </output> </response>
élément de sortie
Nom du marqueur
sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un seul élément de compte obligatoire. Ce filtre de sortie est standard sur toutes les réponses d’API et enveloppe la sortie valide de tout appel d’API réussi.
élément des comptes
Nom du marqueur
comptes
Description
Conteneur pour un ou plusieurs éléments de compte.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
Contenu de l'élément
Un ou plusieurs éléments de compte.
élément de compte
Nom du marqueur
compte
Description
Représente un compte unique retourné en réponse à un appel de l’API updateAccounts. Si cet élément est directement inclus dans l’élément des comptes inclus de la réponse (c’est-à-dire qu’il n’est pas inclus dans un autre élément de compte), cet élément de compte représente un compte racine (un compte qui n’a pas de parent).
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
identifiant
Y
Il s’agit du numéro d’identifiant de système interne pour le compte. Cela peut être utilisé pour désigner des comptes dans d’autres appels d’API, tels que exportDimensionFamis.
16
code
Y
Le code du compte, tel qu’il apparaît lorsqu’il est référencé dans des formules.
Cur_Assets
nom
Y
Le nom du compte, tel qu’il apparaît sur les rapports et les feuilles.
Actifs à court terme
accountTypeCode
N
Code de lettre correspondant au type de données de ce compte
Code de type
Type de compte
Classe du compte
A
Actif
GL
B
Actif à court terme
GL
C
Passif et capitaux propres
GL
CUBE
Cube
Cube
EN
Perte/revenus depuis le début de l'exercice
GL
F
Actif immobilisé
GL
G
Coût des produits vendus
GL
I
Produits
GL
J
Produits hors exploitation
GL
K
Écart de conversion cumulé
Système
L
Passif
GL
M
Passif à court terme
GL
MI
Pourcentages de consolidation
Prédéfinis
MT
Indicateur
Indicateur
N
Résultat net
GL
O
Autre actif
GL
Q
Capitaux propres
GL
R
Actif à long terme
GL
S
Hypothèse
Hypothèse
T
Passif à long terme
GL
W
Modélisé
Modélisé
X
Charges
GL
XR
Taux de change
Prédéfinis
Y
Charges hors exploitation
GL
Z
Personnalisé
Personnalisé
description
N
Description textuelle du compte, le cas échéant, telle qu’elle est entrée dans l’administration du compte
Total des actifs courants
shortName
N
Nom abrégé du compte, le cas échéant, tel qu’il est entré dans l’administration du compte
CA
timeStratum
N
Le code de la strate de temps du compte. Pour les comptes modélisés et cubes, ceci est hérité de la feuille propriétaire du compte.
Mois
displayAs
N
Le paramètre d’affichage de sortie du compte : NUMBER, DEVISE ou PERCENT. Fourni uniquement pour les comptes qui ont une propriété Afficher sous forme d’administration du compte.
NUMBER
isAssumption
N
"0" ou "1" indiquant si le compte est une hypothèse. Ceci est défini à 1 pour les hypothèses et les comptes de taux de change.
1
supprimeZéros
N
Indique si le compte autorise les utilisateurs à supprimer les zéros sur les feuilles. Si la valeur est 0, les utilisateurs ne peuvent pas supprimer les zéros. Si 1, les utilisateurs peuvent supprimer les zéros. Fourni uniquement pour les comptes pour lesquels la propriété Suppress on Sheets est activée dans l'administration des comptes.
1
isDefaultRoot
N
"0" ou "1" indiquant si le compte ou le groupe de comptes est une racine par défaut.
1
decimalPrecision
N
Nombre de décimales à afficher pour les nombres dans ce compte.
La valeur spéciale de 99 indique un compte lié qui hérite de la précision décimale de sa cible. La valeur -1 indique que le compte est un compte de devises et utilise la précision de la devise qu’il affiche.
Valeurs autorisées : -1, 0, 1-9, 99
La valeur par défaut est 0.
0
planBy
N
Pour les comptes Cumulatif, indique si le compte est un plan par solde (BALANCE) ou un plan par delta (DELTA).
BALANCE
exchangeRateType
N
Présent uniquement pour les comptes avec la valeur de primeAs="CUERENCY". Valeurs possibles : l’un des codes de type de taux de change présents dans l’instance, tels que configurés dans Gérer les devises. « A » = Moyenne mensuelle, « E » = Fin du mois.
E
balanceType
N
Indique le type de solde d’un compte, Débit ou Crédit. Cet attribut est vide si aucun type de solde n'est associé au compte. Seuls les comptes GL ont un type de solde.
DÉBIT
dataEntryType
mis à jour dans l’API v29
N
Indique le type de saisie de données pour le compte. STANDARD ou CUBE. Une valeur vide indique que le type de saisie de données ne s'applique pas au compte.
Le système calcule automatiquement la nouvelle valeur dataEntryType pour tous les comptes non feuilles.
Pour l’API v29 et plus :
  • Les comptes non feuilles contiennent toujours une chaîne vide.
  • Les comptes feuilles sont toujours remplis avec une valeur dataEntryType de Standard ou de CUBE.
STANDARD
timeRollUp
N
Indique le comportement du compte lors d’un regroupement sur une période donnée. Peut être SUM, WEafficher_AVERAGE, LAST ou AVERAGE. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.
SUM
timeWeightAcctId
N
Si la valeur de timeRollup de ce compte est WE Active_AVERAGE, il s’agira du numéro d’identifiant de système interne du compte à partir duquel les pondérations seront déterminées. Ce champ sera vide s'il n'existe aucun compte de pondération ou si le compte n'a pas un timeRollup de WEighted_AVERAGE.
133
hasSalaryDetail
N
Indique si ce compte comporte des fractionnements qui nécessitent l'autorisation Accès au détail du salaire pour être affichés. Vide si ne s'applique pas à ce compte.
1
dataPrivacy
N
Indique à quel niveau les valeurs du compte sont publiques et référencables dans d’autres niveaux lors de l’écriture de formules. PRIVÉ indique que les valeurs du compte sont privées. Public_TOP indique que les valeurs du compte sont publiques uniquement au niveau supérieur, ou Public_ALL afin que les valeurs du compte soient publiques à tous les niveaux. Les hypothèses sont toujours publiques et n’ont pas de paramètre dataPrivacy.
PRIVÉ
subType
N
Indique si le compte est PRIVÉ ou CUMULÉ. Si un compte est périodique, sa valeur dans une période temporelle donnée est égale à l’activité nette pour la période temporelle. Les exemples incluent les comptes de produits et de charges. Si un compte est cumulatif, sa valeur est égale au solde de clôture pour une période temporelle donnée. Il s’agit de la valeur de la période antérieure plus ou moins toute activité dans la période temporelle donnée. Les comptes de bilan sont cumulatifs. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.
PÉRIUDIQUE
startdéveloppé
N
Cela indique si un compte et ses enfants démarrent avec un état développé lors du premier chargement d’une feuille. Cela s’applique uniquement aux comptes parents. Ce champ sera vide pour les comptes feuilles.
1
isBreakbackEligible
N
0 ou 1 pour indiquer si ce compte peut être utilisé dans une répartition. Cela s’applique uniquement aux hypothèses standard. Ce sera vide pour d'autres types de comptes.
0
levelDimRollup
N
Indique le comportement du compte lorsqu'il est regroupé selon un niveau ou une dimension. Peut être SUM, WEafficher_AVERAGE, TEXT ou NOTB Planning_AVERAGE. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.
NONBLANK_AVERAGE
levelDimWeightAcctId
N
Si ce compte a un niveau LevelDimRollup de WE Active_AVERAGE, il s'agira du numéro d'identifiant de système interne du compte à partir duquel les pondérations seront déterminées. Ce champ sera vide s'il n'existe aucun compte de pondération ou si la valeur LevelDimRollup du compte n'est pas WE Active_AVERAGE.
118
rollupText
N
Si ce compte a un LevelDimRollup de TEXT, c’est la chaîne de texte qui s’affichera dans la cellule indiquant la valeur agrégée du compte.
Aucun
enableActuals
N
0 pour afficher uniquement les données du plan pour le compte. 1 pour importer les chiffres réels dans le compte. Pour les comptes liés, la valeur 0 affichera les chiffres réels uniquement si le compte lié en contient, et la valeur 1 activera les chiffres réels pour le compte lié. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.
1
isGroup
Y
0 ou 1 pour indiquer s’il s’agit d’un groupe de comptes ou non.
1
isContra
Disponible dans l'API v34+
N
0 ou 1 pour indiquer s’il s’agit d’un compte de contrepartie.
1
isIntercompany
N
0 ou 1 pour indiquer si ce compte est un compte intersociétés ou non.
1
isLinked
N
0 ou 1 pour indiquer si ce compte est un compte lié ou non.
1
isSystem
N
0 ou 1 pour indiquer si ce compte est un compte système ou non.
1
statut
Y
Le statut du compte suivant la mise à jour. Pour les avertissements et les erreurs, l’élément de message contient le contenu du message. Le statut Mis à jour ne renvoie aucun contenu de message.
  • Erreur : une erreur a été repérée dans l'entité
  • Avertissement : un avertissement a été repéré dans l'entité
  • Créé : l'entité a été créée avec succès
  • Mis à jour : l'entité a été mise à jour
Mis à jour
message
N
Le message d’erreur pour les données entrantes du compte.
Le compte ModAccount33 est en double dans les données utiles ou existe déjà dans le système avec l’identifiant 8
Contenu de l'élément
Un élément de compte imbriqué pour chaque compte enfant direct de ce compte. Un élément d'attributs si le compte est associé à un ou plusieurs attributs.
élément d'attribut
Nom du marqueur
attribut
Description
Indique le marquage d'attributs pour le compte.
Attributs de l'élément
Nom de l’attribut
Obligatoire?
Valeur
Exemple
nom
Y
Le nom de l'attribut de compte
Type d'études
valeur
mis à jour dans l’API v34
Y
La valeur de l'attribut de compte.
Pour les API v32 et API v33, cet attribut n’a de sens que lorsque le paramètre Nom d’affichage est désactivé pour l’instance.
Tech1
valueCode
Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d’affichage.
Y
Le code unique de la valeur de l'attribut.
Pour les API v32 et API v33, valueCode n’a de sens que lorsque :
  • Le paramètre Nom d’affichage est ACTIVÉ pour l’instance.
  • displayNameEnabled=1
valueName
Disponible uniquement dans API v32 et API v33 pour les instances qui activent le nom d’affichage.
N
Le nom d'une valeur d'attribut nouvellement créée automatiquement.
L’attribut valueName est significatif uniquement quand :
  • valueCode contient une valeur d'attribut qui n'existe pas.
  • Le paramètre Nom d’affichage est ACTIVÉ pour l’instance.
  • displayNameEnabled=1value
  • Appelant les API v32 et v33.
Le nom est ignoré lorsque valueCode contient une valeur d'attribut existante.
statut
Y
Le statut de l’attribut suivant est mis à jour. Pour les avertissements et les erreurs, l’élément de message contient le contenu du message. Le statut Mis à jour ne renvoie aucun contenu de message.
  • Erreur : une erreur a été repérée dans l'entité
  • Avertissement : un avertissement a été repéré dans l'entité
  • Créé : le compte a été marqué avec un attribut avec succès pour la première fois.
  • Mis à jour : le marqueur d'attribut de compte a été mis à jour
mis à jour
message
N
Le message d'erreur pour une entrée d'attribut non valide.
Contenu de l'élément
(aucun)