updateAccount

Adaptive Planning

updateAccount

Catégorie	Modification des 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 une fois le compte mis à jour avec succès. Cette API prend uniquement en charge les types de compte suivants : Hypothèse, Compte GL et Compte personnalisé. Il ne prend pas en charge les comptes système ou liés.
Autorisations requises pour appeler	Modèle pour les comptes GL et personnalisés. Hypothèses pour les hypothèses.
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. L'utilisateur doit avoir l'autorisation Modèle ou Hypothèses pour pouvoir créer le compte. La demande XML est validée pour chaque champ et par rapport à certaines logiques de gestion. Les messages d'erreur sont renvoyés dans le cadre de la réponse lorsque la création échoue. L'opération peut être interrompue et un message d'avertissement affiché lorsqu'une opération à risque est détectée. La demande doit être soumise de nouveau avec l'attribut "IgnoreWarnings" défini sur 1 pour finaliser la mise à jour du compte.

Format de demande

Le schéma de la demande est fourni au format dépend du format d'assouplissement de l'unité légale assouplir le format fiscal de l'unité légale.


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 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 spécifié dans les identifiants 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 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 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. Il permet d'identifier des comptes dans d'autres appels d'API, tels que exportDimensionFamilies.	16
nom	O	Le nom du compte, tel qu'il apparaît sur les rapports et les feuilles.	Actifs circulants
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
description	N	Description textuelle du compte.	Total des actifs circulants
shortName	N	Le nom abrégé du compte.	CA
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.	E
hasSalaryDetail	N	L'affichage des subdivisions du compte requiert l'autorisation Accès au détail des salaires. 0 pour non, 1 pour oui.	1
dataPrivacy	N	Indiquez si la valeur du compte est privée (private), publique au niveau supérieur uniquement (public_TOP) ou publique à tous les périmètres (public_ALL). La valeur par défaut est PRIVÉ.	PRIVÉ
isBreakbackEligible	N	Disponible avec la répartition. 0 pour non, 1 pour oui. Uniquement applicable pour les hypothèses.	0
proceedWithWarnings	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 existe des avertissements et proceedWithWarnings=0, le compte ne sera pas mis à jour. Définissez proceedWithWarnings=1 pour mettre à jour le compte en cas d'avertissement.	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 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	O	Identifiant de l'attribut de compte qui a été généré par le système.	20
valueID	O	Identifiant unique de la valeur d'attribut de compte qui a été générée par le système. Si cette valeur est 0, alors cet attribut sera supprimé du compte.	170
Contenu de l'élément
aucun(e)

Format de la 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	O	Vrai ou faux, indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse.	vrai
Contenu de l'élément
Un seul élément de messages facultatifs 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 seul élément comptes. 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 de messages
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 que le système renvoie à l'appelant. Les messages sont utilisés pour les messages d'erreur lorsque les demandes n'ont pas abouti, pour les messages d'avertissement lorsque les demandes ont abouti et pour les messages de confirmation lorsque les demandes ont abouti.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
type	O	Le Type est un moyen d'identifier le type de message. Les types différents sont INFO, AVERTISSEMENT et ERREUR. Le type ERREUR signifie que cette demande n'a pas été traitée.	AVERTISSEMENT
clé	O	Une clé permet d'identifier un message ou un type de message particulier, utile à des fins de journalisation et de récupération automatisées des erreurs dans les programmes client. 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 peu probable que les clés changent à l'avenir en raison d'ajustements du libellé ou de la terminologie.	Avertissement-invalide-intervalle de temps-départ
valeurs	N	Lorsqu'elles sont données, les valeurs représentent les variables utilisées dans le texte du message.	199,12
parentId	N	Lorsque disponible, l'identifiant du parent du nouveau compte qui a été fourni dans la demande.	50
Contenu de l'élément
Texte du message. Ce texte est exprimé dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux soient pris en charge). Le texte peut également contenir des informations variables telles que le nombre de lignes qui ont été traitées ou la colonne ou la valeur particulière à l'origine de l'erreur.

élément 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

account

Description

Représente un seul compte renvoyé en réponse à un appel d'API exportAccounts. 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

nom

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

Actuel

Actifs

code

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

L'identifiant système interne du compte. Il permet d'identifier des comptes dans d'autres appels d'API, tels que exportDimensionFamilies.

accountTypeCode

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

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

Description textuelle du compte.

Total

actifs circulants

shortName

Le nom abrégé du compte, le cas échéant, tel que saisi dans l'administration du compte.

timeStratum

Prise en charge dans API v16 et supérieure

La strate de temps du compte, comme code de la strate de temps. Pour les comptes cubes, les comptes modèles et les comptes GL cubes 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 la strate de temps par défaut définie dans l'interface utilisateur de l'administration des temps.

Mois

displayAs

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

"0" ou "1", indiquant si le compte est une hypothèse. Elle est paramétrée sur 1 pour les hypothèses et les comptes de taux de change.

supprimer les zéros

Indicateur indiquant si le compte permet aux utilisateurs de supprimer les zéros dans les feuilles ou non. 0 est non autorisé, 1 est autorisé. Fournit uniquement pour les comptes disposant d'une propriété Supprimer les zéros dans Administration du compte.

isDefaultRoot

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

decimalPrecision

Nombre de décimales à afficher pour les nombres de ce compte. La valeur par défaut est 0. La valeur spéciale 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 en devise et qu'il utilise la précision de la devise qu'il affiche.

planBy

Pour les comptes cumulés, indique si le compte est plan par solde ( Solde) ou plan par delta (DELTA).

BALANCE

exchangeRateType

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.

isImportable

Indique si le compte est en mesure d'accepter les données importées. 0 signifie que le compte n'est pas importable et 1 est importable. Uniquement présent si versionName ou versionId est indiqué dans la demande.

Remarque : isImportable indique uniquement qu'un compte est disponible pour l'import dans la version spécifiée, et non que l'utilisateur qui a fait l'appel d'API est autorisé à importer dans la version ou le compte. Utilisez exportVersions pour voir quelles versions sont disponibles pour l'utilisateur.

hasSalaryDetail

L'affichage des subdivisions du compte requiert l'autorisation Accès au détail des salaires. 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 le compte n'est associé à aucun type de solde. 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 vide indique que le type de saisie de données ne s'applique à aucun compte. Par exemple, un compte lié ou un compte modèle aura le type de saisie de données vide.

CUBE

timeRollUp

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

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

Saisissez 0 ou 1 pour indiquer si ce compte contient des subdivisions qui nécessitent l'autorisation Accès au détail des salaires pour être affichée. Cette option sera vide si elle ne s'applique pas à ce compte.

dataPrivacy

Indique dans quels périmètres les valeurs du compte sont publiques et peuvent être référencées dans d'autres périmètres 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 ne sont pas associées à un paramètre dataPrivacy, car elles sont toujours publiques.

PRIVÉ

subType

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.

PÉRIODIQUE

startExpanded

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.

isBreakbackEligible

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

levelDimRollup

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, WE WeightED_AVERAGE, TEXT ou NOBBANK_AVERAGE. Cette option sera vide pour les groupes de comptes et les comptes métriques.

NONBLANK_AVERAGE

levelDimWeightAcctId

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

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

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.

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 intercompagnies ou non.

formula

La formule du compte, le cas échéant.

ACCT.Revenus - ACCT.Charges

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 dans des feuilles modèles et cubes, le numéro d'identifiant système interne de la feuille sur laquelle ce compte se trouve. Ce champ sera vide s'il ne s'agit pas d'un compte de ce type, ou s'il s'agit d'un compte de ce type 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'attribut si le compte est associé à un ou plusieurs attributs.

élément 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	O	Nom de l'attribut de compte.	Reporting SEC
valeur	O	Le nom de l'attribut de compte associé au compte.	Oui
attributeId	O	L'identifiant système interne de l'attribut de compte.	10
valueId	O	Numéro d'identifiant système interne de la valeur d'attribut du compte.	108
Contenu de l'élément
Aucune.