exportAccounts

Adaptive Planning

Documentação do Workday Adaptive Planning (Workday 2025R2)
Integração
Como gerenciar a integração de dados
Documentação da API
Métodos de criação, atualização e leitura de metadados e dados

Última atualização: 2023-06-23

exportAccounts

Esta API oferece suporte somente a usuários Conceito: regras de acesso na API v22 e superiores.

Categoria	Recuperação de metadados
Descrição	Retorna metadados para a lista completa de todas as contas no sistema, incluindo todos os tipos de conta: suposições, contas de cubo, contas personalizadas, contas LR, contas de métrica e contas modeladas.
Permissões obrigatórias para invocar	Nenhum (devem ser credenciais válidas para a instância)
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém uma etiqueta de credenciais para identificar e autorizar o usuário que faz a chamada e uma etiqueta "incluir" para indicar se a resposta deve incluir informações sobre a importabilidade das contas em uma versão específica. Depois de verificado, o método retorna um documento XML que descreve o conjunto completo de contas no sistema. As contas são retornadas em formato de árvore aninhada, com uma etiqueta de conta incluindo outra se a conta representada pela etiqueta de inclusão é pai da conta incluída.

Formato da solicitação


<?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 de credenciais
Nome da etiqueta		credenciais
Descrição		Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
login	S	O nome de logon do usuário que invoca o método de API. Esse usuário deve ter as permissões necessárias para invocar o método.	sampleuser@company.com
senha	S	A senha do usuário que invoca o método de API.	my_password
parâmetros regionais	N	Especifique os parâmetros regionais a serem usados para interpretar números e datas de entrada e para formatar números e datas de saída (usando o separador de milhares, nomes de meses e formatação de data adequados). Os parâmetros regionais também são usados para especificar o idioma em que as mensagens do sistema na resposta devem ser exibidas. Se não especificado, en_US (inglês americano) é usado.	fr_FR
instanceCode	N	Se o usuário especificado nas credenciais tem acesso a mais de uma instância do Adaptive Planning , esse atributo pode ser usado para especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não for especificada, a instância por padrão do usuário será usada. Para determinar os códigos de instância disponíveis, use a API exportInstances.	MYINSTANCE1
Conteúdo do elemento
(nenhum)

incluir elemento
Nome da etiqueta		incluir
Descrição		Representa um conjunto de indicadores que indicam quais aspectos das informações das contas devem ser incluídos ou excluídos da resposta. Esse elemento é opcional: se não estiver presente, a API retornará informações da conta para todas as versões e não incluirá o atributo isImportable.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
versionName Atualizado na API v18	N	Indica se a resposta deve incluir o atributo isImportable na resposta de cada conta, indicando se a conta pode aceitar dados importados para a versão especificada. O valor por padrão, se esse elemento ou seu atributo não estiver presente, é não emitir nenhum atributo isImportable na resposta. Se os atributos versionName e versionID são especificados neste elemento, versionID é ignorado. Ao especificar uma versão, a chamada será bem-sucedida somente se o usuário tiver acesso à versão.	Orçamento de 2016
versionID Atualizado na API v18	N	Igual a versionName (acima), exceto que usa um número de ID de versão interna como parâmetro. Indica se a resposta deve incluir o atributo isImportable na resposta de cada conta, indicando se a conta pode aceitar dados importados para a versão especificada. Ao especificar uma versão, a chamada será bem-sucedida somente se o usuário tiver acesso à versão.	102
atributos	N	Indica se a resposta deve incluir os atributos na resposta de cada conta.	false
inacessívelValores	N	Indica se a resposta deve incluir valores inacessíveis ao usuário atual. O valor por padrão é falso. Somente usuários com as permissões "Modelagem" ou "Importar para todos os níveis" podem definir essa opção como verdadeira.	false
showAccountGroupCodes Atualizado na API v38	N	Essa opção está disponível a partir da API v38. O valor por padrão é falso. Se definida como verdadeira, inclui códigos de grupo de contas na resposta, reutilizando o atributo "código" do elemento de resposta da conta, que anteriormente estaria vazio.	verdadeiro
includeAttributeValueNames Atualizado na API v37	N	Essa opção está disponível a partir da API v37. O valor por padrão é falso. Se definida como verdadeira, os nomes dos valores de atributo serão incluídos na resposta.
includeAttributeValueDisplayNames Atualizado na API v37	N	Essa opção está disponível a partir da API v37. O valor por padrão é falso. Se definida como verdadeira, os nomes de exibição dos valores de atributo serão incluídos na resposta.
Conteúdo do elemento
(nenhum)

elemento de planilha
Nome da etiqueta		planilha
Descrição		Representa uma planilha em que somente as contas disponíveis para essa planilha devem ser incluídas na resposta. Esse elemento é opcional: se não estiver presente, a API retornará informações da conta independentemente de uma planilha específica.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno da planilha.	234
Conteúdo do elemento
(nenhum)

Formato da resposta


<?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 de resposta
Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	Verdadeiro ou falso, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso na resposta.	verdadeiro
obsoleto	N	Se presente na etiqueta de resposta e definido como verdadeiro, esse atributo indica que a versão do método ou da API que está sendo invocada se tornou obsoleta e está oficialmente obsoleta. Embora continue a funcionar neste momento, pode deixar de funcionar em breve. Normalmente, esse atributo não está presente.	false
Conteúdo do elemento
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório.

elemento de saída
Nome da etiqueta	saída
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de contas. Esse invólucro de saída é padrão em todas as respostas de API e inclui a saída válida de qualquer chamada de API bem-sucedida.

elemento de contas
Nome da etiqueta		contas
Descrição		Contêiner para um ou mais elementos de conta.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
seqNo Adicionado na API v17, mas reservado para uso futuro.
Conteúdo do elemento
Um ou mais elementos de conta.

elemento de conta
Nome da etiqueta		account
Descrição		Representa uma única conta que está sendo retornada em resposta a uma chamada à API exportAccounts. Se esse elemento está diretamente dentro do elemento de contas da resposta (ou seja, não está dentro de outro elemento de conta), esse elemento de conta representa uma conta raiz, uma conta que não tem pai.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor			Exemplo
nome	S	O nome da conta, como aparece em relatórios e planilhas.			Ativos atuais
código	S	O código da conta, conforme aparece quando referenciado em fórmulas.			Cur_Assets
ID	N	O número de ID do sistema interno da conta. Isso pode ser usado para identificar contas em outras chamadas de API, como exportDimensionFamilies.			16
accountTypeCode	N	O código de letras correspondente ao tipo de dados desta conta
		Código de tipo	Tipo de conta	Classe da conta
		A	Ativo	Livro-razão geral
		B	Ativo atual	Livro-razão geral
		C	Passivo e patrimônio líquido	Livro-razão geral
		CUBE	Cubo	Cubo
		PT	Perda/Ganhos acumulados no ano	Livro-razão geral
		F	Ativo fixo	Livro-razão geral
		G	Custo de mercadorias vendidas	Livro-razão geral
		I	Receita	Livro-razão geral
		J	Receita não operacional	Livro-razão geral
		K	Ajuste cumulativo de conversão	Sistema
		L	Passivo	Livro-razão geral
		M	Passivo atual	Livro-razão geral
		MI	Percentuais de consolidação	Predefinido
		MT	Métrica	Métrica
		N	Renda líquida	Livro-razão geral
		O	Outros ativos	Livro-razão geral
		Q	Patrimônio líquido	Livro-razão geral
		R	Ativo de longo prazo	Livro-razão geral
		S	Suposição	Suposição
		Cam	Passivo de longo prazo	Livro-razão geral
		W	Modelada	Modelada
		X	Despesa	Livro-razão geral
		XR	Taxa cambial	Predefinido
		S	Despesas não operacionais	Livro-razão geral
		Z	Personalizado	Personalizado

descrição	N	A descrição textual da conta, se houver, conforme inserida em Administração de conta	Total de ativos atuais
shortName	N	O nome curto da conta, se houver, conforme inserido em Administração de conta	CA
timeStratum Com suporte na API v16 +	N	O estrato de tempo da conta, como o código do estrato de tempo. Para contas de cubo, contas modeladas e contas LR com entrada de dados no cubo, o estrato de tempo é determinado pelo estrato de tempo da planilha proprietária. Todas as outras contas usam o estrato de tempo por padrão definido na interface de usuário de administração de tempo.	Mês
displayAs	N	A configuração de exibição de saída da conta: NÚMERO, MOEDA ou PERCENTUAL. Fornecido somente para contas que têm uma propriedade Exibir como em Administração de conta.	NUMBER
isAssunção	N	"0" ou "1" indicando se a conta é uma suposição. É definido como 1 para suposições e contas de taxa cambial.	1
suppressZeroes	N	Sinalizador que indica se a conta permite ou não aos usuários suprimir zeros nas planilhas. 0 não é permitido, 1 é permitido. Fornecido somente para contas que têm a propriedade Suprimir zeros em Administração de conta.	1
isDefaultRoot	N	"0" ou "1" indicando se a conta ou o grupo de contas é uma raiz por padrão.	1
decimalPrecision	N	Número de casas decimais a serem exibidas para os números nesta conta. O valor por padrão é 0. O valor especial de 99 é usado para indicar uma conta vinculada que herda a precisão decimal de seu destino. O valor -1 significa que a conta é uma conta em moeda e usa a precisão da moeda que está exibindo.	0
planBy	N	Para contas cumulativas, indica se a conta é planejada por saldo (SALDO) ou planejada por delta (DELTA).	SALDO
exchangeRateType	N	Presente somente para contas com displayAs="CURENCY". Valores possíveis: qualquer um dos códigos de tipo de taxa cambial presentes na instância, conforme configurado em Gerenciar moedas. "A"=Média mensal, "E"=Fim do mês.	E
isImportable	N	Indica se a conta pode aceitar dados importados. 0 significa que a conta não pode ser importada e 1 é importável. Presente somente se versionName ou versionId é especificado na solicitação. Observação: isImportable indica apenas que uma conta está disponível para importação na versão especificada, não que o usuário que faz a chamada à API tem permissão para importar para a versão ou conta. Use exportVersions para ver quais versões estão disponíveis para importação pelo usuário.	1
balanceType	N	Indica o tipo de saldo de uma conta, DÉBITO ou CRÉDITO. Esse atributo fica vazio se a conta não tem um tipo de saldo associado. Somente contas LR têm um tipo de saldo.	DÉBITO
dataEntryType	N	Indica o tipo de entrada de dados de uma conta. STANDARD ou CUBE. Um valor em branco indica que o tipo de entrada de dados não é aplicável a uma conta. Por exemplo, uma conta vinculada ou modelada terá um tipo de entrada de dados em branco.	CUBE
timeRollUp	N	Indica como a conta se comporta quando é consolidada ao longo de um período. Pode ser SUM, WAITTED_AVERAGE, LAST ou AVERAGE. Fica vazio para grupos de contas e contas de métrica.	SUM
timeWeightAcctId	N	Se essa conta tem um timeRollup de WATERGY_AVERAGE, esse será o número da ID do sistema interno da conta de onde os pesos são determinados. Estará vazio se não existir uma conta de ponderação ou se a conta não tiver um timeRollup de Weighted_average.	133
hasSalaryDetail	N	0 ou 1 para indicar se esta conta tem divisões que exigem a permissão Acessar detalhes de salário para serem visualizadas. Estará vazio se não for aplicável a esta conta.	1
dataPrivacy	N	Indica em quais níveis os valores da conta são públicos e podem ser referenciados em outros níveis ao escrever fórmulas. Pode ser PRIVATE para que os valores da conta sejam privados, PUBLIC_TOP para que os valores da conta sejam públicos somente no nível superior ou PUBLIC_ALL para que os valores da conta sejam públicos em todos os níveis. As suposições não têm uma configuração de dataPrivacy porque são sempre públicas.	PRIVADO
subType	N	Indica se a conta é PERIÓDICA ou CUMULATIVA. Se uma conta é periódica, seu valor em um determinado período é igual à atividade líquida do período. Os exemplos incluem contas de receita e despesa. Se uma conta é cumulativa, seu valor é igual ao saldo final de um determinado período. Esse é o valor do período anterior mais ou menos qualquer atividade no período especificado. As contas de balanço patrimonial são cumulativas. Fica vazio para grupos de contas e contas de métrica.	PERIODIC
startExpanded	N	Isso indica se uma conta e seus filhos começam em um estado expandido quando uma planilha é carregada pela primeira vez. Isso se aplica apenas a contas pai. Estará vazio para contas folha.	1
isBreakbackEligible	N	0 ou 1 para indicar se essa conta pode ser usada em uma redistribuição. Isso se aplica apenas a suposições padrão. Estará vazio para outros tipos de contas.	0
levelDimRollup	N	Indica como a conta se comporta quando consolidada em um nível ou dimensão. Pode ser SUM, WAITTED_AVERAGE, TEXT ou NONBLANK_AVERAGE. Fica vazio para grupos de contas e contas de métrica.	NONBLANK_AVERAGE
levelDimWeightAcctId	N	Se essa conta tem um levelDimRollup de WATERED_AVERAGE, esse será o número da ID do sistema interno da conta de onde as ponderações são determinadas. Estará vazio se não existir uma conta de ponderação ou se o nívelDimRollup da conta não for de Weighted_average.	118
rollupText	N	Se essa conta tem um levelDimRollup de TEXT, essa é a cadeia de caracteres de texto que aparece na célula, indicando o valor consolidado da conta.	Nenhuma
enableActuals	N	0 para mostrar somente os dados planejados da conta. 1 para importar valores reais para a conta. Para contas vinculadas, 0 mostrará valores reais somente se a conta vinculada os tiver e 1 habilitará valores reais para a conta vinculada. Fica vazio para grupos de contas e contas de métrica.	1
isGroup	S	0 ou 1 para indicar se este é um grupo de contas ou não.	1
isIntercompany	N	0 ou 1 para indicar se esta conta é uma conta intercompanhias ou não.	1
formula Não disponível na API v18+.	N	A fórmula da conta, se houver uma.	ACCT.Revenue - ACCT.Expenses
isLinked	N	0 ou 1 para indicar se esta conta é uma conta vinculada ou não.	1
isSystem	N	0 ou 1 para indicar se esta conta é uma conta do sistema ou não.	1
owningSheetId	N	Para contas que podem estar em planilhas modeladas e de cubo, o número da ID do sistema interno da planilha em que a conta está. Estará vazio se não for uma conta desse tipo ou se for uma conta, mas não estiver atualmente atribuída a uma planilha.	17
Conteúdo do elemento
Um elemento de conta aninhada para cada conta filho direta desta conta. Um elemento de atributos se a conta tem um ou mais atributos associados a ela.

elemento de atributos
Nome da etiqueta		atributos
Descrição		Contêiner para um ou mais elementos de atributo.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de atributo.

elemento atributo
Nome da etiqueta		atributo
Descrição		Representa um único mapeamento de atributos de conta não em branco ao qual uma conta está associada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome do atributo de conta	Relatório SEC
valor Com suporte na API v34 quando a configuração de Nome de exibição vigente está ATIVADA.	S	O valor do atributo de conta associado à conta.	Sim
valueCode Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34 quando a configuração de Nome de exibição vigente está ATIVADA.	N	O código de valor deste atributo. Para API v32 e API v33, valueCode só é significativo quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1	YR
valueName Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34 quando a configuração de Nome de exibição vigente está ATIVADA.	N	O nome do valor deste atributo. Para API v32 e API v33, valueName só faz sentido quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1	Sim
valueDisplayName Disponível somente na API v32+ para instâncias que habilitam o nome de exibição.	S	Para a API v32 e versões mais recentes, valueDisplayName é significativo somente quando: A configuração Nome de exibição está ATIVADA na instância. displayNameEnabled=1value	Sim
attributeID	S	O número de ID do sistema interno do atributo de conta.	10
valueID	S	O número de ID do sistema interno do atributo de conta.	108
Conteúdo do elemento
nenhum

Especificação de REST customReportValues

exportActiveCurrencies

Este conteúdo foi útil?

O que precisamos melhorar? Informações corretas Responde à minha pergunta Fácil de encontrar Fácil de entender Ajuda a concluir minha tarefa Informações completas e detalhadas

O que precisamos melhorar? Informações incorretas Não responde à minha pergunta Não é fácil de encontrar Não é fácil de entender Não ajuda a concluir minha tarefa Informações incompletas ou pouco detalhadas

Conte-nos sobre a tarefa que você está executando. Quais informações adicionais podem melhorar este conteúdo? Há mais algum detalhe que gostaria de compartilhar?

Nome completo

E-mail

A Workday usará seu nome e e-mail para fornecer respostas relacionadas ao seu feedback. Suas informações serão tratadas de acordo com a nossa Declaração de Privacidade.

Agradecemos seu feedback