updateAccount

Adaptive Planning

updateAccount

Categoría	Modificación de metadatos
Descripción	Actualice una cuenta existente en el sistema. Esta API devuelve un mensaje de error cuando falla la validación o la actualización, o devuelve metadatos de la cuenta actualizada en caso de éxito. Esta API solo admite los siguientes tipos de cuenta: supuesto, cuenta de libro mayor y cuenta personalizada. No admite cuentas vinculadas ni de sistema.
Permisos obligatorios para invocar	Modelo para libro mayor y cuenta personalizada Supuestos para supuestos.
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. El usuario debe tener permiso de Modelo o Supuestos para crear la cuenta. La solicitud XML se valida para cada campo y con respecto a determinada lógica de negocios. Los mensajes de error se devuelven como parte de la respuesta cuando se produce un error en la creación. La operación puede detenerse y mostrarse un mensaje de aviso cuando se detecta una operación de riesgo. La solicitud debe volver a enviarse con el atributo "ignoreWarnings" establecido en 1 para finalizar la actualización de la cuenta.

Formato de solicitud

El esquema de solicitud se proporciona en el formato Relax NG Compact.


default namespace = ""
start =
    element account {
        attribute id { xsd:integer }, #account id
        attribute name { xsd:string { maxLength="2048" minLength="1"} }?, #Non-empty string with a maximum length of 2048 characters.
    attribute code { xsd:string { maxLength="2048" minLength="1"} }?, #Non-empty string with a maximum length of 2048 characters.
    attribute description { xsd:string { maxLength="2048"} }?, #Potentially empty string with a maximum length of 2048 characters.
    attribute shortName { xsd:string { maxLength="64"} }?, #Potentially empty string with a maximum length of 64 characters.
    attribute exchangeRateType { xsd:string }?, #displayAs must be CURRENCY (only if multicurrency is enabled) attribute hasSalaryDetail { string "0" | string "1" }?, #0=No, 1=Yes
    attribute dataPrivacy { string "PRIVATE" | string "PUBLIC_TOP" | string "PUBLIC_ALL" }?,
    attribute isBreakbackEligible { string "0" | string "1" }?, #0=No, 1=Yes
    attribute proceedWithWarnings { string "0" | string "1" }?, #0=No, 1=Yes
    element attributes{
        element attribute{
            attribute attributeId{ xsd:integer },
            attribute valueId{ xsd:integer }
        }* 
    }?
}

Ejemplo


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateAccount" callerName="a string that identifies your client application">
    <credentials login="sampleuser@company.com" password="my_pwd"/>
    <account
        id="48"
        name="Account Name"
        code="Account_Code"
        description="Account Description"
        shortName="Short Name"
        exchangeRateType="A"
        hasSalaryDetail="1"
        dataPrivacy="PRIVATE" >
        <attributes>
            <attribute attributeId="20" valueId="170" />
        </attributes>
    </account>
</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)

elemento de cuenta
Nombre de etiqueta		cuenta
Descripción		Especifica una cuenta para crear.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno de la cuenta. Se puede utilizar para identificar cuentas en otras llamadas a la API, como exportDimensionFamilies.	16
nombre	Sí	El nombre de la cuenta, tal como aparece en informes y hojas.	Activo corriente
código	No	El código de la cuenta, solo caracteres alfanuméricos y guiones bajos. No debe proporcionar un atributo de código para los grupos de cuentas.	Cur_Assets
descripción	No	La descripción textual de la cuenta.	Total de activos corrientes
shortName	No	El nombre corto de la cuenta.	CA
exchangeRateType	No	Solo está presente para instancias con varias monedas activadas y para cuentas con displayAs="CURRENCY". 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
hasSalaryDetail	No	La consulta de divisiones de cuenta requiere permiso de detalles salariales. 0 para no, 1 para sí.	1
dataPrivacy	No	Elija si el valor de cuenta es privado (PRIVATE), público solo en el nivel superior (PUBLIC_TOP) o público en todos los niveles (PUBLIC_ALL). El valor por defecto es PRIVADO.	PRIVADO
isBreakbackEligible	No	Disponible en retrotracción. 0 para no, 1 para sí. Aplicable solo para supuestos.	0
procedaWithWarnings	No	Indica si el usuario desea ignorar los mensajes de aviso y continuar con la operación de actualización: 0 para no, 1 para sí. Si hay avisos y procedaWithWarnings=0, la cuenta no se actualizará. Defina procedaWithWarnings=1 para actualizar la cuenta cuando haya avisos.	1
Contenido del elemento
Un elemento de atributos opcional si desea editar uno o varios atributos de cuenta asociados a la cuenta.

elemento de atributos
Nombre de etiqueta		atributos
Descripción		Contenedor para uno o varios elementos de atributo de cuenta.
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 un elemento de atributo de cuenta.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
attributeID	Sí	El ID del atributo de cuenta que ha generado el sistema.	20
valueID	Sí	El ID exclusivo del valor de atributo de cuenta que ha generado el sistema. Si este valor es 0, este atributo se eliminará de la cuenta.	170
Contenido del elemento
ninguno

Formato de respuesta

Estos son ejemplos de respuestas para la actualización correcta y no correcta de una cuenta.

Ejemplo de éxito


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <messages>
        <message type="WARNING" key="warning-unpublished-changes" values="" accountId="1">You have unpublished changes. 
            Your changes will not be visible every where until it is published.</message>
    </messages>
    <output>
        <accounts>
            <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" formula="" 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">
               <attributes>
                   <attribute
                   name="AP Eligible"
                   attributeId="17"
                   value="Yes"
                   valueId="170" />
               </attributes>
               </account>
        </accounts>
    </output>
</response>

Ejemplo de error


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
    <messages>
       <message type="ERROR" key="invalid-account-id" values="441" accountId="-50">Invalid account id: "-50"</message>
    </messages>
</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
Contenido del elemento
Un único elemento de mensajes opcionales o un único elemento de resultado opcional.

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 mensajes
Nombre de etiqueta	mensajes
Descripción	Contenedor para uno o varios elementos de mensaje.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos 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
tipo	Sí	Tipo es una forma de identificar el tipo de mensaje. Los distintos tipos son INFO, WARNING y ERROR. El tipo ERROR significa que esta solicitud no se ha procesado.	AVISO
clave	Sí	Una clave es una forma de identificar un mensaje o tipo de mensaje en particular, ú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.	Warning-Invalid-Timespan-Start
valores	No	Cuando se proporcionan, los valores representan variables utilizadas en el texto del mensaje.	199,12
parentId	No	Cuando esté disponible, el ID de la cuenta principal de la nueva cuenta que se proporcionó en la solicitud.	50
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.

elemento de cuentas
Nombre de etiqueta	cuentas
Descripción	Contenedor para uno o varios elementos de cuenta.
Atributos del elemento
(ninguno)
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 matriz.

Atributos del elemento

Nombre de atributo

¿Obligatorio?

Valor

Ejemplo

nombre

Sí

El nombre de la cuenta, tal como aparece en informes y hojas.

Actual

Activo

código

El código de la cuenta, solo caracteres alfanuméricos y guiones bajos. No debe proporcionar un atributo de código para los grupos de cuentas.

Cur_Assets

Sí

El número de ID de sistema interno de la cuenta. Se puede utilizar para identificar cuentas en otras llamadas a la API, como exportDimensionFamilies.

accountTypeCode

El código de letra correspondiente a la cuenta de tipo de datos.

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

La descripción textual de la cuenta.

Total

activo corriente

shortName

El nombre corto de la cuenta, si lo hay, tal como se ha introducido en Administración de cuentas.

timeStratum

Compatible con API v16+

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

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

"0" o "1", que indica si la cuenta es un supuesto. Se establece en "1" para supuestos y cuentas de tipo de cambio.

suprimirCeros

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 las cuentas que tienen la propiedad Supresión de ceros en Administración de cuentas.

isDefaultRoot

"0" o "1", que indica si la cuenta o el grupo de cuentas es una cuenta raíz por defecto.

decimalPrecision

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.

planBy

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

Solo está presente para instancias con varias monedas activadas y para cuentas con displayAs="CURRENCY". 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.

isImportable

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.

hasSalaryDetail

La consulta de divisiones de cuenta requiere permiso de detalles salariales. 0 para no, 1 para sí.

balanceType

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

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

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

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

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.

dataPrivacy

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

Indica si la cuenta es PERIODIC o ACUMULATIVE. Si una cuenta es periódica, su valor en un mes determinado es igual a la actividad neta del mes. Los ejemplos incluyen cuentas de ingresos y gastos. Si una cuenta es acumulativa, su valor es igual al saldo final de un mes determinado. Este es el valor del mes anterior más o menos cualquier actividad en el mes dado. Las cuentas de balance son acumulativas. Estará vacío para los grupos de cuentas y las cuentas de métrica.

PERIODIC

startExpanded

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.

isBreakbackEligible

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.

levelDimRollup

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

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

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

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.

isGroup

Sí

0 o 1 para indicar si se trata de un grupo de cuentas o no.

isIntercompany

0 o 1 para indicar si esta cuenta es una cuenta interempresa o no.

formula

La fórmula de la cuenta, si la tiene.

ACCT.Revenue - ACCT.Expenses

isLinked

0 o 1 para indicar si esta cuenta es una cuenta vinculada o no.

isSystem

0 o 1 para indicar si esta cuenta es una cuenta de sistema o no.

owningSheetId

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.

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	Sí	El nombre del atributo de cuenta asociado a la cuenta.	Sí
ID de atributo	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 valor de atributo de cuenta.	108
Contenido del elemento
Ninguno.