exportTransactionDefinition

Categoria	Recuperação de metadados
Descrição	Retorna a definição (colunas disponíveis) das transações na instância.
Permissões obrigatórias para invocar	IMP (importar dados) ou MANAGE_TX (gerenciar a definição do campo da transação)
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém apenas uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. Uma vez verificado, o método retorna um documento XML que descreve a definição de uma transação na instância.

Formato da solicitação


<?xml version="1.0" encoding="UTF-8"?>
<call method="exportTransactionDefinition" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</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 API chamada será bem-sucedida.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
login	S
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 adequado, nomes de meses e formatação de data). 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)

Formato da resposta


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<output>
   <transaction>
     <fields>
       <posting-date name="Posting Date"/>
       <type name="Transaction Type">
         <value id="178" name="Journal Entry"/>
         <value id="179" name="Purchase Order"/>
         <value id="177" name="Invoice"/>
         <value id="180" name="Transaction"/>
       </type>
       <accounts name="Account"/>
       <levels name="Plan"/>
       <dimension id="4" name="Product">
         <value id="48" name="B-2"/>
         <value id="47" name="B-1"/>
         <value id="14" name="A"/>
         <value id="15" name="B-Ste"/>
       </dimension>
       <text-selector id="4" name="Flavor">
         <value id="123" name="Chocolate"/>
         <value id="122" name="Vanilla"/>
       </text-selector>
       <text name="Description"/>
       <number name="Sales Tax"/>
       <date name="Due Date"/>
       <amount name="Transaction Amount"/>
     </fields>
   </transaction>
</output>
</response>

Cada um dos campos de uma transação é definido por um destes elementos:

data de publicação (um)

tipo (um)

contas (uma)

níveis (um)

dimensão (zero ou mais)

seletor de texto (zero ou mais)

texto (zero ou mais)

número (zero ou mais)

data (zero ou mais)

valor (um)

elemento de transação
Nome da etiqueta		transação
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um elemento de campos.

elemento de campos
Nome da etiqueta		fields
Descrição		Contêiner para todos os campos obrigatórios e opcionais.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um elemento para cada um dos campos que cada transação deve ter.

elemento de data de publicação
Nome da etiqueta		data de contabilização
Descrição		A data obrigatória em que a transação foi contabilizada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Cabeçalho impresso deste campo.	Data de contabilização
Conteúdo do elemento
(nenhum)

elemento de tipo
Nome da etiqueta		type
Descrição		O tipo de transação obrigatório
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Cabeçalho impresso deste campo.	Tipo de transação
Conteúdo do elemento
Um ou mais elementos de valor.

elemento de contas
Nome da etiqueta		contas
Descrição		A conta à qual esta transação pertence. Os metadados da conta, incluindo a estrutura hierárquica, podem ser obtidos por uma chamada para exportAccounts.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Cabeçalho impresso deste campo.	Conta
Conteúdo do elemento
(nenhum)

elemento de níveis
Nome da etiqueta		níveis
Descrição		O nível ao qual esta transação pertence. Os metadados de nível, incluindo a estrutura hierárquica, podem ser obtidos por uma chamada para exportLevels.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Cabeçalho impresso deste campo.	level
Conteúdo do elemento
(nenhum)

elemento de dimensão
Nome da etiqueta		dimensão
Descrição		Uma dimensão atribuível a uma transação. Os metadados de dimensão completos, incluindo a estrutura hierárquica, podem ser obtidos por uma chamada separada para exportDimensions.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	Identificador numérico interno para a dimensão.	42
nome	S	Cabeçalho impresso deste campo.	Produto
Conteúdo do elemento
Um ou mais elementos de valor.

elemento de seletor de texto
Nome da etiqueta		seletor de texto
Descrição		Lista personalizada de valores definidos para marcar transações.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	Identificador numérico interno para o seletor de texto.	42
nome	S	Cabeçalho impresso deste campo.	Variante
Conteúdo do elemento
Um ou mais elementos de valor.

elemento de valor
Nome da etiqueta		valor
Descrição		Um dos valores definidos para o tipo, dimensão ou seletor de texto delimitador.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	Identificador numérico interno para o valor.	42
nome	S	Representação impressa do valor.	Fatura
Conteúdo do elemento
(nenhum)

elemento de texto
Nome da etiqueta		texto
Descrição		Texto genérico correspondente a uma transação.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Cabeçalho impresso deste campo.	Descrição
Conteúdo do elemento
(nenhum)

elemento de número
Nome da etiqueta		número
Descrição		Um número genérico atribuído a uma transação.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Cabeçalho impresso deste campo	Imposto sobre vendas
Conteúdo do elemento
(nenhum)

elemento de data
Nome da etiqueta		data
Descrição		Uma data genérica atribuída a uma transação.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Cabeçalho impresso deste campo.	Data de vencimento
Conteúdo do elemento
(nenhum)

elemento de valor
Nome da etiqueta		valor
Descrição		O valor monetário obrigatório para uma transação.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	Cabeçalho impresso deste campo.	Valor da transação
Conteúdo do elemento
(nenhum)