importTransactions

Adaptive Planning

Documentación de Workday Adaptive Planning (Workday 2025R2)
Integración
Gestión de integración de datos
Documentación de API
Métodos de envío de datos

Última actualización: 2023-06-23

importTransactions

Categoría	Envío de datos
Descripción	Inserta nuevas transacciones.
Permisos obligatorios para invocar	Importar
Parámetros obligatorios bajo petición	Credentials, ImportTransactionsOptions, RowData

Este método solo se aplica si tiene acceso a Transacciones.

Solo puede eliminar transacciones durante la importación. Si desea eliminar todas las transacciones durante la importación, considere la posibilidad de importar una fila en blanco y eliminar los datos restantes.

Este método se puede utilizar para eliminar filas de transacciones existentes que coincidan con determinados criterios, para insertar nuevas filas de transacciones en el sistema o para realizar ambas acciones en una invocación (es decir, sustituir un conjunto de filas de transacciones por otro conjunto de filas).

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="importTransactions" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
 <importTransactionsOptions allowParallel="false" useMappings="false"/>
  <rowData>
    <header>Posting Date|Transaction Type|Account|Plan|Transaction Amount</header>
    <rows>
       <row>01/02/2011|Invoice|70110|Marketing|100</row>
    </rows>
  </rowData>
</call>

Cada invocación de esta llamada API debe contener exactamente un elemento de cada uno de los tipos enumerados:

credenciales

importTransactionsOptions

rowData

Una discrepancia entre el número de caracteres de barra vertical ( | ) de la cabecera y los datos provocará un error para API v30 o superior.

elemento de credenciales
Nombre de etiqueta		credenciales
Descripción		Todas las llamadas API deben contener un solocredentials 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)

importTransactionsOptions element
Nombre de etiqueta		importTransactionsOptions
Descripción		Especifica las opciones que se utilizarán al realizar la importación. Si al menos uno dedeleteStartDate,deleteEndDate, ose especifican transactionTypes, esta llamada de método intentará eliminar cualquier transacción existente que coincida con los criterios especificados.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
deleteStartDate	No	Si esta llamada de método está destinada a eliminar algunas transacciones existentes, este atributo especifica la fecha inicial del conjunto de transacciones que se eliminarán (inclusive). Si no se especifica, todas las transacciones que tengan una fecha igual o anterior a ladeleteEndDate (y que coincida con una de las opciones opcionales especificadas)TransactionTypes) se eliminarán.	11/01/2012
deleteEndDate	No	Si esta llamada de método está destinada a eliminar algunas transacciones existentes, este atributo especifica la fecha final del conjunto de transacciones que se eliminarán (incluida). Si no se especifica, todas las transacciones que tengan una fecha igual o posterior a ladeleteStartDate (y que coincidan con una de las opciones opcionales especificadas)TransactionTypes) se eliminarán.	12/31/2012
transactionTypes	No	Un conjunto de tipos de transacción que se eliminarán, separados por el símbolo de barra vertical. Si no se especifica, todas las transacciones proporcionadas entredeleteStartDate ydeleteEndDate se eliminará. Si nodeleteStartDate odeleteEndDate, se eliminarán todas las transacciones de los tipos especificados independientemente de sus fechas.	Factura\|Orden de compra
allowParallel	Sí	Si se establece entrue, la importación continuará aunque ya haya otra importación de cifras reales o transacciones en curso para esta instancia. Si se establece enfalse, se producirá un error al intentar importar si ya hay una importación de cifras reales o transacciones procesada para esta instancia.	falso
useMappings	No	Especifica si se deben utilizar asignaciones de importación para cuentas, planes y valores de dimensión dentro de los elementos de fila. Consideradotrue por defecto. Sifalse, se deben usar los identificadores internos: las cuentas se identifican por código, los niveles y los valores de dimensión por nombre.	falso
includeContext	No	Especifica si los mensajes pueden incluir el bloque de contexto. Los valores sonfalse (nunca mostrar contexto) otrue (muestre el contexto si procede). Si no se especifica,se asume verdadero.	falso
displayNameEnabled Solo está disponible en API v31+ para instancias que activan el nombre de visualización.	No	displayNameEnabled=true indica que la API debe esperar las columnas Código de cuenta, Código de nivel, Código de dimensión y Nombre de dimensión en la carga útil cuando el parámetro Activar nombre de visualización está activado para la instancia. displayNameEnabled=false indica que la API debe continuar siguiendo el contrato de API anterior a la v30 aunque el parámetro Activar nombre de visualización esté activado para la instancia. El valor por defecto de displayNameEnabled es "false".	falso
Contenido del elemento
(ninguno)

elemento rowData
Nombre de etiqueta		rowData
Descripción		Contenedor de las filas de datos que se van a importar.
Atributos del elemento
(ninguno)
Contenido del elemento
Exactamente unoelemento de cabecera y exactamente unoelemento de filas

elemento de cabecera
Nombre de etiqueta		cabecera
Descripción		Especifica los nombres y el orden de las columnas de los datos en el correspondienteelemento de filas
Atributos del elemento
(ninguno)
Contenido del elemento
Una línea de texto con nombres de columnas separados por barras verticales. Estos nombres de columna deben corresponderse con los nombres de las dimensiones o los campos de la hoja, o con los meses que pueden contener datos. Son idénticos a los nombres de columna que se encuentran en la plantilla de importación de la hoja a la que se importan los datos, con cada cabecera de columna separada de la siguiente por una barra vertical o un símbolo de barra vertical. En las instancias que activan Nombre de visualización, la cabecera no admite "<dimension>" en combinación con "<dimension> Name" o "<dimension> Code" en API v30 o superior para configuraciones regionales admitidas por Adaptive Planning.

elemento de filas
Nombre de etiqueta		filas
Descripción		Contenedor para uno o varioselementos de fila
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varioselementos de fila

elemento de fila
Nombre de etiqueta		fila
Descripción		Se están importando los datos de una sola fila.
Atributos del elemento
(ninguno)
Contenido del elemento
Los datos de los campos de una sola fila que se están importando, el valor de cada campo separado por una barra vertical o un símbolo de barra vertical. Los campos de datos deben estar en el mismo orden que la línea del elemento de cabecera. Si los números de los valores utilizan separadores de miles, se supone que son los separadores de coma utilizados en la configuración regional especificada en las credenciales de la solicitud.

Formato de respuesta

Estos son ejemplos de respuestas para la importación correcta y no correcta de datos de transacciones.

Ejemplo de éxito


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <messages>
       <message key="row-imported">1 row was imported.</message>
   </messages>
</response>

Error (con contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</message>
       <message key="import-detail">Additional information:</message>
       <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Transaction Type do not exist: Invoice12.</message>
       <message key="invalid-dimension-choice-withCoordinate">
           <context>
               <col header="Posting Date" value="01/02/2011" />
               <col header="Transaction Type" value="Invoice12" />
               <col header="Account" value="70110" />
               <col header="Plan" value="Marketing" />
               <col header="Transaction Amount" value="100.0" />
     
           </context>
     Invalid Dimension Choice: Invoice12 on row 1 column B
   
       </message>
     </messages>
</response>

Error (sin contexto)


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</message>
       <message key="import-detail">Additional information:</message>
       <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Transaction Type do not exist: Invoice12.</message>
       <message key="invalid-dimension-choice-withCoordinate">Invalid Dimension Choice: Invoice12 on row 1 column B</message>
     </messages>
</response>

elemento de respuesta
Nombre de etiqueta		respuesta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	Cualquieraverdadero ofalse, 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
Contenido del elemento
Un solo opcionalelemento de mensajes

elemento de mensajes
Nombre de etiqueta		mensajes
Descripción		Contenedor para uno o varioselementos de mensaje
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varioselementos de mensaje

elemento de mensaje
Nombre de etiqueta		mensaje
Descripción		Representa un mensaje que se envía desde el sistema a la persona que llama. Los mensajes se utilizan para los mensajes de error cuando las solicitudes no se realizan correctamente, para los mensajes de aviso cuando las solicitudes se realizan correctamente y para los mensajes de confirmación cuando se realizan correctamente.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
clave	No	Cuando se proporciona, una clave es una forma de identificar un mensaje o tipo de mensaje concreto, lo que resulta útil para el registro de errores automatizado y la recuperación en los programas cliente. Las claves no cambian en las distintas configuraciones regionales de las solicitudes, aunque cambie el idioma del mensaje. Tampoco es probable que las claves cambien en el futuro debido a ajustes de redacción o cambios de terminología.	ID de valor de atributo no válido
Contenido del elemento
El texto del mensaje. Este texto está en el idioma de la configuración regional especificada en la solicitud (suponiendo que la configuración regional sea compatible). El texto también puede contener información variable, como el número de filas que se han procesado o la columna o el valor concretos que han provocado el error. Un elemento de contexto opcional.

elemento de contexto
Nombre de etiqueta		contexto
Descripción		Contenedor para uno o varios elementos de columna.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ninguno
Contenido del elemento
Uno o varios elementos col.

elemento col
Nombre de etiqueta		col
Descripción		Representa el contexto del mensaje. Proporciona un par de cabecera/valor para que se pueda identificar la fila que genera el mensaje.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
cabecera	Sí	La cabecera de la columna.	"Cuenta"
valor	Sí	El valor de la columna.	"GL-29482-38233"
Contenido del elemento
(ninguno)

importStandardData

eraseActuals

¿Ha resultado útil?

¿Qué requiere nuestra atención? Es correcta Responde a mi pregunta Fácil de encontrar Fácil de entender Me ayuda a completar mi tarea Es completa y detallada

¿Qué requiere nuestra atención? No es correcta No responde a mi pregunta No es fácil de encontrar No es fácil de entender No me ayuda a completar mi tarea Es incompleta o poco detallada

Díganos la tarea que está realizando. ¿Qué información adicional podría mejorar este contenido? ¿Algún detalle adicional que quiera compartir?

Nombre y apellidos

Correo electrónico

Workday utilizará su nombre y correo electrónico para proporcionarle respuestas relacionadas con sus comentarios. Su información se tratará de acuerdo con nuestra Declaración de privacidad.

Gracias por el feedback