updateAccounts
Compatible con API v20 +
Categoría
| Modificación de metadatos |
Descripción
| Actualice un conjunto de cuentas de libro mayor existentes o cree nuevas cuentas de libro mayor. Se pueden actualizar varias cuentas con varios valores en una llamada. Si se realiza correctamente, la API devuelve los detalles de las cuentas que se han actualizado o creado. Si la API falla, se devuelve una lista completa de errores y sus causas. |
Permisos obligatorios para invocar
| Modelo y permisos en cada nivel |
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 el "Modelo" Concepto: conjuntos de permisos y el permiso necesario para administrar las cuentas que se están actualizando.
Recomendación: invoque exportAccounts para recuperar
Adaptive Planning
IDs de cuenta necesarios para su solicitud de actualización de cuentas Haga todo lo posible para minimizar el tiempo entre las llamadas a exportAccounts y las solicitudes de updateAccount.HTTP | Descripción |
|---|---|
Method
| Post
|
Content-Type
| text/xml |
Ejemplo de rotación
curl -H "Content-Type: text/xml" -d @C:/temp/updateAccounts.xml -X POST https://api.adaptiveplanning.com/api/v20
contenido de updateAccounts.xml
Formato de solicitud
<?xml version='1.0' encoding='UTF-8'?> <call method="updateAccounts" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <accounts proceedWithWarnings="0"> <account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1" exchangeRateType="E" isIntercompany="0" planBy="DELTA" timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE" subType="CUMULATIVE" enableActuals="1"> <account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1" exchangeRateType="E" isIntercompany="0" planBy="DELTA" timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE" subType="CUMULATIVE" enableActuals="1" propagateToDescendants="1"> <attribute name="SEC Reporting" value="Yes" /> <attribute name="GAAP Reporting" value="No" /> </account> </account> </accounts> </call>
Para cargas útiles grandes, puede publicar archivos XML comprimidos (en zip). Descubra cómo hacerlo aquí.
Se aplican las siguientes condiciones a updateAccounts:
- Las cuentas se identifican para su actualización mediante su número de ID interno.
- Para crear cuentas nuevas, asígneles una propiedad de ID en blanco o que falte.
- Puede mover un elemento existente (no nuevo) para que se convierta en elemento secundario de un elemento nuevo. Al hacerlo, se crea el nuevo elemento y se mueve el elemento existente debajo de él como elemento secundario.
- Para API v31 y posteriores, puede crear una nueva cuenta principal entre una cuenta principal existente y sus cuentas secundarias.
Cambio de principal de cuentas
- updateAccountsse produce un error si el valor de atributo de un atributo secundario no es compatible con el nuevo atributo principal. Ejemplo: el atributo reparentedAccount1 tiene el valor SEC Reporting value=No y no es compatible porque newParentAccount2 el valor SEC Reporting value=Yes.
- updateAccountscorrige los valores de atributo no compatibles para que coincidan con su nuevo principal durante el cambio de principal cuandoproceedWithWarnings=1.
- Las cuentas de cambio de principal no pueden formar una relación cíclica.
- El cambio de principal no está permitido para las cuentas raíz generadas por el sistema:Assets, Liabilities and Equities, Net Income, PL Income, Non-Operating Income, PL COGS, PL Expense, Non-Operating Expenses.
En función de la versión de la API,
updateAccounts
permite crear una nueva cuenta principal entre una cuenta principal existente y sus cuentas secundarias: Cuenta de origen | Traspasado a | API v30 e inferior | API v31 + |
|---|---|---|---|
raíz | raíz | prevenido | prevenido |
raíz | principal | prevenido | prevenido |
raíz | hoja | prevenido | prevenido |
principal | raíz | permitido | permitido |
principal | principal | permitido | permitido |
principal | una hoja existente como primer elemento secundario | prevenido | prevenido |
principal | una hoja existente como no primer elemento secundario | permitido | permitido |
principal | una nueva primera cuenta que es secundaria de una principal existente | prevenido | permitido |
principal | una nueva cuenta que no sea la primera y que sea secundaria de una cuenta principal existente | permitido | permitido |
hoja | raíz | permitido | permitido |
hoja | principal | permitido | permitido |
hoja | una hoja existente como primer elemento secundario | prevenido | prevenido |
hoja | una hoja existente como no primer elemento secundario | permitido | permitido |
hoja | una nueva primera cuenta que es secundaria de una principal existente | prevenido | permitido |
hoja | una nueva cuenta que no sea la primera y que sea secundaria de una cuenta principal existente | permitido | permitido |
hoja | una nueva primera cuenta que es secundaria de una hoja existente | prevenido | prevenido |
hoja | una nueva cuenta que no es la primera y que es secundaria de una hoja existente | permitido | permitido |
Cuenta secundaria hoja
- La primera cuenta secundaria de una cuenta hoja solo puede ser una cuenta nueva. Una cuenta de libro mayor existente no se puede mover debajo de una cuenta de hoja existente.
- Cuando una cuenta obtiene su primer elemento secundario durante el cambio de parentesco, se elimina la asignación de cuenta en Integración > Importar asignaciones de cuenta.
- Al cambiar el principal de las cuentas,balanceTypeysubTypelas propiedades se heredan de su cuenta de libro mayor principal.
Cuentas de cubo y datos introducidos de cubo
- Las cuentas de cubo específicas se pueden cambiar como principal.
- Solo se pueden cambiar los elementos principales de las cuentas sin datos de cubo introducidos en sus subárboles de origen y destino.
- No se puede cambiar el principal de CUBE/MIXED ACCOUNT.
- No se permiten cuentas nuevas en CUBE ACCOUNT. Se permiten nuevas cuentas con una cuenta STANDARD/MIXED ACCOUNT.
Formato de solicitud para crear una nueva cuenta
Para crear una nueva cuenta, incluya su principal por su ID. Por ejemplo, para añadir una nueva cuenta secundaria debajo de la L
ocalAssets
cuenta que tiene id 1441
, puede utilizar:<?xml version='1.0' encoding='UTF-8'?> <call method="updateAccounts" callerName="Steve C"> <credentials login="sampleuser@company.com" password="my_password"/> <accounts> <account id="1441"> <account id="" code="newLocalAssets" name="new Local Assets" description="new local assets account for this area" shortName="" > </account> </account> </accounts> </call>
Este método no cambia nada sobre la cuenta
id 1441
. Crea un nuevo elemento secundario llamado new Local Assets
para id 1441
. Todos los elementos secundarios no mencionados de LocalAssets
pasar al final de la lista de elementos secundarios. Esto es el equivalente a "establecer la cuenta principal" para la nueva cuenta.Gestión de varios cambios de nombre en una sola llamada de updateAccounts
Se pueden realizar varios cambios de nombre de la misma entidad en un sistema remoto entre
updateAccounts
llamadas Los nombres de las entidades del sistema remoto pueden intercambiarse por los mismos ID de entidad. Cuándo updateAccounts
las llamadas tienen lugar después del intercambio de nombre, el updateAccounts
call gestiona estos cambios realizando un seguimiento de los ID en los cambios de nombre. La llamada también puede gestionar la introducción de un nuevo ID que utilice un nombre existente.Para que cada uno de los ejemplos sea correcto, el intercambio completo de IDs debe realizarse con los valores exclusivos.
Ejemplo 1: un simple intercambio de nombres en el sistema remoto.
ID Unique Value New Unique Value 1 AA BB 2 BB AA
Ejemplo 2: una secuencia de 3 cambios de nombre en el sistema remoto.
ID Unique Value New Unique Value 1 AA BB 2 BB CC 3 CC AA
Ejemplo 3: una nueva entidad que utiliza un valor exclusivo existente.
ID Unique Value New Unique Value 4 AA 1 AA BB 2 BB Old BB
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 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 cuentas
| |||
Nombre de etiqueta
| cuentas | ||
Descripción
| Solo se permite una solicitud de elemento de cuentas por carga útil. Contiene uno o varios elementos de cuenta. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
procedaWithWarnings | No | procedaWithWarnings="1" indica que la API de updateAccounts debe ajustar el atributo y las propiedades de la cuenta en función de los cambios de parentesco. procedaWithWarnings="0" indica que la API de updateAccounts no debe ajustar el atributo y las propiedades de la cuenta en función de los cambios de parentesco. Errores de UpdateAccounts con un mensaje que transmite el motivo del error. Por ejemplo, la asignación de atributos dejará de ser válida después del cambio de parentesco. El valor por defecto es 0 si falta. | 1 |
retainExistingOrder Disponible en API v26 + | No | RetainExistingOrder="1" indica que la API de updateAccounts debe ignorar el orden de los elementos en la carga útil XML y se conservará el orden definido existente. RetainExistingOrder="0" indica que la API de updateAccounts debe actualizar el orden de los elementos en función de la posición de la etiqueta en relación con otros elementos del mismo nivel en la carga útil XML. El atributo retainExistingOrder se ignora en las versiones de API anteriores a API v26. El valor por defecto de retainExistingOrder es "0" para v26. Para las versiones de API v27 y posteriores, el valor por defecto de retainExistingOrder es "1". | 1 |
displayNameEnabled
Solo está disponible en API v32+ para instancias que activan el nombre de visualización. | No | displayNameEnabled=1 indica que updateAccounts debe respetar las propiedades de nombre de visualización de code , displayNameType y description cuando Activar nombre de visualización está activado para la instancia.displayNameEnabled=0 indica que la API de updateAccounts debe seguir el contrato de la API anterior a la v32 aunque la opción Activar nombre de visualización esté activada para la instancia. La API updateAccounts ignora las propiedades de nombre de visualización code , displayNameType y description .El valor por defecto de displayNameEnabled es "0". | 1 |
Contenido del elemento
| |||
Contiene uno o varios elementos de cuenta. | |||
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. | 16 |
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 |
nombre
| Sí | El nombre de la cuenta, tal como aparece en informes y hojas.
| Activo corriente |
shortName | No | El nombre corto de la cuenta. | CA |
descripción | No | La descripción textual de la cuenta. La longitud máxima de caracteres es 2048. | Total de activos corrientes |
subType | No | 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. De solo lectura, identificado en función de su cuenta principal. | Acumulativo |
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). El valor por defecto es DELTA. El cambio de planBy a DELTA NO está permitido cuando la cuenta tiene divisiones en versiones no reales. Solo aplicable a cuentas hoja. updateAccounts genera errores cuando el usuario intenta definir planBy para una cuenta que no es de hoja. | DELTA |
actualsBy | No | En el caso de las cuentas acumulativas, indica si la cuenta es de cifras reales por saldo (BALANCE) o de cifras reales por delta (DELTA). El valor por defecto es SALDO. Solo aplicable a cuentas hoja. updateAccounts genera errores cuando el usuario intenta definir realsBy para una cuenta que no es de hoja. | SALDO |
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. La interfaz de usuario de administración del libro mayor de Planning utiliza el término "superposición de cifras reales". El valor por defecto es 0 cuando la cuenta actual es un grupo. El valor por defecto es 1 cuando la cuenta actual es una hoja. | 1 |
balanceType
Actualizado en API v33 | No | Indica el tipo de saldo de una cuenta: DEBE o HABER. balanceType está vacío si la cuenta no tiene un tipo de saldo asociado. Solo las cuentas de libro mayor tienen un tipo de saldo. Para la API v32 y anteriores, balanceType es una propiedad de solo lectura identificada en su cuenta principal. Para API v33+, las cuentas secundarias pueden usar un tipo de saldo diferente al de sus cuentas principales. | CRÉDITO |
timeStratum | No | El código del estrato temporal de la cuenta. En el caso de las cuentas modeladas y de cubo, se hereda de la hoja propietaria de la cuenta. Consulte Pasos: cambio de calendarios para obtener más información sobre la estructura temporal y los códigos de periodo temporal. Propiedad de solo lectura seleccionada de una estructura temporal, una hoja modelada o de cubo. | 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. Propiedad de solo lectura para cuentas de libro mayor. | NUMBER |
decimalPrecision | No | El número de decimales que se mostrarán para los números de esta cuenta. El valor especial de 99 indica una cuenta vinculada que hereda la precisión decimal de su destino. El valor -1 indica que la cuenta es una cuenta de moneda y utiliza la precisión de la moneda que muestra. Valores permitidos: -1, 0, 1-9, 99 El valor por defecto es 0. | 0 |
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. Si falta, utilice A para PERIODIC y E para ACUMULATIVE. | E |
suprimirCeros | No | Indica si la cuenta permite a los usuarios suprimir ceros en las hojas. Si es 0, los usuarios no pueden suprimir ceros. Si es 1, los usuarios pueden suprimir ceros. Solo se proporciona para cuentas con la propiedad "Suprimir en hojas" activada en el panel de control Cuentas. Si falta, el valor por defecto es 1. | 1 |
startExpanded | No | Indica si una cuenta y sus cuentas secundarias comienzan con un estado expandido cuando se carga la hoja por primera vez. Solo se aplica a las cuentas principales. 1 para expandir, 0 para contraer. Si falta, el valor por defecto es 1. | 1 |
dataEntryType actualizado en API v29 | No | Indica el tipo de entrada de datos de una cuenta hoja. STANDARD o CUBE. Si el dataEntryType principal es CUBE, una nueva cuenta tomará por defecto dataEntryType CUBE. De lo contrario, las cuentas nuevas se establecen por defecto en dataEntryType STANDARD. Se ignoran los cambios de dataEntryType en las cuentas que no son de hoja. El sistema calcula automáticamente el nuevo tipo de entrada de datos para todas las cuentas que no son de hoja. La API v29 y posteriores admiten la adición de nuevas cuentas con dataEntryType=CUBE. | ESTÁNDAR |
hasSalaryDetail | No | Indica si esta cuenta tiene divisiones que requieren el permiso Acceso a detalles salariales para su consulta. Vacío si no es aplicable a esta cuenta. hasSalaryDetail=1 no está permitido para cuentas de grupo de cuentas/fuera de hoja. Para hacer que hasSalaryDetail=1:
Errores cuando dataEntryType NO es ESTÁNDAR. Errores cuando dataEntryType=1 para cuentas no hoja. Errores para cuentas personalizadas y que no son de libro mayor. | 1 |
dataPrivacy | No | Indica los niveles en los que los valores de la cuenta son públicos y se pueden consultar en otros niveles al escribir fórmulas. PRIVATE indica que los valores de la cuenta son privados. PUBLIC_TOP indica que los valores de la cuenta son 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 siempre son públicos y no tienen una configuración dataPrivacy. Si falta, se establece por defecto PRIVATE. Errores para grupo de cuentas y cuentas de supuesto. | PRIVADO |
isIntercompany | No | Indica si la cuenta es una cuenta interempresa o no. No se admiten cambios en la propiedad isIntercompany. | 0 |
propagateToDescendants | No | Indica la propagación de los cambios de asignación de atributos a los descendientes. Cuando falta, el valor por defecto es 0. Da error si está vacío o tiene un valor distinto de 1 o 0. Propiedades que se propagan a los descendientes:
| 1 |
Contenido del elemento
| |||
Un elemento de atributos opcional si desea editar uno o varios atributos de cuenta asociados a la cuenta. | |||
elemento de atributo
| |||
Nombre de etiqueta
| atributo | ||
Descripción
| Especifica un atributo para actualizar. Etiqueta la cuenta con el atributo si el modelo tiene atributos de cuenta. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
nombre | Sí | El nombre del atributo. Errores si el nombre aún no existe en el sistema. Errores si el nombre existe pero el atributo no es un atributo de cuenta. Errores si el nombre de atributo está vacío o falta. | Ubicación |
valor
actualizado en API v34 | Sí | El valor de atributo para este atributo. Permite que un valor vacío elimine el valor actual o cualquiera de los valores de atributo de cuenta definidos. El valor de atributo debe ser compatible con el atributo asignado a la cuenta. Para API v32 y v33, este atributo solo es significativo cuando la configuración de Nombre de visualización está desactivada para la instancia. Para API v34 y posteriores:
| 170 |
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. | Sí | El código exclusivo del valor de atributo.
La entrada valueCode solo es significativa cuando displayNameEnabled=1 y el parámetro Nombre de visualización está activado para la instancia en API v32 y API v33. Códigos de valor de atributo no válidos:
| SFO |
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. | No | El nombre de un valor de atributo recién creado automáticamente.
El atributo valueName solo es significativo cuando:
| San Francisco |
Contenido del elemento
| |||
(ninguno) | |||
Proceso de carga útil de arriba a abajo
Los atributos de cuenta agrupan valores de forma lógica y etiquetan cuentas. Dado que la API updateAccounts procesa la carga útil XML de arriba a abajo, asigne el atributo de cuenta para una cuenta principal antes de cambiar los atributos de la cuenta secundaria. Las cuentas secundarias se pueden etiquetar con cualquier valor de atributo cuando el valor de atributo de la cuenta principal está en blanco. Si los atributos de la cuenta secundaria no se alinean con el atributo principal, se produce un error de validación de compatibilidad.
Tenga en cuenta la siguiente estructura de árbol, donde la "Línea de producto" principal tiene dos cuentas secundarias "A" y "B-Ste". Las cuentas "A" y "B-Ste" son cuentas del mismo nivel.
Product Line|__A __A |__B-Ste __B-Ste |__B1 __Product B-1 |__B2 __Product B-2 |__B3 __Product B-3
XML de solicitud original de muestra con atributos de cuenta
Tenga en cuenta que el valor de atributo de cuenta "A" se asigna tanto a "Otras cuentas" como a "Swiss Bank".
<accounts> <account id="60" code="70140" name="Other Accounts"> <attribute name="Product Line" value="A" /> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="A" /> </account> </account> </accounts>
Ejemplo de orden incorrecto para proceso de carga útil
La siguiente carga útil XML genera un error, "
The attribute value B-1 is not compatible with the parent's attribute value
". El proceso de carga útil de arriba a abajo considera que la cuenta principal "Otras cuentas" tiene el valor "A" del bloque de código anterior y procesa "B-1" como la secundaria de "A". El error se genera porque el elemento secundario "Swiss Bank" solo puede tener los valores de atributo "A" o "B-Ste" como se indica en la estructura de árbol. <accounts> <account id="60" code="70140" name="Other Accounts"> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="B-1" /> </account> <attribute name="Product Line" value="B-Ste" /> <!-- Account Attribute change ignored due to placement order--> </account> </accounts>
Ejemplo de orden válida para proceso de carga útil
Reorganizar el orden de ubicación de "B-Ste" debajo de "Otras cuentas" permite que la API procese primero el atributo de cuenta principal "B-Ste", lo que permite que "Swiss Bank" tenga valores de "B-Ste" o cualquiera de sus elementos secundarios.
<accounts> <account id="60" code="70140" name="Other Accounts"> <attribute name="Product Line" value="B-Ste" /> <!-- Account Attribute change processed due to correct placement order--> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="B-1" /> </account> </account> </accounts>
Formato de respuesta
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <messages> <message type="INFO">Accounts were saved successfully.</message> </messages> <output> <accounts> <account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets"displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="true" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true"> <account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="true" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true"> </account> </accounts> </output> </response>
elemento de resultado
| |
Nombre de etiqueta
| salida |
Atributos del elemento
| |
(ninguno) | |
Contenido del elemento
| |
Un solo elemento de cuentas 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 cuentas
| |||
Nombre de etiqueta
| cuentas | ||
Descripción
| Contenedor para uno o varios elementos de cuenta. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
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 updateAccounts. 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
| ||
ID | Sí | 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 | ||
código | Sí | El código de la cuenta, tal como aparece cuando se hace referencia a ella en las fórmulas. | Cur_Assets | ||
nombre | Sí | El nombre de la cuenta, tal como aparece en informes y hojas. | Activo corriente | ||
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 | No | El código del estrato temporal de la cuenta. En el caso de las cuentas modeladas y de cubo, se hereda de la hoja propietaria de la cuenta. | 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 | Indica si la cuenta permite a los usuarios suprimir ceros en las hojas. Si es 0, los usuarios no pueden suprimir ceros. Si es 1, los usuarios pueden suprimir ceros. Solo se proporciona para cuentas con la propiedad "Suprimir en hojas" activada en el panel de control 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 especial de 99 indica una cuenta vinculada que hereda la precisión decimal de su destino. El valor -1 indica que la cuenta es una cuenta de moneda y utiliza la precisión de la moneda que muestra. Valores permitidos: -1, 0, 1-9, 99 El valor por defecto es 0. | 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 | ||
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 actualizado en API v29 | No | Indica el tipo de entrada de datos de la cuenta. STANDARD o CUBE. Un valor vacío indica que el tipo de entrada de datos no es aplicable a la cuenta. El sistema calcula automáticamente el nuevo tipo de entrada de datos para todas las cuentas que no son de hoja. Para API v29 y superior:
| ESTÁNDAR | ||
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 | Indica si esta cuenta tiene divisiones que requieren el permiso Acceso a detalles salariales para su consulta. Vacío si no es aplicable a esta cuenta. | 1 | ||
dataPrivacy | No | Indica los niveles en los que los valores de la cuenta son públicos y se pueden consultar en otros niveles al escribir fórmulas. PRIVATE indica que los valores de la cuenta son privados. PUBLIC_TOP indica que los valores de la cuenta son 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 siempre son públicos y no tienen una configuración dataPrivacy. | 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 | ||
isContra
Disponible en API v34+ | No | 0 o 1 para indicar si se trata de una cuenta de contrapartida. | 1 | ||
isIntercompany | No | 0 o 1 para indicar si esta cuenta es una cuenta interempresa o no. | 1 | ||
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 | ||
estado | Sí | El estado de la cuenta después de la actualización. En el caso de los avisos y los errores, el elemento de mensaje incluye el contenido del mensaje. El estado actualizado no devuelve ningún contenido de mensaje.
| Actualizado | ||
mensaje | No | El mensaje de error de la entrada de cuenta. | La cuenta ModAccount33 está duplicada en la carga útil o ya existe en el sistema con el ID 8. | ||
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 atributo
| |||
Nombre de etiqueta
| atributo | ||
Descripción
| Indica el etiquetado de atributo de la cuenta. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
nombre | Sí | El nombre del atributo de cuenta | Tipo de estudios |
valor
actualizado en API v34 | Sí | El valor del atributo de cuenta.
Para API v32 y API v33, este atributo solo es significativo cuando el parámetro Nombre de visualización está desactivado para la instancia. | Tech1 |
valueCode
Solo está disponible en API v32 y API v33 para instancias que activan el nombre de visualización. | Sí | El código exclusivo del valor de atributo.
Para API v32 y API v33, valueCode solo es significativo cuando:
| |
valueName
Solo está disponible en API v32 y API v33 para instancias que activan el nombre de visualización. | No | El nombre de un valor de atributo recién creado automáticamente.
El atributo valueName solo es significativo cuando:
| |
estado | Sí | El estado del atributo después de la actualización. En el caso de los avisos y los errores, el elemento de mensaje incluye el contenido del mensaje. El estado actualizado no devuelve ningún contenido de mensaje.
| actualizado |
mensaje | No | El mensaje de error de una entrada de atributo no válida. | |
Contenido del elemento
| |||
(ninguno) | |||