exportAccounts

Adaptive Planning

Documentazione di Workday Adaptive Planning (Workday 2025R2)
Integrazione
Gestione dell'integrazione dei dati
Documentazione API
Metodi di creazione, aggiornamento e lettura di metadati e dati

Ultimo aggiornamento: 2023-06-23

exportAccounts

Questa API supporta solo l'utente Concetto: Regole di accesso nell'API v22 e versioni successive.

Categoria	Recupero dei metadati
Descrizione	Restituisce i metadati per l'elenco completo di tutti i conti nel sistema, inclusi tutti i tipi di conto: ipotesi, conti cubo, conti personalizzati, conti CoGe, conti metrica e conti modellati.
Autorizzazioni necessarie per richiamare	Nessuno (devono essere credenziali valide per l'istanza)
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante e un tag "include" per indicare se la risposta deve includere informazioni sull'importabilità dei conti in una determinata versione. Una volta verificato, il metodo restituisce un documento XML che descrive l'insieme completo di conti nel sistema. I conti vengono restituiti ad albero nidificato, con un'etichetta conto che ne racchiude un'altra se il conto rappresentato dall'etichetta di inclusione è padre del conto chiuso.

Formato richiesta


<?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>

elemento credenziali
Nome tag		credenziali
Descrizione		Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
accedere	S	Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo.	sampleuser@company.com
password	S	La password dell'utente che richiama il metodo API.	my_password
impostazioni internazionali	N	Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei mesi e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano).	fr_FR
instanceCode	N	Se l'utente specificato nelle credenziali ha accesso a più istanze di Adaptive Planning , questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances.	MYINSTANCE1
Contenuto dell'elemento
(nessuno)

elemento include
Nome tag		includere
Descrizione		Rappresenta un insieme di flag che indicano quali aspetti delle informazioni dei conti devono essere inclusi o esclusi dalla risposta. Questo elemento è facoltativo: se non è presente, l'API restituirà le informazioni sul conto per tutte le versioni e non includerà l'attributo isImportable.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
versionName Aggiornato nell'API v18	N	Indica se la risposta deve includere l'attributo isImportable nella risposta per ogni conto, indicando se il conto può accettare dati importati per la versione specificata. L'impostazione predefinita, se questo elemento o il relativo attributo non è presente, non emette alcun attributo isImportable nella risposta. Se in questo elemento sono specificati entrambi gli attributi versionName e versionID, il versionID viene ignorato. Quando si specifica una versione, la chiamata avrà esito positivo solo se l'utente ha accesso alla versione.	Budget 2016
versionID Aggiornato nell'API v18	N	Uguale a versionName (sopra) tranne per il fatto che accetta un numero ID versione interno come parametro. Indica se la risposta deve includere l'attributo isImportable nella risposta per ogni conto, indicando se il conto può accettare dati importati per la versione specificata. Quando si specifica una versione, la chiamata avrà esito positivo solo se l'utente ha accesso alla versione.	102
attributi	N	Indica se la risposta deve includere gli attributi nella risposta per ogni conto.	falso
inaccessibleValues	N	Indica se la risposta deve includere valori inaccessibili all'utente corrente. Il valore predefinito è false. Solo gli utenti con le autorizzazioni "Modellazione" o "Importa in tutti i livelli" possono impostare questa opzione su true.	falso
showAccountGroupCodes Aggiornato nell'API v38	N	Questa opzione è disponibile a partire dall'API v38. Il valore predefinito è false. Se impostato su true, include i codici dei gruppi di conti in risposta riutilizzando l'attributo "code" dell'elemento di risposta del conto, che in precedenza sarebbe stato vuoto.	true
includeAttributeValueNames Aggiornato nell'API v37	N	Questa opzione è disponibile a partire dall'API v37. Il valore predefinito è false. Se impostato su true, i nomi dei valori attributo verranno inclusi nella risposta.
includeAttributeValueDisplayNames Aggiornato nell'API v37	N	Questa opzione è disponibile a partire dall'API v37. Il valore predefinito è false. Se è impostato su true, i nomi visualizzati dei valori attributo verranno inclusi nella risposta.
Contenuto dell'elemento
(nessuno)

elemento del foglio
Nome tag		foglio
Descrizione		Rappresenta un foglio in cui devono essere inclusi nella risposta solo i conti disponibili per quel foglio. Questo elemento è facoltativo: se non è presente, l'API restituirà le informazioni sul conto indipendentemente da un determinato foglio.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
ID	S	Il numero ID di sistema interno per il foglio.	234
Contenuto dell'elemento
(nessuno)

Formato risposta


<?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>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	true
obsoleto	N	Se presente nel tag di risposta e impostato su true, questo attributo indica che la versione del metodo o dell'API richiamata è diventata obsoleta ed è ufficialmente obsoleta. Sebbene continui a funzionare in questo momento, potrebbe cessare di funzionare in breve tempo. In genere, questo attributo non è presente.	falso
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo ed esattamente un elemento di output obbligatorio.

elemento di output
Nome tag	output
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento di conti. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

elemento conti
Nome tag		conti
Descrizione		Contenitore per uno o più elementi del conto.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
seqNo Aggiunto nell'API v17 ma riservato per un utilizzo futuro.
Contenuto dell'elemento
Uno o più elementi del conto.

elemento conto
Nome tag		account
Descrizione		Rappresenta un singolo conto restituito nella risposta a una chiamata API exportAccounts. Se questo elemento si trova direttamente all'interno dell'elemento conti di inclusione della risposta (ovvero non è racchiuso in un altro elemento conto), questo elemento conto rappresenta un conto radice, un conto privo di padre.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore			Esempio
nome	S	Il nome del conto, come appare nei report e nei fogli.			Attività correnti
codice	S	Il codice del conto, come appare quando si fa riferimento nelle formule.			Cur_Assets
ID	N	Il numero ID di sistema interno per il conto. Può essere utilizzato per identificare i conti in altre chiamate API, ad esempio exportDimensionFamilies.			16
accountTypeCode	N	Il codice lettera corrispondente al tipo di dati del conto
		Digitare il codice	Tipo di conto	Classe conto
		A	Attività	CoGe
		B	Attività correnti	CoGe
		C	Passività e capitale netto	CoGe
		CUBO	Cubo	Cubo
		IT	Utili/perdite da inizio anno	CoGe
		F	Attività	CoGe
		G	Costo del venduto	CoGe
		I	Income	CoGe
		J	Utile non operativo	CoGe
		K	Rettifica conversione cumulativa	Sistema
		L	Passività	CoGe
		M	Passività correnti	CoGe
		MI	Percentuali di consolidamento	Predefinito
		MT	Metrica	Metrica
		N	Utile netto	CoGe
		O	Altre attività	CoGe
		Q	Capitale netto	CoGe
		R	Attività a lungo termine	CoGe
		S	Ipotesi	Ipotesi
		T	Passività a lungo termine	CoGe
		W	Modellato	Modellato
		X	Spese	CoGe
		XR	cambio budget	Predefinito
		S	Spese non operative	CoGe
		Z	Personalizzato	Personalizzato

descrizione	N	La descrizione testuale del conto, se presente, immessa in Amministrazione conto	Totale attività correnti
shortName	N	Il nome abbreviato del conto, se presente, immesso in Amministrazione conto	CA
timeStratum Supportato nell'API v16 +	N	Lo strato temporale del conto, come codice dello strato temporale. Per i conti cubo, i conti modellati e i conti CoGe inseriti nel cubo, lo strato temporale è determinato dallo strato temporale del foglio proprietario. Tutti gli altri conti utilizzano lo strato temporale predefinito impostato nell'interfaccia utente di Time Admin.	Month
displayAs	N	L'impostazione di visualizzazione dell'output del conto: NUMBER, CURRENCY o PERCENT. Fornito solo per i conti che hanno una proprietà Visualizza come in Amministrazione conti.	NUMBER
isPrestazioni	N	"0" o "1", a indicare se il conto è un'ipotesi. È impostato su 1 per i conti ipotesi e tassi di cambio.	1
suppressZeroes	N	Contrassegno che indica se il conto consente agli utenti di eliminare o meno gli zeri nei fogli. 0 non è consentito, 1 è consentito. Fornito solo per i conti che hanno una proprietà Elimina zeri in Amministrazione conti.	1
isDefaultRoot	N	"0" o "1", a indicare se il conto o il gruppo di conti è una radice predefinita.	1
decimalPrecision	N	Numero di posizioni decimali da visualizzare per i numeri in questo conto. Il valore predefinito è 0. Il valore speciale 99 viene utilizzato per indicare un Conto collegato che eredita la precisione decimale della destinazione. Un valore pari a -1 indica che il conto è un conto in valuta e utilizza la precisione della valuta visualizzata.	0
planBy	N	Per i conti cumulativi, indica se il conto è piano per saldo (SALDO) o piano per delta (DELTA).	SALDO
exchangeRateType	N	Presente solo per i conti con displayAs="CURERENCY". Valori possibili: qualsiasi codice del tipo di tasso di cambio presente nell'istanza, come configurato in Gestione valute. "A"=Media mensile, "E"=Fine mese.	E
isImportable	N	Indica se il conto è in grado di accettare i dati importati. 0 significa che il conto non è importabile e 1 è importabile. Presente solo se nella richiesta è specificato versionName o versionId. Nota: isImportable indica solo che un conto è disponibile per l'importazione nella versione specificata, non che l'utente che effettua la chiamata API dispone dell'autorizzazione per l'importazione nella versione o nel conto. Utilizzare exportVersions per vedere quali versioni sono disponibili per l'importazione.	1
balanceType	N	Indica il tipo di saldo di un conto, DEBIT o CREDITO. Questo attributo è vuoto se al conto non è associato un tipo di saldo. Solo i conti CoGe hanno un tipo di saldo.	DEBIT
dataEntryType	N	Indica il tipo di immissione dati di un conto. STANDARD o CUBE. Un valore vuoto indica che il tipo di immissione dati non è applicabile a un conto. Ad esempio, un conto collegato o un conto modellato avrà un tipo di immissione dati vuoto.	CUBO
timeRollUp	N	Indica il comportamento del conto in caso di rollup in un periodo di tempo. Può essere SUM, WEIGHTED_AVERAGE, LAST o AVERAGE. Questo campo sarà vuoto per i gruppi di conti e i conti metrica.	SUM
timeWeightAcctId	N	Se il conto ha un timeRollup di WEIGHTED_AVERAGE, questo sarà il numero ID sistema interno del conto da cui vengono determinate le ponderazioni. Il valore sarà vuoto se non esiste un conto di ponderazione o se il conto non ha un timeRollup di WEIGHTED_AVERAGE.	133
hasSalaryDetail	N	0 o 1 per indicare se il conto ha frazionamenti che richiedono l'autorizzazione Accesso ai dettagli stipendio per la visualizzazione. Questo campo sarà vuoto se non applicabile a questo conto.	1
dataPrivacy	N	Indica i livelli in cui i valori del conto sono pubblici e possono essere referenziati in altri livelli durante la scrittura delle formule. Può essere PRIVATE in modo che i valori del conto siano privati, PUBLIC_TOP in modo che i valori del conto siano pubblici solo al livello superiore o PUBLIC_ALL in modo che i valori del conto siano pubblici a tutti i livelli. I presupposti non hanno un'impostazione dataPrivacy perché sono sempre pubblici.	PRIVATO
subType	N	Indica se il conto è PERIODICO o CUMULATIVO. Se un conto è periodico, il suo valore in un determinato periodo di tempo è uguale all'attività netta per il periodo di tempo. Gli esempi includono i conti dei ricavi e delle spese. Se un conto è cumulativo, il suo valore è uguale al saldo finale per un determinato periodo di tempo. Questo è il valore del periodo di tempo precedente più o meno qualsiasi attività nel periodo di tempo specificato. I conti di stato patrimoniale sono cumulativi. Questo campo sarà vuoto per i gruppi di conti e i conti metrica.	PERIODIC
startExpanded	N	Ciò indica se un conto e i relativi elementi figlio iniziano in uno stato esteso al primo caricamento di un foglio. Ciò si applica solo ai conti padre. Questo sarà vuoto per i conti foglia.	1
isBreakbackEligible	N	0 o 1 per indicare se il conto può essere utilizzato in una ripartizione retroattiva. Ciò si applica solo alle ipotesi standard. Questo campo sarà vuoto per gli altri tipi di conto.	0
levelDimRollup	N	Indica il comportamento del conto quando viene eseguito il rollup lungo un livello o una dimensione. Può essere SUM, WEIGHTED_AVERAGE, TEXT o NONBLANK_AVERAGE. Questo campo sarà vuoto per i gruppi di conti e i conti metrica.	NONBLANK_AVERAGE
levelDimWeightAcctId	N	Se il conto ha un livelloDimRollup di WEIGHTED_AVERAGE, questo sarà il numero ID sistema interno del conto da cui vengono determinate le ponderazioni. Questo campo sarà vuoto se non esiste un conto di ponderazione o se il livello del contoDimRollup non è WEIGHTED_AVERAGE.	118
rollupText	N	Se il conto ha un levelDimRollup di TEXT, questa è la stringa di testo che verrà visualizzata nella cella che indica il valore di rollup del conto.	Nessuno
enableActuals	N	0 per mostrare solo i dati del piano per il conto. 1 per importare gli importi effettivi nel conto. Per i conti collegati, 0 mostrerà gli importi effettivi solo se il conto collegato li ha e 1 abiliterà gli importi effettivi per il conto collegato. Questo campo sarà vuoto per i gruppi di conti e i conti metrica.	1
isGroup	S	0 o 1 per indicare se si tratta o meno di un gruppo di conti.	1
isIntercompany	N	0 o 1 per indicare se il conto è un conto interaziendale o meno.	1
formula Non disponibile nell'API v18+.	N	La formula per il conto, se presente.	ACCT.Revenue - ACCT.Expenses
isLinked	N	0 o 1 per indicare se il conto è collegato o meno.	1
isSystem	N	0 o 1 per indicare se il conto è un conto di sistema o meno.	1
owningSheetId	N	Per i conti che possono trovarsi in fogli modellati e cubo, il numero ID sistema interno del foglio in cui si trova il conto. Questo campo sarà vuoto se non si tratta di un conto di questo tipo o se si tratta di un conto di questo tipo ma non è attualmente assegnato a un foglio.	17
Contenuto dell'elemento
Un elemento conto nidificato per ogni conto figlio diretto di questo conto. Un elemento attributi se al conto sono associati uno o più attributi.

elemento attributi
Nome tag		attributi
Descrizione		Contenitore per uno o più elementi attributo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi attributo.

elemento attributo
Nome tag		attributo
Descrizione		Rappresenta una singola mappatura di attributi conto non vuoti a cui è associato un conto.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome dell'attributo conto	Report SEC
valore Supportato nell'API v34 quando l'impostazione Nome visualizzato effettivo è attiva.	S	Il valore dell'attributo conto associato al conto.	Sì
valueCode Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato. Non supportato nell'API v34 quando l'impostazione Nome visualizzato effettivo è attiva.	N	Il codice valore attributo per questo attributo. Per API v32 e API v33, valueCode è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1	YR
valueName Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato. Non supportato nell'API v34 quando l'impostazione Nome visualizzato effettivo è attiva.	N	Il nome del valore attributo per questo attributo. Per API v32 e API v33, valueName è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1	Sì
valueDisplayName Disponibile solo nell'API v32+ per le istanze che abilitano il nome visualizzato.	S	Per l'API v32 e successive, valueDisplayName è significativo solo quando: L'impostazione Nome visualizzato è ATTIVA per l'istanza. displayNameEnabled=1value	Sì
attributeID	S	Il numero ID sistema interno dell'attributo conto.	10
valueID	S	Il numero ID sistema interno dell'attributo conto.	108
Contenuto dell'elemento
nessuno

customReportValues REST Specification

exportActiveCurrencies

Questo contenuto è stato utile?

Che cosa richiede la nostra attenzione? Preciso Risponde alla mia domanda Facile da trovare Di facile comprensione Utile per completare l'attività Completo di dettagli

Che cosa richiede la nostra attenzione? Impreciso Non risponde alla mia domanda Non facile da trovare Di non facile comprensione Non utile per completare l'attività Incompleto o senza dettagli

Indica l'attività che stai eseguendo. Quali informazioni aggiuntive potrebbero migliorare questo contenuto? Hai altri dettagli da condividere?

Nome completo

E-mail

Workday utilizzerà il vostro nome e la vostra e-mail per fornirvi le risposte relative al vostro feedback. I vostri dati saranno trattati in conformità con la nostra Informativa sulla privacy.

Grazie per il feedback