exportActiveCurrencies

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 moedas que foram configuradas no sistema.
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 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 o conjunto completo de todas as moedas que foram configuradas no sistema. Uma moeda é "configurada" assim que é adicionada à lista de moedas em Administração de moeda, mesmo que ainda não tenha uma taxa cambial. As instâncias que não têm a funcionalidade Várias moedas habilitada retornam apenas uma única moeda nessa lista.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportActiveCurrencies" 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 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)

Formato da resposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<currencies seqNo="42">
  <currency id="2" code="EUR"  precision="4" isReportingCurrency="0" userDefined="0" description="Euro Member Countries, Euro" />
  <currency id="3" code="EUR1" precision="4" isReportingCurrency="0" userDefined="1" description="User-defined Euro 1" />
  <currency id="1" code="USD" precision="2" isReportingCurrency="1" userDefined="0" description="United States of America, Dollars" />
</currencies>
</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 moedas obrigatório. 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 moedas
Nome da etiqueta		moedas
Descrição		Contêiner para um ou mais elementos de moeda.
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 moeda.

elemento de moeda
Nome da etiqueta		moeda
Descrição		Representa uma única moeda que está sendo retornada em resposta a uma chamada à API exportActiveCurrencies. Para versões anteriores à API v17, ela não mostra o atributo Definida pelo usuário ou as moedas definidas pelo usuário.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número de ID do sistema interno da moeda. Esse número pode ser usado para identificar de forma exclusiva a moeda, mas não é usado em outras chamadas de API.	1
código	S	O código de três letras da moeda, conforme especificado no padrão ISO 4217.	usd
precisão	S	A precisão decimal comum (número de dígitos após a casa decimal) a ser usada na exibição de valores nessa moeda. Essa precisão é usada somente para contas que têm o tipo de exibição Moeda e a precisão decimal definida como "Usar precisão da moeda".	2
isReportingCurrency	S	Se a moeda foi selecionada por um administrador como disponível para uso em "conversões arbitrárias de relatório". True=1, False=0.	1
userDefined Disponível na API v17+	S	Se a moeda foi criada pelo usuário ou não. True=1, False=0.	0
descrição	S	Descrição básica da moeda, que consiste no país e no nome da moeda.	Estados Unidos, Dólar
Conteúdo do elemento
(nenhum)