exportActiveCurrencies

Esta API solo admite usuarios Concepto: reglas de acceso en API v22 y superior.

Categoría	Metadata retrieval
Descripción	Devuelve los metadatos de la lista completa de todas las monedas que se han configurado en el sistema.
Permisos obligatorios para invocar	Ninguna (deben ser credenciales válidas para la instancia)
Parámetros obligatorios bajo petición	Credenciales

La solicitud de este método solo contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. Una vez verificado, el método devuelve un documento XML que describe el conjunto completo de todas las monedas que se han configurado en el sistema. Una moneda se ha "configurado" una vez que se ha añadido a la lista de monedas en Administración de moneda, aunque todavía no tenga un tipo de cambio. Las instancias que no tienen activada la función Varias monedas devuelven solo una moneda en esta lista.

Formato de solicitud


<?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 credenciales
Nombre de etiqueta		credenciales
Descripción		Todas las llamadas a la API deben contener un único elemento de credenciales para identificar al usuario que invoca la API. A continuación, la llamada a la API se realiza como este usuario (cualquier pista de auditoría o historial de acciones en el sistema mostrará que este usuario ha realizado la acción) y, por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción a fin de que la llamada a la API se lleve a cabo. correcta
Atributos del elemento
Nombre de atributo	¿ Obligatorio ?	Valor	Ejemplo
inicio de sesión	Sí	El nombre de conexión del usuario que invoca el método API. Este usuario debe tener los permisos necesarios para invocar el método.	sampleuser@company.com
contraseña	Sí	La contraseña del usuario que invoca el método API.	my_password
configuración regional	No	Especifique la configuración regional que se utilizará para interpretar los números y las fechas de entrada, y para dar formato a los números y las fechas de salida (utilizando el separador de miles, los nombres de mes y el formato de fecha adecuados). La configuración regional también se utiliza para especificar el idioma en el que deben aparecer los mensajes del sistema en la respuesta. Si no se especifica, se utiliza en_US (inglés americano).	fr_FR
instanceCode	No	Si el usuario especificado en las credenciales tiene acceso a más de una instancia de Adaptive Planning , este atributo se puede utilizar para especificar que el usuario tiene la intención de acceder a una instancia distinta a la instancia por defecto. Si no se especifica, se utilizará la instancia por defecto del usuario. Para determinar los códigos de instancia disponibles, utilice la API exportInstances.	MYINSTANCE1
Contenido del elemento
(ninguno)

Formato de respuesta


<?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 respuesta
Nombre de etiqueta		respuesta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	Verdadero o falso, que indica si la llamada a la API se ha realizado correctamente o no. Incluso las llamadas correctas pueden contener mensajes de aviso en su respuesta.	verdadero
obsoleto	No	Si está presente en la etiqueta de respuesta y se establece en verdadero, este atributo indica que la versión del método o API que se está invocando ha quedado obsoleta y está oficialmente desaprobada. Aunque sigue funcionando en este momento, es posible que deje de funcionar en un breve periodo de tiempo. Normalmente, este atributo no está presente.	falso
Contenido del elemento
Un único elemento de mensajes opcional y exactamente un elemento de resultado obligatorio.

elemento de resultado
Nombre de etiqueta	salida
Atributos del elemento
(ninguno)
Contenido del elemento
Un único elemento de monedas obligatorio. Este contenedor `de salida` es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta.

elemento de monedas
Nombre de etiqueta		monedas
Descripción		Contenedor para uno o varios elementos de moneda.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
seqNo Añadido en API v17, pero reservado para uso futuro.
Contenido del elemento
Uno o varios elementos de moneda

elemento de moneda
Nombre de etiqueta		moneda
Descripción		Representa una moneda única que se devuelve en la respuesta a una llamada a la API exportActiveCurrencies. En las versiones anteriores a la API v17, no se mostrará el atributo Definido por el usuario ni las monedas definidas por el usuario.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno para la moneda. Este número se puede utilizar para identificar de forma exclusiva la moneda, pero no se utiliza en ninguna otra llamada a la API.	1
código	Sí	El código de tres letras de la moneda, tal como se especifica en la norma ISO 4217.	USD
precisión	Sí	La precisión decimal típica (número de dígitos después de la posición decimal) que se utilizará al mostrar importes en esta moneda. Esta precisión solo se utiliza para las cuentas que tienen un tipo de visualización de Moneda y tienen su precisión decimal definida como "Usar precisión de moneda".	2
isReportingCurrency	Sí	Si un administrador ha seleccionado la moneda como disponible para su uso en "conversiones de informes arbitrarios". True=1, False=0.	1
userDefined Disponible en API v17+	Sí	Si el usuario ha creado o no la moneda. True=1, False=0.	0
descripción	Sí	Descripción básica de la moneda, que consta del país de la moneda y su nombre.	Estados Unidos de América, dólar
Contenido del elemento
(ninguno)