updateAccounts

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 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 données utiles volumineuses, vous pouvez publier des fichiers XML compressés (zip). Découvrez comment ici.

Les conditions suivantes s'appliquent à updateAccounts :

Les comptes sont identifiés pour mise à jour via leur numéro d'identifiant interne.

Pour créer de nouveaux comptes, attribuez-leur une propriété Identifiant vide ou manquante.

Vous pouvez déplacer un élément existant (non nouveau) afin qu'il devienne un enfant d'un nouvel élément. Ainsi, le nouvel élément est créé et l'élément existant est transféré sous ce dernier en tant qu'enfant.

Pour API v31 et supérieure, vous pouvez créer un compte parent entre un compte parent existant et ses comptes enfants.

Redéfinir le parent de comptes

updateAccounts

d'une erreur si la valeur d'attribut d'un enfant n'est pas compatible avec le nouvel attribut du parent. Exemple : l'attribut reparentedAccount1 a une valeur de reporting SEC = Non et n'est pas compatible car newParentAccount2 SEC Reporting value=Oui.

updateAccounts

corrige les valeurs d'attribut non compatibles pour qu'elles correspondent à leur nouveau parent lors de la redéfinition du parent lorsque

proceedWithWarnings=1.

Les comptes de redéfinition ne peuvent pas former une relation cyclique.

Le redéfinition du parent n'est pas autorisée 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 compte parent entre un compte parent existant et ses comptes enfants :

Compte source	Passé en dessous	API v30 et antérieures	API v31 et supérieure
racine	racine	bloqué	bloqué
racine	parent	bloqué	bloqué
racine	feuille	bloqué	bloqué
parent	racine	autorisé	autorisé
parent	parent	autorisé	autorisé
parent	une feuille existante comme premier enfant	bloqué	bloqué
parent	une feuille existante comme premier enfant	autorisé	autorisé
parent	un nouveau premier compte qui est un enfant d'un parent existant	bloqué	autorisé
parent	un nouveau compte non premier 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	bloqué	bloqué
feuille	une feuille existante comme premier enfant	autorisé	autorisé
feuille	un nouveau premier compte qui est un enfant d'un parent existant	bloqué	autorisé
feuille	un nouveau compte non premier qui est un enfant d'un parent existant	autorisé	autorisé
feuille	un nouveau premier compte qui est un enfant d'une feuille existante	bloqué	bloqué
feuille	un nouveau compte non premier qui est un enfant d'une feuille existante	autorisé	autorisé

Enfants du compte feuille

Le premier enfant d'un compte feuille ne peut être qu'un nouveau compte. Un compte GL existant ne peut pas être déplacé sous un compte feuille existant.

Lorsqu'un compte devient son premier enfant lors de la redéfinition du parent, le mappage de comptes dans Intégration > Importer des mappages de comptes est supprimé.

Lorsque vous redéfinissez le parent de comptes :

balanceType

et

subType

Les propriétés sont héritées de leur compte GL parent.

Comptes cubes et données cubes de saisie

Les comptes cubes de saisie peuvent être redéfinis comme parent.

Seuls les comptes sans données cubes de saisie dans leurs sous-arbres source et cible peuvent être redéfinis.

Les comptes CUBE/MIS Comme vous ne pouvez pas redéfinir leur parent.

Les nouveaux comptes sous un COMPTE CUBE ne sont pas autorisés. Les nouveaux comptes sous un COMPTE STANDARD/ Dot, c'est autorisé.

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

Pour créer un nouveau compte, incluez son parent avec son identifiant. Par exemple, pour ajouter un nouveau compte enfant sous le signe L

ocalAssets

compte avec

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 niveau du compte

id 1441

. Elle crée un nouvel enfant nommé

new Local Assets

pour

id 1441

. Tous les enfants non mentionnés de

LocalAssets

déplacer en fin de liste enfant. C'est l'équivalent de "définir le parent" pour le nouveau compte.

Gestion de plusieurs changements de nom dans un seul appel updateAccounts

Plusieurs changements de nom de la même entité peuvent avoir lieu dans un système distant entre

updateAccounts

des appels. Les noms des entités sur le système distant peuvent être remplacés par ceux des mêmes identifiants d'entité. Période

updateAccounts

Les appels ont lieu après l'échange de noms, les

updateAccounts

L'appel gère ces modifications en effectuant le suivi des identifiants dans les changements de nom. L'appel peut également gérer l'introduction d'un nouvel identifiant qui utilise un nom existant.

Pour garantir la réussite de chacun des exemples, l'échange complet des identifiants doit avoir lieu avec les valeurs uniques.

Exemple 1 : un échange de noms simple dans le système distant.


ID     Unique Value   New Unique Value
1      AA             BB
2      BB             AA

Exemple 2 : une séquence de 3 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 identifiants
Nom du marqueur		identifiants
Description		Tous les appels d'API doivent contenir un seul élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
se connecter	O	Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode.	sampleuser@company.com
mot de passe	O	Mot de passe de l'utilisateur appelant la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les chiffres et les dates entrants, et pour formater les chiffres et les dates sortants (en utilisant le séparateur des milliers, les noms de mois et la mise en forme de date appropriés). Les paramètres régionaux sont également utilisés pour indiquer la langue dans laquelle doivent s'afficher les messages système figurant dans la réponse. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l'utilisateur indiqué dans les identifiants a accès à plusieurs instances Adaptive Planning, cet attribut peut être utilisé pour indiquer qu'il a l'intention d'accéder à une instance différente de son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur sera utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

élément Comptes
Nom du marqueur		comptes
Description		Une seule demande d'élément de compte est autorisée par chargement de la paie. Il contient un ou plusieurs éléments de compte.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
proceedWithWarnings	N	proceedWithWarnings="1" indique que l'API updateAccounts doit ajuster l'attribut et les propriétés du compte en fonction des modifications de redéfinition du parent. proceedWithWarnings="0" indique que l'API updateAccounts ne doit pas ajuster l'attribut et les propriétés du compte en fonction des modifications de redéfinition du parent. Les erreurs UpdateAccounts sortent avec un message indiquant le motif d'échec. Par exemple, le mappage de l'attribut ne sera plus valide après le reclassement du parent. Les valeurs par défaut sont 0 si manquantes.	1
retenueExistingOrder Disponible dans API v26 et supérieure	N	confidenceExistingOrder="1" indique que l'API updateAccounts doit ignorer l'ordre des éléments dans la charge de données XML et que l'ordre défini existant sera conservé. Rapport de mise à jour de la paie ExistingOrder="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 frères/sœurs dans la charge de travail XML. L'attribut retainExistingOrder est ignoré dans les versions d'API antérieures à API v26. La valeur par défaut de retainExistingOrder est "0" pour v26. Pour les versions v27 et ultérieures des API, la valeur par défaut de retainExistingOrder est "1".	1
displayNameEnabled Uniquement disponible dans API v32 et supérieure 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 API pré-v32, 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		account
Description		Indique un compte à créer.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	L'identifiant système interne du compte.	16
code	N	Le code du compte, caractères alphanumériques et tirets bas uniquement. Ne doit pas indiquer d'attribut de code pour les groupes de comptes.	Cur_Assets
nom	O	Le nom du compte, tel qu'il apparaît sur les rapports et les feuilles.	Actifs circulants
shortName	N	Le nom abrégé du compte.	CA
description	N	Description textuelle du compte. Le nombre maximum de caractères est 2048.	Total des actifs circulants
subType	N	Indique si le compte est Périodique ou CUMULÉ. Si un compte est périodique, sa valeur dans un mois donné est égale à l'activité nette pour le mois. Exemples : comptes de produits et de charges. Si un compte est cumulé, 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é du mois donné. Les comptes de bilan sont des comptes cumulés. Cette option sera vide pour les groupes de comptes et les comptes métriques. En lecture seule, identifié en fonction de son compte parent.	Cumulé
planBy	N	Pour les comptes cumulés, indique si le compte est plan par solde ( Solde) ou plan par delta (DELTA). Par défaut, la valeur Delta est activée. Le remplacement du paramètre planBy par Delta n'est PAS autorisé lorsque le compte comporte des subdivisions dans des versions qui ne sont pas des montants réels. Uniquement applicable pour les comptes feuilles. updateAccounts génère une erreur 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 Montants réels par solde ( lancer du solde) ou montants réels par delta (DELTA). La valeur par défaut est Solde. Uniquement applicable pour les comptes feuilles. updateAccounts génère une erreur lorsque l'utilisateur tente de définir des valeurs 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 montants réels dans le compte. Pour les comptes liés, 0 affichera les montants réels uniquement si le compte lié en contient et 1 les permettra d'activer les montants réels pour le compte lié. Cette option sera vide pour les groupes de comptes et les comptes métriques. L'interface utilisateur de l'administrateur Planning Utiliser le terme " superposition des montants réels ". Par défaut, est 0 lorsque le compte actuel est un groupe. Par défaut, la valeur 1 est utilisée par défaut 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 antérieures, balanceType est une propriété en lecture seule identifiée sur son compte parent. Pour les API v33 et supérieure, les comptes enfants peuvent utiliser un type de solde différent de celui de leurs comptes parents.	CRÉDIT
timeStratum	N	Code de la strate de temps du compte. Pour les comptes modèles et cubes, cette option est héritée de la feuille propriétaire du compte. Voir Étapes : modifier les calendriers pour plus d'informations sur la structure des temps et les codes de période. Propriété en lecture seule sélectionnée dans une feuille de structure des temps, modèle ou cube.	month
displayAs	N	Le paramètre d'affichage de la sortie du compte : NUMBRE, DEVISE ou POURCENTAGE. Fournit uniquement pour les comptes disposant d'une propriété Afficher sous forme de dans Administration des comptes. Propriété en lecture seule pour les comptes GL.	NUMBER
decimalPrecision	N	Nombre de décimales à afficher pour les nombres de ce compte. La valeur spéciale 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 en devise 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 dont la fonction multidevise est activée et pour les comptes avec displayAs="CURRENCY". Valeurs possibles : n'importe quel code de type de taux de change présent dans l'instance, tel que configuré dans Gérer les devises. "A" = Moyenne mensuelle, "E" = Fin du mois. Si la colonne est manquante, utilisez A pour PÉRIODIQUE et E pour CUMULÉ.	E
supprimer les zéros	N	Indique si le compte permet aux utilisateurs de supprimer les zéros dans les feuilles. Les utilisateurs Si 0 ne peuvent pas supprimer les zéros. Les utilisateurs Si 1 peuvent supprimer les zéros. Fournit uniquement pour les comptes dont la propriété "Supprimer sur les feuilles" a été activée dans l'administration des Comptes. Si manquant, la valeur par défaut est 1.	1
startExpanded	N	Indique si un compte et ses enfants commencent dans 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 des données pour un compte feuille. STANDARD ou CUBE. Si le type d'écriture parent est CUBE, tout nouveau compte a pour valeur par défaut dataEntryType CUBE. Dans tous les autres cas, les nouveaux comptes ont par défaut la valeur dataEntryType STANDARD. Les changements dataEntryType des comptes non feuilles sont ignorés. Le système calcule automatiquement le new dataEntryType pour tous les comptes non feuilles. L'API v29 et les versions ultérieures prennent en charge l'ajout de nouveaux comptes avec dataEntryType=CUBE.	STANDARD
hasSalaryDetail	N	Indique si ce compte contient des subdivisions qui nécessitent l'autorisation Accès au détail des salaires pour affichage. Vide si non applicable à ce compte. hasSalaryDetail=1 n'est pas autorisé pour les comptes de groupe de comptes/non-feuille. Pour faire hasSalaryDetail=1 : dataEntryType doit être STANDARD accountType doit être GL Des erreurs s'affichent lorsque dataEntryType n'est PAS STANDARD. Une erreur s'affiche lorsque dataEntryType=1 pour les comptes non feuilles. Erreur pour les comptes non-GL et personnalisés.	1
dataPrivacy	N	Indique les périmètres dans lesquels les valeurs du compte sont publiques et utilisées comme références dans d'autres périmètres 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 au niveau supérieur uniquement, ou PUBLIC_ALL pour que les valeurs du compte soient publiques à tous les niveaux. Les hypothèses sont toujours publiques et ne sont pas associées à un paramètre dataPrivacy. Lorsque cette option est manquante, la valeur par défaut est PRIVÉ. Les erreurs s'affichent pour les comptes de groupe de comptes et d'hypothèses.	PRIVÉ
isIntercompany	N	Indique si le compte est un compte intercompagnies ou pas. Les modifications apportées à la propriété isIntercompany ne sont pas prises en charge.	0
propagateToDescendants	N	Indique la propagation des modifications du mappage d'attributs aux descendants. Lorsque cette option est manquante, la valeur par défaut est 0. Une erreur s'affiche si vide ou contient une valeur autre que 1 ou 0. Les propriétés qui se propagent aux descendants : subType planBy displayAs actualsBy decimalPrecision exchangeRateType accountTypeCode	1
Contenu de l'élément
Un élément d'attribut facultatif si vous souhaitez modifier un ou plusieurs attributs de compte associés au compte.

élément d'attribut
Nom du marqueur		attribut
Description		Spécifie un attribut à mettre à jour. Marque le compte avec l'attribut si le modèle a des attributs de compte.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Le nom de l'attribut. Les erreurs s'affichent si le nom n'existe pas déjà dans le système. Les erreurs s'affichent si le nom existe mais que l'attribut n'est pas un attribut de compte. Les erreurs s'affichent si le nom de l'attribut est vide ou manquant.	Location
valeur mis à jour dans l'API v34	O	Valeur d'attribut de cet attribut. Permet au choix d'une valeur vide de supprimer la valeur actuelle ou de n'importe quelle valeur d'attribut de compte définie. La valeur de l'attribut doit être compatible avec l'attribut affecté au compte. Pour les API v32 et v33, cet attribut n'a de sens que lorsque le paramètre Nom d'affichage est désactivé pour l'instance. Pour l'API v34 et les versions ultérieures : Prise en charge lorsque le paramètre Nom d'affichage d'effet est activé. La présence de valueCode et valueName va s'afficher. Lorsque l'option L'importation de comptes crée automatiquement des valeurs d'attribut 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 retirer 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.	O	Le code unique de la valeur de l'attribut. L'entrée valueCode est explicite uniquement lorsque displayNameEnabled=1 et que le paramètre Nom d'affichage est activé pour l'instance dans API v32 et API v33. Codes illégaux de valeurs d'attribut : this les noms se terminant par (+) ou (-) nom d'attribut n'importe quel/-aucun/aucun-aucun---------- Définissez valueCode ="" pour retirer 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 n'a de sens que dans les cas suivants : valueCode contient une valeur d'attribut non existante. Le paramètre Nom d'affichage est activé pour l'instance. displayNameEnabled=1 Appelez l'API v32 et l'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 logiquement des valeurs et marquent des comptes. Comme l'API updateAccounts traite les données utiles XML de haut en bas, affectez l'attribut de compte d'un compte parent avant de modifier les attributs de 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 s'alignent pas sur l'attribut parent, une erreur de validation de compatibilité se produit.

Examinez la structure d'arbre ci-dessous où le parent "Ligne de produit" a deux comptes enfants "A" et "B-Ste". Les comptes "A" et "B-Ste" sont des frères/sœurs.


Product Line|__A        __A                                
|__B-Ste    __B-Ste
  |__B1      __Product B-1
  |__B2      __Product B-2
  |__B3      __Product B-3

Exemple de fichier XML d'origine de la demande avec des attributs de compte

Notez que la valeur d'attribut de compte "A" est affectée à la fois à "Autres comptes" et à "Banque suisse".


<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 paie de haut en bas considère que le parent "Autres comptes" contient la valeur "A" du bloc de code précédent et traite "B-1" comme enfant de "A". L'erreur est générée car l'enfant "Banque suisse" ne peut avoir que les valeurs d'attribut "A" ou "B-Ste" telles qu'indiquées 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

Réorganiser l'ordre de positionnement de "B-Ste" sous "Autres comptes" permet à l'API de traiter l'attribut de compte parent "B-Ste" en premier, ce qui permet à "Bonne de banque" d'avoir des valeurs "B-Ste" ou 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 la 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 comptes obligatoire. Ce filtre de sortie est standard sur toutes les réponses d'API et contient la sortie valide de tout appel d'API réussi.

élément 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		account
Description		Représente un seul compte renvoyé en réponse à un appel d'API updateAccounts. Si cet élément se trouve directement dans l'élément comptes inclus de la réponse (c'est-à-dire s'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
id	O	L'identifiant système interne du compte. Elle peut être utilisée pour identifier des comptes dans d'autres appels d'API, tels que exportDimensionFacultations.			16
code	O	Le code du compte, tel qu'il apparaît lorsqu'il est référencé dans les formules.			Cur_Assets
nom	O	Le nom du compte, tel qu'il apparaît sur les rapports et les feuilles.			Actifs circulants
accountTypeCode	N	Le code de lettre correspondant au type de données de ce compte
		Code de type	Type de compte	Classe de compte
		A	Actif	GL
		B	Actif circulant	GL
		C	Passif et capitaux propres	GL
		CUBE	Cube	Cube
		EN	Cumul annuel du résultat	GL
		F	Actif immobilisé	GL
		G	Coût des produits vendus	GL
		I	Résultat	GL
		J	Résultat hors exploitation	GL
		K	Écarts de conversion cumulés	Système
		L	Passif	GL
		M	Passif circulant	GL
		MI	Pourcentages de consolidation	Prédéfinis
		MT	Métrique	Métrique
		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èle	Modèle
		X	Charges	GL
		XR	Taux de change	Prédéfinis
		O	Charges hors exploitation	GL
		Z	Personnalisé	Personnalisé
description	N	La description textuelle du compte, le cas échéant, telle que saisie dans Administration des comptes			Total des actifs circulants
shortName	N	Le nom abrégé du compte, le cas échéant, tel que saisi dans Administration des comptes			CA
timeStratum	N	Code de la strate de temps du compte. Pour les comptes modèles et cubes, cette option est héritée de la feuille propriétaire du compte.			Mois
displayAs	N	Le paramètre d'affichage de la sortie du compte : NUMBRE, DEVISE ou POURCENTAGE. Fourni uniquement pour les comptes disposant d'une propriété Afficher sous forme de dans Administration des comptes.			NUMBER
isAssumption	N	"0" ou "1", indiquant si le compte est une hypothèse. Il est paramétré sur 1 pour les hypothèses et les comptes de taux de change.			1
supprimer les zéros	N	Indique si le compte permet aux utilisateurs de supprimer les zéros dans les feuilles. Les utilisateurs Si 0 ne peuvent pas supprimer les zéros. Les utilisateurs Si 1 peuvent supprimer les zéros. Fournit uniquement pour les comptes dont la propriété "Supprimer sur les feuilles" a été activée dans l'administration des Comptes.			1
isDefaultRoot	N	"0" ou "1" indique 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 de ce compte. La valeur spéciale 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 en devise 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 cumulés, indique si le compte est plan par solde ( Solde) ou plan par delta (DELTA).			BALANCE
exchangeRateType	N	Uniquement présent pour les comptes avec displayAs="CEURRENCY". Valeurs possibles : n'importe quel code de type de taux de change présent dans l'instance, tel que configuré 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 le compte n'est associé à aucun type de solde. Seuls les comptes GL ont un type de solde.			DÉBIT
dataEntryType mis à jour dans l'API v29	N	Indique le type de saisie des données pour le compte. STANDARD ou CUBE. Une valeur vide indique que le type de saisie de données n'est pas applicable pour le compte. Le système calcule automatiquement le new dataEntryType pour tous les comptes non feuilles. Pour API v29 et supérieure : Les comptes non feuilles contiennent toujours une chaîne vide. Les comptes feuilles sont toujours renseignés avec la valeur dataEntryType STANDARD ou CUBE.			STANDARD
timeRollUp	N	Indique comment le compte se comporte lorsqu'il est agrégé sur une période donnée. Peut être SUM, WeightED_AVERAGE, LAST ou AVERAGE. Cette option sera vide pour les groupes de comptes et les comptes métriques.			SOMME
timeWeightAcctId	N	Si ce compte a un agrégat de temps de type WeightED_AVERAGE, ce sera le numéro d'identifiant système interne du compte à partir duquel les pondérations sont déterminées. Ce champ sera vide s'il n'existe aucun compte de pondération ou si le compte n'a pas un agrégat de temps de WeightED_AVERAGE.			133
hasSalaryDetail	N	Indique si ce compte contient des subdivisions qui nécessitent l'autorisation Accès au détail des salaires pour affichage. Vide si non applicable à ce compte.			1
dataPrivacy	N	Indique les périmètres dans lesquels les valeurs du compte sont publiques et utilisées comme références dans d'autres périmètres 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 au niveau supérieur uniquement, ou PUBLIC_ALL pour que les valeurs du compte soient publiques à tous les niveaux. Les hypothèses sont toujours publiques et ne sont pas associées à un paramètre dataPrivacy.			PRIVÉ
subType	N	Indique si le compte est Périodique ou CUMULÉ. Si un compte est périodique, sa valeur dans une période donnée est égale à l'activité nette pour la période. Exemples : comptes de produits et de charges. Si un compte est cumulé, sa valeur est égale au solde de clôture d'une période donnée. Il s'agit de la valeur de la période précédente, plus ou moins toute activité dans la période donnée. Les comptes de bilan sont des comptes cumulés. Cette option sera vide pour les groupes de comptes et les comptes métriques.			PÉRIODIQUE
startExpanded	N	Indique si un compte et ses enfants commencent par un état développé lors du chargement d'une feuille pour la première fois. Cette règle s'applique uniquement aux comptes parents. Cette option sera vide pour les comptes feuilles.			1
isBreakbackEligible	N	0 ou 1 pour indiquer si ce compte peut être utilisé dans une répartition. Cette règle s'applique uniquement aux hypothèses standard. (cette option sera vide pour les autres types de compte).			0
levelDimRollup	N	Indique comment le compte se comporte lorsqu'il est agrégé le long d'un périmètre ou d'une dimension. Peuvent être SUM, WeightED_AVERAGE, TEXT ou NOBBANK_AVERAGE. Cette option sera vide pour les groupes de comptes et les comptes métriques.			NONBLANK_AVERAGE
levelDimWeightAcctId	N	Si ce compte a pour levelDimRollup WEightED_AVERAGE, ce sera le numéro d'identification système interne du compte à partir duquel les pondérations sont déterminées. Ce champ sera vide s'il n'existe aucun compte de pondération ou si le levelDimRollup du compte n'est pas WeightED_AVERAGE.			118
rollupText	N	Si ce compte a un levelDimRollup de TEXT, alors c'est la chaîne de texte qui s'affichera dans la cellule pour indiquer la valeur agrégée du compte.			Aucune
enableActuals	N	0 pour afficher uniquement les données du plan pour le compte. 1 pour importer les montants réels dans le compte. Pour les comptes liés, 0 affichera les montants réels uniquement si le compte lié en contient et 1 les permettra d'activer les montants réels pour le compte lié. Cette option sera vide pour les groupes de comptes et les comptes métriques.			1
isGroup	O	0 ou 1 pour indiquer s'il s'agit d'un groupe de comptes ou non.			1
isContra Disponible dans API v34 et supérieure	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 intercompagnies 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	O	Statut du compte après mise à jour. Pour les avertissements et les erreurs, l'élément de message contient le contenu du message. Le statut de mise à jour ne renvoie aucun contenu de message. Erreur : une erreur a été trouvée dans l'entité Avertissement : un avertissement a été trouvé dans l'entité Créé : l'entité a été créée avec succès Mis à jour : l'entité a été mise à jour avec succès			Mis à jour
message	N	Le message d'erreur pour la saisie 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'attribut si le compte est associé à un ou plusieurs attributs.

élément d'attribut
Nom du marqueur		attribut
Description		Indique le marquage de l'attribut pour le compte.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
nom	O	Le nom de l'attribut de compte	Type d'études
valeur mis à jour dans l'API v34	O	La valeur de l'attribut de compte. Pour 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.	O	Le code unique de la valeur de l'attribut. Pour 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 n'a de sens que dans les cas suivants : valueCode contient une valeur d'attribut non existante. Le paramètre Nom d'affichage est activé pour l'instance. displayNameEnabled=1value Appelez les API v32 et v33. Le nom est ignoré lorsque valueCode contient une valeur d'attribut existante.
statut	O	Le statut de l'attribut après mise à jour. Pour les avertissements et les erreurs, l'élément de message contient le contenu du message. Le statut de mise à jour ne renvoie aucun contenu de message. Erreur : une erreur a été trouvée dans l'entité Avertissement : un avertissement a été trouvé dans l'entité Créé : le compte a été marqué pour la première fois avec un attribut. Mis à jour : le marqueur de l'attribut de compte a bien été mis à jour	mis à jour
message	N	Message d'erreur pour une saisie d'attribut non valide.
Contenu de l'élément
(aucun)

Catégorie	Modification des métadonnées
Description	Mettez à jour un ensemble de comptes GL existants ou créez de nouveaux comptes. Plusieurs comptes avec plusieurs valeurs peuvent être mis à jour en un seul appel. Si l'opération s'effectue avec succès, l'API renvoie le détail des comptes qui ont été mis à jour/créés. Si l'API échoue, une liste complète des erreurs et de leurs causes s'affiche.
Autorisations requises pour appeler	Modèle et autorisations à chaque périmètre
Paramètres obligatoires à la demande	Identifiants