exportAccounts

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 creación, actualización y lectura de metadatos y datos

Última actualización: 2023-06-23

exportAccounts

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 cuentas del sistema, incluidos todos los tipos de cuenta: supuestos, cuentas de cubo, cuentas personalizadas, cuentas de libro mayor, cuentas de métrica y cuentas modeladas.
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 contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama y una etiqueta "incluir" para indicar si la respuesta debe incluir información sobre la importabilidad de las cuentas en una versión concreta. Una vez verificado, el método devuelve un documento XML que describe el conjunto completo de cuentas del sistema. Las cuentas se devuelven en forma de árbol anidado, con una etiqueta de cuenta que encierra a otra si la cuenta representada por la etiqueta envolvente es una cuenta principal de la cuenta adjunta.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportAccounts" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_pwd"/>
  <include versionName="sample version"/>
  <sheet id="3" />
</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)

incluir elemento
Nombre de etiqueta		incluir
Descripción		Representa un conjunto de indicadores que indican qué aspectos de la información de las cuentas deben incluirse o excluirse de la respuesta. Este elemento es opcional: si no está presente, la API devolverá la información de cuenta para todas las versiones y no incluirá el atributo isImportable.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
versionName Actualizado en API v18	No	Indica si la respuesta debe incluir el atributo isImportable en la respuesta de cada cuenta, lo que indica si la cuenta puede aceptar datos importados para la versión especificada. El valor por defecto, si este elemento o su atributo no está presente, es no emitir ningún atributo isImportable en la respuesta. Si se especifican los atributos versionName y versionID en este elemento, se ignora el valor de versionID. Al especificar una versión, la llamada solo se realizará correctamente si el usuario tiene acceso a la versión.	Presupuesto 2016
versionID Actualizado en API v18	No	Igual que versionName (anterior), excepto que toma un número de ID de versión interno como parámetro. Indica si la respuesta debe incluir el atributo isImportable en la respuesta de cada cuenta, lo que indica si la cuenta puede aceptar datos importados para la versión especificada. Al especificar una versión, la llamada solo se realizará correctamente si el usuario tiene acceso a la versión.	102
atributos	No	Indica si la respuesta debe incluir los atributos de la respuesta para cada cuenta.	falso
inaccessibleValues	No	Indica si la respuesta debe incluir valores inaccesibles para el usuario actual. El valor por defecto es falso. Solo los usuarios con los permisos "Modelado" o "Importar a todos los niveles" pueden definir esta opción como verdadera.	falso
showAccountGroupCodes Actualizado en API v38	No	Esta opción está disponible a partir de API v38. El valor por defecto es falso. Si se establece en verdadero, incluye códigos de grupo de cuentas en respuesta reutilizando el atributo "code" del elemento de respuesta de cuenta, que anteriormente habría estado vacío.	verdadero
includeAttributeValueNames Actualizado en API v37	No	Esta opción está disponible a partir de API v37. El valor por defecto es falso. Si se establece en verdadero, los nombres de los valores de atributo se incluirán en la respuesta.
includeAttributeValueDisplayNames Actualizado en API v37	No	Esta opción está disponible a partir de API v37. El valor por defecto es falso. Si se establece en verdadero, los nombres de visualización de los valores de atributo se incluirán en la respuesta.
Contenido del elemento
(ninguno)

elemento de hoja
Nombre de etiqueta		hoja
Descripción		Representa una hoja en la que solo se deben incluir en la respuesta las cuentas disponibles para esa hoja. Este elemento es opcional: si no está presente, la API devolverá información de cuenta independiente de una hoja en particular.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno de la hoja.	234
Contenido del elemento
(ninguno)

Formato de respuesta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <accounts seqNo="42">
     <account id="2147483645" code="" name="GL Accounts" description="GL Accounts" timeStratum="" displayAs="NUMBER"
     accountTypeCode="" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1" shortName=""
     balanceType="" isLinked="0" owningSheetId="" isSystem="0" isIntercompany="0" isImportable="0" dataEntryType=""
     planBy="" timeRollup="" timeWeightAcctId="" levelDimRollup="" levelDimWeightAcctId="" rollupText="" startExpanded="1"
     hasSalaryDetail="" dataPrivacy="" isBreakbackEligible="" subType="" enableActuals="" isGroup="1">
       <account id="1" code="Assets" name="Assets" description="Total Assets" timeStratum="month" displayAs="CURRENCY"
       accountTypeCode="A" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1"
       shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0" owningSheetId=""
       isSystem="0" isIntercompany="0" dataEntryType="" planBy="DELTA" timeRollup="LAST" timeWeightAcctId=""
       levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="1" hasSalaryDetail=""
       dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="1" isGroup="0">
         <account id="16" code="Current_Assets" name="Current Assets" description="current assets" timeStratum="month"
       displayAs="CURRENCY" accountTypeCode="B" decimalPrecision="0" isAssumption="0" suppressZeroes="1"
       isDefaultRoot="1" shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0"
       owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="" planBy="DELTA" timeRollup="LAST"
       timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="1"
       hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="1"
       isGroup="0">
           <account id="51" code="70110" name="Bank Account" description="Wells Fargo account" timeStratum="month"
       displayAs="CURRENCY" accountTypeCode="B" decimalPrecision="0" isAssumption="0" suppressZeroes="1"
       isDefaultRoot="0" shortName="" exchangeRateType="E" balanceType="DEBIT" isLinked="0"
       owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="STANDARD" planBy="BALANCE"
       timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText=""
       startExpanded="" hasSalaryDetail="0" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE"
       enableActuals="1" isGroup="0">
             <attributes>
               <attribute name="SEC Reporting" value="Yes" />
               <attribute name="GAAP Reporting" value="No" />
             </attributes>
           </account>
         </account>
       </account>
     </account>
   </accounts>
 </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 solo elemento de cuentas 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 cuentas
Nombre de etiqueta		cuentas
Descripción		Contenedor para uno o varios elementos de cuenta.
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 cuenta

elemento de cuenta
Nombre de etiqueta		cuenta
Descripción		Representa una sola cuenta que se devuelve en la respuesta a una llamada a la API exportAccounts. Si este elemento está directamente dentro del elemento de cuentas adjunto de la respuesta (es decir, no está incluido dentro de otro elemento de cuenta), este elemento de cuenta representa una cuenta raíz, una cuenta que no tiene principal.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor			Ejemplo
nombre	Sí	El nombre de la cuenta, tal como aparece en informes y hojas.			Activo corriente
código	Sí	El código de la cuenta, tal como aparece cuando se hace referencia a ella en las fórmulas.			Cur_Assets
ID	No	El número de ID de sistema interno de la cuenta. Esto se puede usar para identificar cuentas en otras llamadas API, como exportDimensionFamilies.			16
accountTypeCode	No	El código de letra correspondiente al tipo de datos de esta cuenta
		Código de tipo	Tipo de cuenta	Clase de cuenta
		A	Activo	Libro mayor
		B	Activo corriente	Libro mayor
		C	Pasivo y patrimonio neto	Libro mayor
		CUBE	Cubo	Cubo
		ES	Acumulado anual de ganancias/pérdidas	Libro mayor
		F	Activo fijo	Libro mayor
		G	Coste de ventas	Libro mayor
		I	Income	Libro mayor
		J	Ingresos no operativos	Libro mayor
		K	Ajuste acumulado por conversión (CTA)	Sistema
		L	Pasivo	Libro mayor
		M	Pasivo corriente	Libro mayor
		MI	Porcentajes de consolidación	Predefinido
		MT	Métrica	Métrica
		No	Ingresos netos	Libro mayor
		O	Otro activo	Libro mayor
		Q	Patrimonio neto	Libro mayor
		R	Activo a largo plazo	Libro mayor
		S	Supuesto	Supuesto
		T	Pasivo a largo plazo	Libro mayor
		W	Modelada	Modelada
		X	Gasto	Libro mayor
		XR	Tipo de cambio	Predefinido
		Sí	Gastos no operativos	Libro mayor
		Z	Personalizado	Personalizado

descripción	No	La descripción textual de la cuenta, si la hay, tal como se ha introducido en Administración de cuentas	Total de activos corrientes
shortName	No	El nombre corto de la cuenta, si lo hay, tal como se ha introducido en Administración de cuentas	CA
timeStratum Compatible con API v16 +	No	El estrato temporal de la cuenta, como el código del estrato temporal. En el caso de las cuentas de cubo, las cuentas modeladas y las cuentas de libro mayor de cubo específicas, el estrato temporal viene determinado por el estrato temporal de la hoja propietaria. Todas las demás cuentas utilizan el estrato temporal por defecto definido en la interfaz de usuario de administración de tiempo.	Mes
displayAs	No	La configuración de visualización de salida de la cuenta: NUMBER, CURRENCY o PERCENT. Solo se proporciona para cuentas que tienen una propiedad Mostrar como en Administración de cuentas.	NUMBER
esAsunción	No	"0" o "1", que indica si la cuenta es un supuesto. Se establece en 1 para supuestos y cuentas de tipo de cambio.	1
suprimirCeros	No	Marca que indica si la cuenta permite a los usuarios suprimir ceros en las hojas o no. 0 no está permitido, 1 está permitido. Solo se proporciona para cuentas que tienen una propiedad Supresión de ceros en Administración de cuentas.	1
isDefaultRoot	No	"0" o "1", que indica si la cuenta o el grupo de cuentas es una cuenta raíz por defecto.	1
decimalPrecision	No	Número de decimales que se mostrarán para los números de esta cuenta. El valor por defecto es 0. El valor especial de 99 se utiliza para indicar una cuenta vinculada que hereda la precisión decimal de su destino. Un valor de -1 significa que la cuenta es una cuenta de moneda y utiliza la precisión de la moneda que se muestra.	0
planBy	No	En el caso de las cuentas acumulativas, indica si la cuenta es un plan por saldo (BALANCE) o un plan por delta (DELTA).	SALDO
exchangeRateType	No	Solo presente para cuentas con displayAs="CURERENCY". Valores posibles: cualquiera de los códigos de tipo de tipo de cambio presentes en la instancia, según lo configurado en Gestión de monedas. "A"=Promedio mensual, "E"=Final de mes.	E
isImportable	No	Indica si la cuenta puede aceptar datos importados. 0 significa que la cuenta no se puede importar y 1 sí. Solo está presente si se especifica versionName o versionId en la solicitud. Nota: isImportable solo indica que una cuenta está disponible para importar en la versión especificada, no que el usuario que realiza la llamada a la API tenga permiso para importar a la versión o cuenta. Utilice exportVersions para ver qué versiones están disponibles para que el usuario las importe.	1
balanceType	No	Indica el tipo de saldo de una cuenta, DEBE o HABER. Este atributo está vacío si la cuenta no tiene un tipo de saldo asociado. Solo las cuentas de libro mayor tienen un tipo de saldo.	CARGO
dataEntryType	No	Indica el tipo de entrada de datos de una cuenta. STANDARD o CUBE. Un valor en blanco indica que el tipo de entrada de datos no es aplicable a una cuenta. Por ejemplo, una cuenta vinculada o una cuenta modelada tendrán un tipo de entrada de datos en blanco.	CUBE
timeRollUp	No	Indica cómo se comporta la cuenta cuando se agrupa en un periodo temporal. Puede ser SUM, WEIGHTED_AVERAGE, LAST o AVERAGE. Estará vacío para los grupos de cuentas y las cuentas de métrica.	SUM
timeWeightAcctId	No	Si esta cuenta tiene un timeRollup de WEIGHTED_AVERAGE, este será el número de ID de sistema interno de la cuenta a partir de la cual se determinan las ponderaciones. Estará vacío si no existe ninguna cuenta de ponderación o si la cuenta no tiene un timeRollup de WEIGHTED_AVERAGE.	133
hasSalaryDetail	No	0 o 1 para indicar si esta cuenta tiene divisiones que requieren el permiso Acceder a detalles salariales para poder consultarse. Estará vacío si no es aplicable a esta cuenta.	1
dataPrivacy	No	Indica en qué niveles los valores de la cuenta son públicos y se puede hacer referencia a ellos en otros niveles al escribir fórmulas. Puede ser PRIVATE para que los valores de la cuenta sean privados, PUBLIC_TOP para que los valores de la cuenta sean públicos solo en el nivel superior o PUBLIC_ALL para que los valores de la cuenta sean públicos en todos los niveles. Los supuestos no tienen un parámetro dataPrivacy porque siempre son públicos.	PRIVADO
subType	No	Indica si la cuenta es PERIODIC o ACUMULATIVE. Si una cuenta es periódica, su valor en un periodo temporal determinado es igual a la actividad neta del periodo temporal. Los ejemplos incluyen cuentas de ingresos y gastos. Si una cuenta es acumulativa, su valor es igual al saldo final de un periodo temporal determinado. Este es el valor del periodo temporal anterior más o menos cualquier actividad en el periodo temporal especificado. Las cuentas de balance son acumulativas. Estará vacío para los grupos de cuentas y las cuentas de métrica.	PERIODIC
startExpanded	No	Esto indica si una cuenta y sus cuentas secundarias comienzan con un estado expandido al cargar una hoja por primera vez. Esto solo se aplica a las cuentas principales. Estará vacío para las cuentas hoja.	1
isBreakbackEligible	No	0 o 1 para indicar si esta cuenta se puede utilizar en una retrotracción. Esto solo se aplica a los supuestos estándar. Estará vacía para otros tipos de cuentas.	0
levelDimRollup	No	Indica cómo se comporta la cuenta cuando se agrupa en un nivel o dimensión. Puede ser SUM, WEIGHTED_AVERAGE, TEXT o NONBLANK_AVERAGE. Estará vacío para los grupos de cuentas y las cuentas de métrica.	NONBLANK_AVERAGE
levelDimWeightAcctId	No	Si esta cuenta tiene un levelDimRollup de WEIGHTED_AVERAGE, este será el número de ID de sistema interno de la cuenta a partir de la cual se determinan las ponderaciones. Estará vacío si no existe ninguna cuenta de ponderación o si el valor de levelDimRollup de la cuenta no es WEIGHTED_AVERAGE.	118
rollupText	No	Si esta cuenta tiene un levelDimRollup de TEXT, esta es la cadena de texto que aparecerá en la celda que indica el valor agrupado de la cuenta.	Ninguno
enableActuals	No	0 para mostrar solo los datos de plan de la cuenta. 1 para importar cifras reales a la cuenta. Para las cuentas vinculadas, 0 solo mostrará las cifras reales si la cuenta vinculada las tiene, y 1 activará las cifras reales para la cuenta vinculada. Estará vacío para los grupos de cuentas y las cuentas de métrica.	1
isGroup	Sí	0 o 1 para indicar si se trata de un grupo de cuentas o no.	1
isIntercompany	No	0 o 1 para indicar si esta cuenta es una cuenta interempresa o no.	1
formula No disponible en API v18+.	No	La fórmula de la cuenta, si la tiene.	ACCT.Revenue - ACCT.Expenses
isLinked	No	0 o 1 para indicar si esta cuenta es una cuenta vinculada o no.	1
isSystem	No	0 o 1 para indicar si esta cuenta es una cuenta de sistema o no.	1
owningSheetId	No	En el caso de las cuentas que pueden estar en hojas modeladas y de cubo, el número de ID de sistema interno de la hoja en la que se encuentra esta cuenta. Estará vacía si no es una cuenta de este tipo, o si lo es pero no está asignada actualmente a una hoja.	17
Contenido del elemento
Un elemento de cuenta anidado para cada cuenta secundaria directa de esta cuenta. Un elemento de atributos si la cuenta tiene uno o más atributos asociados.

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

elemento de atributo
Nombre de etiqueta		atributo
Descripción		Representa una única asignación de atributo de cuenta que no está en blanco a la que está asociada una cuenta.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre del atributo de cuenta	Informes SEC
valor Se admite en API v34 cuando el parámetro Nombre de visualización efectivo está activado.	Sí	El valor del atributo de cuenta asociado a la cuenta.	Sí
valueCode Solo está disponible en API v32 y API v33 para instancias que activan el nombre de visualización. No se admite en API v34 cuando el parámetro Nombre de visualización efectivo está activado.	No	El código de valor de atributo para este atributo. Para API v32 y API v33, valueCode solo es significativo cuando: El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1	YR
valueName Solo está disponible en API v32 y API v33 para instancias que activan el nombre de visualización. No se admite en API v34 cuando el parámetro Nombre de visualización efectivo está activado.	No	El nombre de valor de atributo para este atributo. Para API v32 y API v33, valueName solo es significativo cuando: El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1	Sí
valueDisplayName Solo está disponible en API v32+ para instancias que activan el nombre de visualización.	Sí	Para API v32 y posteriores, valueDisplayName solo es significativo cuando: El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1value	Sí
attributeID	Sí	El número de ID de sistema interno del atributo de cuenta.	10
valueID	Sí	El número de ID de sistema interno del atributo de cuenta.	108
Contenido del elemento
ninguno

Especificación de REST customReportValues

exportActiveCurrencies

¿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