exportAccounts

Adaptive Planning

Notes de publication (Workday 2025R2)

exportAccounts

Cette API prend en charge uniquement l’utilisateur Concept : règles d’accès dans l’API v22 et au-delà.

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées pour la liste complète de tous les comptes du système, y compris tous les types de comptes : Hypothèses, Comptes cubes, Comptes personnalisés, Comptes GL, Comptes d’indicateurs et Comptes modélisés.
Autorisations obligatoires pour pouvoir être appelées	Aucun (doit être un identifiant valide pour l’instance)
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient un marqueur des données d’identification pour désigner et autoriser l’utilisateur appelant et un marqueur 'include' pour indiquer si la réponse doit inclure des informations sur l’importation 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 retournés sous forme d’arborescence imbriquée, un marqueur de compte en incluant un autre si le compte représenté par le marqueur enveloppant 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 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)

inclure un élément
Nom du marqueur		inclure
Description		Représente un ensemble d’indicateurs indiquant quels aspects de l’information sur les comptes doivent être inclus ou exclus de la réponse. Cet élément est facultatif : s’il est absent, l’API renvoie les informations de 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	Pour chaque compte, indique si la réponse doit inclure l’attribut isImportable dans la réponse, en indiquant si le compte peut accepter les données importées pour la version précisé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 à la fois les attributs versionName et versionID sont indiqués sur cet élément, l'attribut versionID est ignoré. Quand une version est précisée, l’appel aboutit uniquement si l’utilisateur a accès à la version.	Budget 2016
versionID Mis à jour dans l'API v18	N	Identique à versionName (au-dessus), sauf qu’il prend un numéro d’identifiant de version interne comme paramètre. Pour chaque compte, indique si la réponse doit inclure l’attribut isImportable dans la réponse, en indiquant si le compte peut accepter les données importées pour la version précisée. Quand une version est précisée, l’appel aboutit uniquement si l’utilisateur a accès à la version.	102
attributs	N	Indique si la réponse doit inclure les attributs dans la réponse pour chaque compte.	faux
inaccessibleValues	N	Indique si la réponse doit inclure des valeurs inaccessibles à l’utilisateur actuel. La valeur par défaut est Faux. Seuls les utilisateurs disposant des autorisations "Modélisation" ou "Importer à tous les niveaux" peuvent définir cette option à Vrai.	faux
showAccountGroupCodes Mis à jour dans l'API v38	N	Cette option est disponible à compter de la version 38 de l’API. La valeur par défaut est Faux. Si la valeur est 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 au compte, qui aurait été vide.	vrai
includeAttributeValueNames Mis à jour dans l'API v37	N	Cette option est disponible à compter de la version 37 de l’API. La valeur par défaut est Faux. Si la valeur est vraie, les noms des valeurs d’attribut seront inclus dans la réponse.
includeAttributeValueDisplayNames Mis à jour dans l'API v37	N	Cette option est disponible à compter de la version 37 de l’API. La valeur par défaut est Faux. Si la valeur est vraie, 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 n’est pas présent, l’API renvoie l’information sur le compte indépendamment d’une feuille particulière.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Le numéro d’identifiant de système interne pour la feuille.	234
Contenu de l'élément
(aucun)

Format de 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	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
obsolète	N	S’il est présent dans le marqueur de réponse et défini à Vrai, cet attribut indique que la version de la méthode ou de l’API qui est appelée est obsolète et est officiellement dépréciée. Bien qu’elle continue de fonctionner pour le moment, elle pourrait cesser de fonctionner sous peu. En général, cet attribut n’est pas présent.	faux
Contenu de l'élément
Un seul élément de message facultatif et un seul é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 é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 des comptes
Nom du marqueur		comptes
Description		Conteneur pour un ou plusieurs éléments de compte.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
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		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 inclus de la réponse (c’est-à-dire qu’il n’est pas inclus dans un autre élément de compte), cet élément de compte représente un compte racine, un compte qui n’a pas de parent.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur			Exemple
nom	Y	Le nom du compte, tel qu’il apparaît sur les rapports et les feuilles.			Actifs à court terme
code	Y	Le code du compte, tel qu’il apparaît lorsqu’il est référencé dans des formules.			Cur_Assets
identifiant	N	Il s’agit du numéro d’identifiant de système interne pour le compte. Cela peut être utilisé pour désigner des comptes dans d’autres appels d’API, tels que exportDimensionFamis.			16
accountTypeCode	N	Code de lettre correspondant au type de données de ce compte
		Code de type	Type de compte	Classe du compte
		A	Actif	GL
		B	Actif à court terme	GL
		C	Passif et capitaux propres	GL
		CUBE	Cube	Cube
		EN	Perte/revenus depuis le début de l'exercice	GL
		F	Actif immobilisé	GL
		G	Coût des produits vendus	GL
		I	Produits	GL
		J	Produits hors exploitation	GL
		K	Écart de conversion cumulé	Système
		L	Passif	GL
		M	Passif à court terme	GL
		MI	Pourcentages de consolidation	Prédéfinis
		MT	Indicateur	Indicateur
		N	Résultat net	GL
		O	Autre actif	GL
		Q	Capitaux propres	GL
		R	Actif à long terme	GL
		S	Hypothèse	Hypothèse
		T	Passif à long terme	GL
		W	Modélisé	Modélisé
		X	Charges	GL
		XR	Taux de change	Prédéfinis
		Y	Charges hors exploitation	GL
		Z	Personnalisé	Personnalisé

description	N	Description textuelle du compte, le cas échéant, telle qu’elle est entrée dans l’administration du compte	Total des actifs courants
shortName	N	Nom abrégé du compte, le cas échéant, tel qu’il est entré dans l’administration du compte	CA
timeStratum Pris en charge dans l'API v16 +	N	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	N	Le paramètre d’affichage de sortie du compte : NUMBER, DEVISE ou PERCENT. Fourni uniquement pour les comptes qui ont une propriété Afficher sous forme d’administration du compte.	NUMBER
isAssumption	N	"0" ou "1" indiquant si le compte est une hypothèse. Ceci est défini à 1 pour les hypothèses et les comptes de taux de change.	1
supprimeZéros	N	Indicateur indiquant si le compte autorise les utilisateurs à supprimer ou non des 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.	1
isDefaultRoot	N	"0" ou "1" indiquant si le compte ou le groupe de comptes est une racine par défaut.	1
decimalPrecision	N	Nombre de décimales à afficher pour les nombres dans ce compte. La valeur 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.	0
planBy	N	Pour les comptes Cumulatif, indique si le compte est un plan par solde (BALANCE) ou un plan par delta (DELTA).	BALANCE
exchangeRateType	N	Présent uniquement pour les comptes avec la valeur de primeAs="CUERENCY". Valeurs possibles : l’un des codes de type de taux de change présents dans l’instance, tels que configurés dans Gérer les devises. « A » = Moyenne mensuelle, « E » = Fin du mois.	E
isImportable	N	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.	1
balanceType	N	Indique le type de solde d’un compte, Débit ou Crédit. Cet attribut est vide si aucun type de solde n'est associé au compte. Seuls les comptes GL ont un type de solde.	DÉBIT
dataEntryType	N	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	N	Indique le comportement du compte lors d’un regroupement sur une période donnée. Peut être SUM, WEafficher_AVERAGE, LAST ou AVERAGE. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.	SUM
timeWeightAcctId	N	Si la valeur de timeRollup de ce compte est WE Active_AVERAGE, il s’agira du numéro d’identifiant de système interne du compte à partir duquel les pondérations seront déterminées. Ce champ sera vide s'il n'existe aucun compte de pondération ou si le compte n'a pas un timeRollup de WEighted_AVERAGE.	133
hasSalaryDetail	N	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.	1
dataPrivacy	N	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	N	Indique si le compte est PRIVÉ ou CUMULÉ. Si un compte est périodique, sa valeur dans une période temporelle donnée est égale à l’activité nette pour la période temporelle. Les exemples incluent les comptes de produits et de charges. Si un compte est cumulatif, sa valeur est égale au solde de clôture pour une période temporelle donnée. Il s’agit de la valeur de la période antérieure plus ou moins toute activité dans la période temporelle donnée. Les comptes de bilan sont cumulatifs. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.	PÉRIUDIQUE
startdéveloppé	N	Cela indique si un compte et ses enfants démarrent avec un état développé lors du premier chargement d’une feuille. Cela s’applique uniquement aux comptes parents. Ce champ sera vide pour les comptes feuilles.	1
isBreakbackEligible	N	0 ou 1 pour indiquer si ce compte peut être utilisé dans une répartition. Cela s’applique uniquement aux hypothèses standard. Ce sera vide pour d'autres types de comptes.	0
levelDimRollup	N	Indique le comportement du compte lorsqu'il est regroupé selon un niveau ou une dimension. Peut être SUM, WEafficher_AVERAGE, TEXT ou NOTB Planning_AVERAGE. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.	NONBLANK_AVERAGE
levelDimWeightAcctId	N	Si ce compte a un niveau LevelDimRollup de WE Active_AVERAGE, il s'agira du numéro d'identifiant de système interne du compte à partir duquel les pondérations seront déterminées. Ce champ sera vide s'il n'existe aucun compte de pondération ou si la valeur LevelDimRollup du compte n'est pas WE Active_AVERAGE.	118
rollupText	N	Si ce compte a un LevelDimRollup de TEXT, c’est la chaîne de texte qui s’affichera dans la cellule indiquant la valeur agrégée du compte.	Aucun
enableActuals	N	0 pour afficher uniquement les données du plan pour le compte. 1 pour importer les chiffres réels dans le compte. Pour les comptes liés, la valeur 0 affichera les chiffres réels uniquement si le compte lié en contient, et la valeur 1 activera les chiffres réels pour le compte lié. Ce champ sera vide pour les groupes de comptes et les comptes d'indicateurs.	1
isGroup	Y	0 ou 1 pour indiquer s’il s’agit d’un groupe de comptes ou non.	1
isIntercompany	N	0 ou 1 pour indiquer si ce compte est un compte intersociétés ou non.	1
formula Non disponible dans l'API v18+.	N	La formule pour le compte, s’il en a une.	Acct.Revenue - Acct.Expenses
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 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.	17
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 Pris en charge dans l'API v34 lorsque le paramètre Nom d'affichage en vigueur est ACTIVÉ.	Y	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 en vigueur est ACTIVÉ.	N	Le code de valeur d'attribut pour cet attribut. Pour les API v32 et API v33, valueCode n’a de sens que lorsque : Le paramètre Nom d’affichage est ACTIVÉ pour l’instance. displayNameEnabled=1	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 en vigueur est ACTIVÉ.	N	Le nom de la valeur d'attribut pour cet attribut. Pour les 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 Disponible uniquement dans l’API v32+ pour les instances qui activent le nom d’affichage.	Y	Pour l’API v32 et les versions plus récentes, valueDisplayName n’a de sens que lorsque : Le paramètre Nom d’affichage est ACTIVÉ pour l’instance. displayNameEnabled=1value	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 l'attribut de compte.	108
Contenu de l'élément
aucun

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

Que désirez-vous porter à notre attention? Information exacte Répond à ma question Facile à trouver Facile à comprendre M'aide à effectuer ma tâche Information complète et détaillée

Que désirez-vous porter à notre attention? Information inexacte Ne répond pas à ma question Difficile à trouver Difficile à comprendre Ne m'aide pas à effectuer ma tâche Information incomplète ou pas assez détaillée

Décrivez-nous la tâche que vous effectuez. Quelle information supplémentaire pourrait améliorer ce contenu? Voulez-vous partager d’autres détails?

Nom complet

Courriel

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

Merci pour vos commentaires