exportAccounts

Adaptive Planning

Documentation Workday Adaptive Planning (Workday 2025R2)
Intégration
Gérer l'intégration des données
Documentation de l'API
Méthodes de création, de mise à jour et de lecture des métadonnées et des données

Dernière mise à jour : 2023-06-23

exportAccounts

Cette API prend uniquement en charge l'utilisateur Concept : règles d'accès dans API v22 et supérieure.

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées de la liste complète de tous les comptes du système, y compris tous les types de compte : Hypothèses, Comptes cubes, Comptes personnalisés, Comptes GL, Comptes métriques et Comptes modèles.
Autorisations requises pour appeler	Aucun (doit être des identifiants valides pour l'instance)
Paramètres obligatoires à la demande	Identifiants

La demande de cette méthode contient un marqueur identifiants pour identifier et autoriser l'utilisateur appelant, et un marqueur 'inclure' pour indiquer si la réponse doit inclure des informations sur l'import des comptes dans une version particulière. Une fois vérifiée, la méthode renvoie un document XML décrivant l'ensemble des comptes du système. Les comptes sont renvoyés sous forme d'arborescence imbriquée, avec un marqueur de compte qui en inclut un autre si le compte représenté par le marqueur de clôture est un parent du compte inclus.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportAccounts" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd"/>
  <include versionName="sample version"/>
  <sheet id="3" />
</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)

inclure l'élément
Nom du marqueur		inclure
Description		Représente un ensemble d'indicateurs indiquant quels aspects des informations du compte doivent être incluses ou exclues de la réponse. Cet élément est facultatif : s'il est absent, l'API renverra des informations sur le compte pour toutes les versions et n'inclura pas l'attribut isImportable.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
versionName Mis à jour dans l'API v18	N	Indique si la réponse doit inclure l'attribut isImportable dans la réponse pour chaque compte, ce qui indique si le compte peut accepter des données importées pour la version indiquée. La valeur par défaut, si cet élément ou son attribut n'est pas présent, est de n'émettre aucun attribut isImportable dans la réponse. Si les deux attributs versionName et versionID sont indiqués pour cet élément, versionID est ignoré. Lorsque vous indiquez une version, l'appel ne passera que si l'utilisateur y a accès.	Budget 2016
versionID Mis à jour dans l'API v18	N	Identique à versionName (ci-dessus), sauf que un numéro d'identifiant de version interne est utilisé comme paramètre. Indique si la réponse doit inclure l'attribut isImportable dans la réponse pour chaque compte, ce qui indique si le compte peut accepter des données importées pour la version indiquée. Lorsque vous indiquez une version, l'appel ne passera que si l'utilisateur y a accès.	102
attributs	N	Indique si la réponse doit inclure les attributs de la réponse pour chaque compte.	false
inaccessibleValues	N	Indique si la réponse doit inclure des valeurs inaccessibles à l'utilisateur actuel. La valeur par défaut est false (faux). Seuls les utilisateurs disposant des autorisations "Modélisation" ou "Importer dans tous les périmètres" peuvent définir cette option sur vrai.	false
showAccountGroupCodes Mis à jour dans l'API v38	N	Cette option est disponible à partir de API v38. La valeur par défaut est false (faux). Si la valeur est true (vrai), inclut les codes de groupe de comptes dans la réponse en réutilisant l'attribut "code" de l'élément de réponse du compte, qui aurait été vide.	vrai
includeAttributeValueNames Mis à jour dans l'API v37	N	Cette option est disponible à partir de API v37. La valeur par défaut est false (faux). Si la valeur est true (vrai), les noms de valeur d'attribut seront inclus dans la réponse.
includeAttributeValueDisplayNames Mis à jour dans l'API v37	N	Cette option est disponible à partir de API v37. La valeur par défaut est false (faux). Si la valeur est true (vrai), les noms d'affichage des valeurs d'attribut seront inclus dans la réponse.
Contenu de l'élément
(aucun)

élément de feuille
Nom du marqueur		feuille
Description		Représente une feuille dans laquelle seuls les comptes disponibles pour cette feuille doivent être inclus dans la réponse. Cet élément est facultatif : s'il est absent, l'API renvoie les informations sur le compte, indépendamment d'une feuille particulière.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant système interne de la feuille.	234
Contenu de l'élément
(aucun)

Format de la réponse


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <accounts seqNo="42">
     <account id="2147483645" code="" name="GL Accounts" description="GL Accounts" timeStratum="" displayAs="NUMBER"
     accountTypeCode="" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1" shortName=""
     balanceType="" isLinked="0" owningSheetId="" isSystem="0" isIntercompany="0" isImportable="0" dataEntryType=""
     planBy="" timeRollup="" timeWeightAcctId="" levelDimRollup="" levelDimWeightAcctId="" rollupText="" startExpanded="1"
     hasSalaryDetail="" dataPrivacy="" isBreakbackEligible="" subType="" enableActuals="" isGroup="1">
       <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" 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">
         <account id="16" code="Current_Assets" name="Current Assets" description="current assets" timeStratum="month"
       displayAs="CURRENCY" accountTypeCode="B" decimalPrecision="0" isAssumption="0" suppressZeroes="1"
       isDefaultRoot="1" shortName="" exchangeRateType="E" balanceType="DEBIT" 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">
           <account id="51" code="70110" name="Bank Account" description="Wells Fargo account" timeStratum="month"
       displayAs="CURRENCY" accountTypeCode="B" decimalPrecision="0" isAssumption="0" suppressZeroes="1"
       isDefaultRoot="0" shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0"
       owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="STANDARD" planBy="BALANCE"
       timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText=""
       startExpanded="" hasSalaryDetail="0" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE"
       enableActuals="1" isGroup="0">
             <attributes>
               <attribute name="SEC Reporting" value="Yes" />
               <attribute name="GAAP Reporting" value="No" />
             </attributes>
           </account>
         </account>
       </account>
     </account>
   </accounts>
 </output>
</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
obsolète	N	S'il figure sur le marqueur de réponse et qu'il est défini sur true (vrai), cet attribut indique que la version de la méthode ou de l'API en cours d'appel est obsolète et qu'elle est officielement dépréciée. Même si elle continue de fonctionner à ce moment, elle peut cesser de fonctionner prochainement. En général, cet attribut n'est pas présent.	false
Contenu de l'élément
Un seul élément de messages facultatifs et exactement un élément de sortie obligatoire.

é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 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
seqNo Ajouté dans l'API v17, mais réservé pour une utilisation future.
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	O	Le nom du compte, tel qu'il apparaît sur les rapports et les feuilles.			Actifs circulants
code	O	Le code du compte, tel qu'il apparaît lorsqu'il est référencé dans les formules.			Cur_Assets
id	N	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
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 Prise en charge dans API v16 et supérieure	N	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	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	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.	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 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.	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
isImportable	N	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.	1
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	N	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	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	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.	1
dataPrivacy	N	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	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
isIntercompany	N	0 ou 1 pour indiquer si ce compte est un compte intercompagnies ou non.	1
formula Non disponible dans API v18 et supérieure.	N	La formule du compte, le cas échéant.	ACCT.Revenus - ACCT.Charges
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
owningSheetId	N	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.	17
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	Le nom de l'attribut de compte	Reporting SEC
valeur Prise en charge dans l'API v34 lorsque le paramètre Nom d'affichage en vigueur est activé.	O	La valeur de l'attribut de compte associé au compte.	Oui
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 lorsque le paramètre Nom d'affichage d'effet est activé.	N	Le code de la valeur d'attribut pour cet 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	YR
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 lorsque le paramètre Nom d'affichage d'effet est activé.	N	Le nom de la valeur d'attribut pour cet attribut. Pour API v32 et API v33, valueName n'a de sens que lorsque : Le paramètre Nom d'affichage est activé pour l'instance. displayNameEnabled=1	Oui
valueDisplayName Uniquement disponible dans API v32 et supérieure pour les instances qui activent le nom d'affichage.	O	Pour l'API v32 et les versions ultérieures, valueDisplayName n'a de sens que lorsque : Le paramètre Nom d'affichage est activé pour l'instance. displayNameEnabled=1value	Oui
attributeID	O	Numéro d'identifiant système interne de l'attribut de compte.	10
valueID	O	Numéro d'identifiant système interne de l'attribut de compte.	108
Contenu de l'élément
aucun(e)

Dimension REST customReportValues

exportActiveCurrencies

Cela vous a-t-il été utile?

Souhaitez-vous nous signaler quelque chose ? Exact Répond à ma question Facile à trouver Facile à comprendre Utile pour ma tâche Complet et détaillé

Souhaitez-vous nous signaler quelque chose ? Inexact Ne répond pas à ma question Pas facile à trouver Pas facile à comprendre Inutile pour ma tâche Incomplet ou pas assez détaillé

Décrivez-nous votre tâche en cours. Quelles informations supplémentaires pourraient améliorer ce contenu ? Voulez-vous partager des informations supplémentaires ?

Nom complet

E-mail

Workday utilisera votre nom et votre adresse électronique pour répondre à vos commentaires. Vos données seront traitées conformément à notre Déclaration de confidentialité.

Merci pour votre feedback