updateAccount

Adaptive Planning

updateAccount

Catégorie	Modification de métadonnées
Description	Mettez à jour un compte existant dans le système. Cette API renvoie un message d’erreur lorsque la validation ou la mise à jour échoue, ou elle renvoie les métadonnées du compte mis à jour en cas de succès. Cette API prend uniquement en charge les types de comptes suivants : Hypothèse, Compte GL et Compte personnalisé. Il ne prend pas en charge les comptes système ou les comptes liés.
Autorisations obligatoires pour pouvoir être appelées	Modèle pour compte GL et personnalisé. Hypothèses pour les hypothèses.
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 disposer de l'autorisation Modèle ou Hypothèses pour créer le compte. La demande XML est validée pour chaque champ et selon une certaine logique de gestion. Des messages d’erreur sont renvoyés avec la réponse en cas d’échec de la création. L’opération peut être interrompue et un message d’avertissement peut être affiché lorsqu’une opération comportant un risque est détectée. La demande doit être soumise de nouveau avec l'attribut "ignorerWarnings" défini à 1 pour terminer la mise à jour du compte.

Format de demande

Le schéma de la demande est fourni dans le format Détente ING Compact.


default namespace = ""
start =
    element account {
        attribute id { xsd:integer }, #account id
        attribute name { xsd:string { maxLength="2048" minLength="1"} }?, #Non-empty string with a maximum length of 2048 characters.
    attribute code { xsd:string { maxLength="2048" minLength="1"} }?, #Non-empty string with a maximum length of 2048 characters.
    attribute description { xsd:string { maxLength="2048"} }?, #Potentially empty string with a maximum length of 2048 characters.
    attribute shortName { xsd:string { maxLength="64"} }?, #Potentially empty string with a maximum length of 64 characters.
    attribute exchangeRateType { xsd:string }?, #displayAs must be CURRENCY (only if multicurrency is enabled) attribute hasSalaryDetail { string "0" | string "1" }?, #0=No, 1=Yes
    attribute dataPrivacy { string "PRIVATE" | string "PUBLIC_TOP" | string "PUBLIC_ALL" }?,
    attribute isBreakbackEligible { string "0" | string "1" }?, #0=No, 1=Yes
    attribute proceedWithWarnings { string "0" | string "1" }?, #0=No, 1=Yes
    element attributes{
        element attribute{
            attribute attributeId{ xsd:integer },
            attribute valueId{ xsd:integer }
        }* 
    }?
}

Exemple


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateAccount" callerName="a string that identifies your client application">
    <credentials login="sampleuser@company.com" password="my_pwd"/>
    <account
        id="48"
        name="Account Name"
        code="Account_Code"
        description="Account Description"
        shortName="Short Name"
        exchangeRateType="A"
        hasSalaryDetail="1"
        dataPrivacy="PRIVATE" >
        <attributes>
            <attribute attributeId="20" valueId="170" />
        </attributes>
    </account>
</call>

é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 préciser 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 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	Le 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, comme exportDimensionFamis.	16
nom	Y	Le nom du compte, tel qu’il apparaît sur les rapports et les feuilles.	Actifs à court terme
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
description	N	Description textuelle du compte.	Total des actifs courants
shortName	N	Le nom abrégé du compte.	CA
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.	E
hasSalaryDetail	N	L'affichage des fractionnements de compte nécessite l'autorisation Détail du salaire. 0 pour non, 1 pour oui.	1
dataPrivacy	N	Choisissez si la valeur du compte est privée (PRIVATE), publique au niveau supérieur uniquement ( PubliC_TOP) ou publique à tous les niveaux (public_URL). Le champ PRIVÉ est défini par défaut.	PRIVÉ
isBreakbackEligible	N	Disponible dans la répartition. 0 pour non, 1 pour oui. Applicable uniquement pour les hypothèses.	0
poursuivreAvertir	N	Indique si l’utilisateur souhaite ignorer les messages d’avertissement et poursuivre l’opération de mise à jour : 0 pour non, 1 pour oui. S'il y a des avertissements et proceedWithWarnings=0, le compte ne sera pas mis à jour. Définissez proceedWithWarnings=1 pour mettre à jour le compte en cas d’avertissements.	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'attributs
Nom du marqueur		attributs
Description		Conteneur pour un ou plusieurs éléments d'attribut de compte.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments d'attribut.

élément d'attribut
Nom du marqueur		attribut
Description		Représente un élément d'attribut de compte.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
attributeID	Y	L'identifiant de l'attribut de compte généré par le système.	20
valueID	Y	L'identifiant unique de la valeur d'attribut de compte généré par le système. Si cette valeur est 0, cet attribut sera retiré du compte.	170
Contenu de l'élément
aucun

Format de réponse

Voici des exemples de réponses pour une mise à jour réussie ou non d’un compte.

Exemple de réussite


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <messages>
        <message type="WARNING" key="warning-unpublished-changes" values="" accountId="1">You have unpublished changes. 
            Your changes will not be visible every where until it is published.</message>
    </messages>
    <output>
        <accounts>
            <account id="1" code="Assets" name="Assets" description="Total Assets" timeStratum="month" displayAs="CURRENCY" accountTypeCode="A" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1" shortName="" exchangeRateType="E" balanceType="DEBIT" formula="" isLinked="0" owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="1" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="1" isGroup="0">
               <attributes>
                   <attribute
                   name="AP Eligible"
                   attributeId="17"
                   value="Yes"
                   valueId="170" />
               </attributes>
               </account>
        </accounts>
    </output>
</response>

Exemple d'erreur


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
    <messages>
       <message type="ERROR" key="invalid-account-id" values="441" accountId="-50">Invalid account id: "-50"</message>
    </messages>
</response>

élément de réponse
Nom du marqueur		réponse
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
réussite	Y	Vrai ou faux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse.	vrai
Contenu de l'élément
Un seul élément de message facultatif et/ou un seul élément de sortie facultatif.

élément de sortie
Nom du marqueur	sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un élément de comptes unique. 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 de message
Nom du marqueur	messages
Description	Conteneur pour un ou plusieurs éléments de message.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de message.

élément de message
Nom du marqueur		message
Description		Représente un message renvoyé par le système à l’appelant. Les messages sont utilisés pour envoyer des messages d’erreur lorsque les demandes échouent, pour envoyer des messages d’avertissement lorsque les demandes réussissent et pour les messages de confirmation lorsque les demandes réussissent.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
type	Y	Le type est un moyen de désigner le type de message. Les différents types sont INFO, AVERTISSEMENT et ERREUR. Le type ERROR signifie que cette demande n'a pas été traitée.	AVERTISSEMENT
clé	Y	Une clé est un moyen de repérer un message ou un type de message particulier qui est utile à des fins d’enregistrement automatique d’erreurs et de récupération dans les programmes clients. Les clés ne changent pas selon les paramètres régionaux des demandes, même lorsque la langue du message change. Il est également improbable que les clés changent à l’avenir en raison d’ajustements de formulation ou de changements de terminologie.	Avertissement-invalide-intervalle de temps
valeurs	N	Quand elles sont données, les valeurs représentent les variables utilisées dans le texte du message.	199,12
parentId	N	Le cas échéant, l’identifiant du parent du nouveau compte qui a été fourni dans la demande.	50
Contenu de l'élément
Le texte du message. Ce texte est dans la langue des paramètres régionaux précisés dans la demande (en supposant que les paramètres régionaux sont pris en charge). Le texte peut également contenir des renseignements variables, tels que le nombre de rangées traitées, ou la colonne ou la valeur particulière qui a causé une erreur.

élément des comptes
Nom du marqueur	comptes
Description	Conteneur pour un ou plusieurs éléments de compte.
Attributs de l'élément
(aucun)
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 d'API exportAccounts. Si cet élément est directement inclus dans l’élément des comptes qui sont inclus dans 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

nom

Le nom du compte, tel qu’il apparaît sur les rapports et les feuilles.

Actuel

Actifs

code

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

identifiant

Le 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, comme exportDimensionFamis.

accountTypeCode

Le code de lettre correspondant au compte de type de données.

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

Description textuelle du compte.

Total

actifs à court terme

shortName

Le nom abrégé du compte, le cas échéant, tel qu’il est entré dans l’administration du compte.

timeStratum

Pris en charge dans l'API v16+

La strate de temps du compte, comme le code de la strate de temps. Pour les comptes cubes, les comptes modélisés et les comptes GL avec cube de saisie, la strate de temps est déterminée par la strate de temps de leur feuille propriétaire. Tous les autres comptes utilisent l'ensemble de strates de temps par défaut dans l'interface utilisateur d'administration des temps.

Mois

displayAs

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

"0" ou "1" indiquant si le compte est une hypothèse. Il est défini à « 1 » pour les hypothèses et les comptes de taux de change.

supprimeZéros

Indicateur indiquant si le compte autorise ou non les utilisateurs à supprimer les zéros sur les feuilles. 0 n’est pas autorisé, 1 est autorisé. Fourni uniquement pour les comptes qui ont une propriété Supprimer les zéros dans l’administration du compte.

isDefaultRoot

"0" ou "1" indiquant si le compte ou le groupe de comptes est une racine par défaut.

decimalPrecision

Nombre de décimales à afficher pour les nombres dans ce compte. La valeur par défaut est 0. La valeur spéciale de 99 est utilisée pour indiquer un compte lié qui hérite de la précision décimale de sa cible. La valeur -1 signifie que le compte est un compte de devises et qu’il utilise la précision de la devise qu’il affiche.

planBy

Pour les comptes Cumulatif, indique si le compte est un plan par solde (BALANCE) ou un plan par delta (DELTA).

BALANCE

exchangeRateType

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.

isImportable

Indique si le compte peut accepter les données importées. 0 signifie que le compte ne peut pas être importé et 1 est importé. Présent uniquement si versionName ou versionId est indiqué dans la demande.

Note : isImportable indique uniquement qu’un compte est disponible pour l’importation dans la version indiquée, et non que l’utilisateur qui fait l’appel d’API est autorisé à effectuer une importation dans la version ou le compte. Utilisez exportVersions pour voir quelles versions sont disponibles pour l’utilisateur à l’importation.

hasSalaryDetail

L'affichage des fractionnements de compte nécessite l'autorisation Détail du salaire. 0 pour non, 1 pour oui.

balanceType

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

Indique le type de saisie de données d’un compte. STANDARD ou CUBE. Une valeur en blanc indique que le type de saisie de données ne s'applique pas à un compte. Par exemple, un compte associé ou un compte modélisé aura un type d’entrée de données en blanc.

CUBE

timeRollUp

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

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

0 ou 1 pour indiquer si ce compte comporte des fractionnements qui nécessitent l’autorisation Accès au détail du salaire pour être affichés. Ce champ sera vide si ne s'applique pas à ce compte.

dataPrivacy

Indique à quel niveau les valeurs du compte sont publiques et peuvent être référencées dans d’autres niveaux lors de l’écriture de formules. Peut être PRIVÉ pour que les valeurs du compte soient privées, Public_TOP pour que les valeurs du compte soient publiques uniquement au niveau supérieur, ou Public_All pour que les valeurs du compte soient publiques à tous les niveaux. Les hypothèses n’ont pas de paramètre dataPrivacy, car elles sont toujours publiques.

PRIVÉ

subType

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.

PÉRIUDIQUE

startdéveloppé

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.

isBreakbackEligible

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.

levelDimRollup

Indique le comportement du compte lorsqu'il est regroupé selon un niveau ou une dimension. Peut être SUM, WE Fournisseur_AVER- AGE, TEXT, ou NOTBBANK_AVERAGE. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.

NONBLANK_AVERAGE

levelDimWeightAcctId

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

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

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.

isGroup

0 ou 1 pour indiquer s’il s’agit d’un groupe de comptes ou non.

isIntercompany

0 ou 1 pour indiquer si ce compte est un compte intersociétés ou non.

formula

La formule pour le compte, s’il en a une.

Acct.Revenue - Acct.Expenses

isLinked

0 ou 1 pour indiquer si ce compte est un compte lié ou non.

isSystem

0 ou 1 pour indiquer si ce compte est un compte système ou non.

owningSheetId

Pour les comptes qui peuvent être sur des feuilles modélisées et des feuilles cubes, le numéro d’identifiant de système interne de la feuille sur laquelle se trouve ce compte. Ce champ sera vide s’il ne s’agit pas d’un tel compte ou s’il s’agit d’un tel compte, mais qu’il n’est actuellement affecté à aucune feuille.

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'attributs
Nom du marqueur		attributs
Description		Conteneur pour un ou plusieurs éléments d'attribut.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments d'attribut.

élément d'attribut
Nom du marqueur		attribut
Description		Représente un mappage d’attributs de compte unique et non vide auquel un compte est associé.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
nom	Y	Le nom de l'attribut de compte.	Production de rapports SEC
valeur	Y	Le nom de l'attribut de compte associé au compte.	Oui
attributeId	Y	Le numéro d'identifiant de système interne de l'attribut de compte.	10
valueId	Y	Le numéro d'identifiant de système interne de la valeur d'attribut de compte.	108
Contenu de l'élément
Aucune.