exportTransactionDefinition

Categoría	Metadata retrieval
Descripción	Devuelve la definición (columnas disponibles) de las transacciones de la instancia.
Permisos obligatorios para invocar	IMP (importar datos) o MANAGE_TX (gestionar la definición del campo de transacción)
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 la definición de una transacción en la instancia.

Formato de solicitud


<?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 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 API llamada para realizarla correctamente.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
inicio de sesión	Sí
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 formatear 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>
   <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 uno de los campos de una transacción se define mediante uno de los siguientes elementos:

fecha-de-contabilización (uno)

tipo (uno)

cuentas (una)

niveles (uno)

dimensión (cero o más)

selector de texto (cero o más)

texto (cero o más)

número (cero o más)

fecha (cero o más)

importe (uno)

elemento de transacción
Nombre de etiqueta		transacción
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Un elemento de campos.

elemento de campos
Nombre de etiqueta		campos
Descripción		Contenedor para todos los campos obligatorios y opcionales.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Un elemento para cada uno de los campos que debe tener cada transacción.

elemento de fecha de contabilización
Nombre de etiqueta		fecha-de-contabilización
Descripción		La fecha obligatoria en la que se registró la transacción.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	Cabecera impresa de este campo.	Fecha de contabilización
Contenido del elemento
(ninguno)

elemento de tipo
Nombre de etiqueta		tipo
Descripción		El tipo de transacción obligatorio
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	Cabecera impresa de este campo.	Tipo de transacción
Contenido del elemento
Uno o varios elementos de valor

elemento de cuentas
Nombre de etiqueta		cuentas
Descripción		La cuenta a la que pertenece esta transacción. Los metadatos de la cuenta, incluida la estructura jerárquica, se pueden obtener mediante una llamada a exportAccounts.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	Cabecera impresa de este campo.	Cuenta
Contenido del elemento
(ninguno)

elemento de niveles
Nombre de etiqueta		niveles
Descripción		El nivel al que pertenece esta transacción. Los metadatos de nivel, incluida la estructura jerárquica, se pueden obtener mediante una llamada a exportLevels.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	Cabecera impresa de este campo.	nivel
Contenido del elemento
(ninguno)

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Una dimensión asignable a una transacción. Los metadatos de dimensión completos, incluida su estructura jerárquica, se pueden obtener mediante una llamada independiente a exportDimensions.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Identificador numérico interno de la dimensión.	42
nombre	Sí	Cabecera impresa de este campo.	Producto
Contenido del elemento
Uno o varios elementos de valor

elemento de selector de texto
Nombre de etiqueta		text-selector
Descripción		Lista personalizada de valores definidos para etiquetar transacciones.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Identificador numérico interno para el selector de texto.	42
nombre	Sí	Cabecera impresa de este campo.	Tipo
Contenido del elemento
Uno o varios elementos de valor

elemento de valor
Nombre de etiqueta		valor
Descripción		Uno de los valores definidos para el tipo, la dimensión o el selector de texto envolventes.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Identificador numérico interno para el valor.	42
nombre	Sí	Representación impresa del valor.	Factura
Contenido del elemento
(ninguno)

elemento de texto
Nombre de etiqueta		text
Descripción		Texto genérico correspondiente a una transacción.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	Cabecera impresa de este campo.	Descripción
Contenido del elemento
(ninguno)

elemento de número
Nombre de etiqueta		número
Descripción		Un número genérico asignado a una transacción.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	Cabecera impresa de este campo	Impuesto sobre ventas
Contenido del elemento
(ninguno)

elemento de fecha
Nombre de etiqueta		date
Descripción		Una fecha genérica asignada a una transacción.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	Cabecera impresa de este campo.	Fecha de vencimiento
Contenido del elemento
(ninguno)

elemento de importe
Nombre de etiqueta		importe
Descripción		El importe monetario obligatorio para una transacción.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	Cabecera impresa de este campo.	Importe de transacción
Contenido del elemento
(ninguno)