updateAccounts
Com suporte na API v20 +
Categoria
| Modificação de metadados |
Descrição
| Atualize um conjunto de contas LR existentes ou crie novas contas LR. Várias contas com vários valores podem ser atualizadas em uma chamada. Se for bem-sucedida, a API retorna detalhes das contas que foram atualizadas/criadas. Se a API falha, uma lista abrangente de erros e suas causas é retornada. |
Permissões obrigatórias para invocar
| Modelo e permissões em cada nível |
Parâmetros obrigatórios na solicitação
| Credenciais |
A solicitação desse método contém uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. O usuário deve ter o "Modelo" Conceito: conjuntos de permissões e a permissão necessária para administrar as contas que estão sendo atualizadas.
Prática recomendada: invoque exportAccounts para recuperar o
Adaptive Planning
IDs de conta necessárias para sua solicitação updateAccounts. Faça o possível para minimizar o tempo entre as chamadas a exportAccounts e as solicitações updateAccount.HTTP | Descrição |
|---|---|
Method
| Post
|
Content-Type
| text/xml |
Exemplo de curvatura
curl -H "Content-Type: text/xml" -d @C:/temp/updateAccounts.xml -X POST https://api.adaptiveplanning.com/api/v20
updateAccounts.xml contents
Formato da solicitação
<?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 grandes, você pode publicar arquivos XML compactados (zipados). Saiba como aqui.
As seguintes condições se aplicam a updateAccounts:
- As contas são identificadas para atualização por meio de seu número de ID interno.
- Para criar novas contas, forneça a elas uma propriedade de ID em branco ou ausente.
- Você pode mover um item existente (não novo) para que ele se torne filho de um novo item. Isso cria o novo item e move o item existente abaixo dele como um filho.
- Para a API v31 e versões mais recentes, você pode criar uma nova conta pai entre uma conta pai existente e as contas filho dela.
Redefinição de contas como pai
- updateAccountsOs erros são gerados se o valor do atributo de um filho não é compatível com o novo atributo pai. Exemplo: o atributo reparentedAccount1 tem valor de relatório SEC = Não e não é compatível porque newParentAccount2 valor de Relatório SEC = Sim.
- updateAccountscorrige valores de atributo não compatíveis para corresponder ao novo pai durante a redefinição como pai quandoproceedWithWarnings=1.
- A redefinição de contas como pai não pode formar um relacionamento cíclico.
- A redefinição como pai não é permitida para contas-raiz geradas pelo sistema:Assets, Liabilities and Equities, Net Income, PL Income, Non-Operating Income, PL COGS, PL Expense, Non-Operating Expenses.
Dependendo da versão da API,
updateAccounts
permite criar uma nova conta pai entre uma conta pai existente e as contas filho dela: Conta de origem | Movido para baixo | API v30 e anteriores | API v31 + |
|---|---|---|---|
raiz | raiz | impedido | impedido |
raiz | principal | impedido | impedido |
raiz | folha | impedido | impedido |
principal | raiz | permitido | permitido |
principal | principal | permitido | permitido |
principal | uma folha existente como primeiro filho | impedido | impedido |
principal | uma folha existente como não o primeiro filho | permitido | permitido |
principal | uma nova primeira conta que é filho de uma conta pai existente | impedido | permitido |
principal | uma nova conta, não primeira, que é filho de uma conta pai existente | permitido | permitido |
folha | raiz | permitido | permitido |
folha | principal | permitido | permitido |
folha | uma folha existente como primeiro filho | impedido | impedido |
folha | uma folha existente como não o primeiro filho | permitido | permitido |
folha | uma nova primeira conta que é filho de uma conta pai existente | impedido | permitido |
folha | uma nova conta, não primeira, que é filho de uma conta pai existente | permitido | permitido |
folha | uma nova primeira conta que é filho de uma conta folha existente | impedido | impedido |
folha | uma nova conta não prioritária que é filho de uma conta folha existente | permitido | permitido |
Contas folha secundárias
- O primeiro filho de uma conta folha só pode ser uma conta nova. Uma conta LR existente não pode ser movida para baixo de uma conta folha existente.
- Quando uma conta obtém seu primeiro filho durante a redefinição de parentesco, o mapeamento de conta em Integração > Importar mapeamentos de conta é excluído.
- Quando redefinir contas como pai,balanceTypeesubTypeas propriedades são herdadas da conta LR pai.
Contas de cubo e dados com entrada de dados no cubo
- Contas com entrada de dados no cubo podem ser redefinidas como pai.
- Somente contas sem dados com entrada de dados no cubo nas subárvores de origem e de destino podem ser redefinidas como pai.
- Contas CUBE/MIXED não podem ser redefinidas como pai.
- Não são permitidas novas contas em uma CONTA CUBE. São permitidas novas contas em uma CONTA STANDARD/MIXED ACCOUNT.
Formato de solicitação para criação de uma nova conta
Para criar uma nova conta, inclua a conta pai pela ID. Por exemplo, para adicionar uma nova conta filho abaixo do L
ocalAssets
conta que tem id 1441
, você pode usar:<?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 não altera nada na conta
id 1441
. Ele cria um novo filho chamado new Local Assets
para id 1441
. Todos os filhos não mencionados de LocalAssets
mover para o fim da lista de filhos. Isso equivale a "definir a conta pai" para a nova conta.Tratamento de várias renomeações em uma única chamada updateAccounts
Várias renomeações da mesma entidade podem ocorrer em um sistema remoto entre
updateAccounts
chamadas. Os nomes de entidades no sistema remoto podem ser trocados pelas mesmas IDs de entidade. Quando updateAccounts
chamadas ocorrem após a troca de nomes, o updateAccounts
O call gerencia essas alterações rastreando as IDs nas alterações de nome. A chamada também pode lidar com a introdução de uma nova ID que usa um nome existente.Para que cada um dos exemplos seja bem-sucedido, a troca completa de IDs deve ocorrer com os valores exclusivos.
Exemplo 1: uma simples troca de nome no sistema remoto.
ID Unique Value New Unique Value 1 AA BB 2 BB AA
Exemplo 2: uma sequência de três renomeações no sistema remoto.
ID Unique Value New Unique Value 1 AA BB 2 BB CC 3 CC AA
Exemplo 3: uma nova entidade que usa um valor exclusivo existente.
ID Unique Value New Unique Value 4 AA 1 AA BB 2 BB Old BB
elemento de credenciais
| |||
Nome da etiqueta
| credenciais | ||
Descrição
| Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
login | S | O nome de logon do usuário que invoca o método de API. Esse usuário deve ter as permissões necessárias para invocar o método. | sampleuser@company.com |
senha | S | A senha do usuário que invoca o método de API. | my_password |
parâmetros regionais | N | Especifique os parâmetros regionais a serem usados para interpretar números e datas de entrada e para formatar números e datas de saída (usando o separador de milhares, nomes de meses e formatação de data adequados). Os parâmetros regionais também são usados para especificar o idioma em que as mensagens do sistema na resposta devem ser exibidas. Se não especificado, en_US (inglês americano) é usado. | fr_FR |
instanceCode | N | Se o usuário especificado nas credenciais tem acesso a mais de uma instância do Adaptive Planning, esse atributo pode ser usado para especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não for especificada, a instância por padrão do usuário será usada. Para determinar os códigos de instância disponíveis, use a API exportInstances. | MYINSTANCE1 |
Conteúdo do elemento
| |||
(nenhum) | |||
elemento de contas
| |||
Nome da etiqueta
| contas | ||
Descrição
| Somente uma solicitação de elemento de contas é permitida por carga. Contém um ou mais elementos de conta. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
proceedWithWarnings | N | prosseguiWithWarnings="1" indica que a API updateAccounts deve ajustar os atributos e as propriedades da conta com base nas alterações de redefinição de parentesco. prosseguiWithWarnings="0" indica que a API updateAccounts não deve ajustar os atributos e as propriedades da conta com base em alterações de redefinição de parentesco. Os erros de UpdateAccounts são enviados com uma mensagem informando o motivo da falha. Por exemplo, o mapeamento de atributos se tornará inválido após a redefinição de parentesco. O valor por padrão é 0, se ausente. | 1 |
retainExistingOrder Disponível na API v26 + | N | MaintainExistingOrder="1" indica que a updateAccounts API deve ignorar a ordem dos elementos na carga XML e a ordem definida existente será mantida. retExistingOrder="0" indica que a updateAccounts API deve atualizar a ordem dos elementos com base na posição da etiqueta em relação a outras irmãs na carga XML. O atributo MaintainExistingOrder é ignorado nas versões de API anteriores à API v26. O valor por padrão para reterExistingOrder é "0" na versão 26. Para as versões v27 e posteriores da API, o valor por padrão de MaintainExistingOrder é "1". | 1 |
displayNameEnabled
Disponível somente na API v32+ para instâncias que habilitam o nome de exibição. | N | displayNameEnabled = 1 indica que updateAccounts deve respeitar as propriedades de nome de exibição de code , displayNameType e description quando Habilitar nome de exibição está ATIVADO para a instância.displayNameEnabled=0 indica que a updateAccounts API deve continuar seguindo o contrato de API anterior à versão 32, mesmo quando a opção Habilitar nome de exibição está ATIVADA para a instância. A API updateAccounts ignora as propriedades de nome de exibição code , displayNameType e description .O valor por padrão para displayNameEnabled é "0". | 1 |
Conteúdo do elemento
| |||
Contém um ou mais elementos de conta. | |||
elemento de conta
| |||
Nome da etiqueta
| account | ||
Descrição
| Especifica uma conta a ser criada. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
ID | S | O número de ID do sistema interno da conta. | 16 |
código
| N | O código da conta, somente caracteres alfanuméricos e sublinhados. Não deve fornecer um atributo de código para grupos de contas.
| Cur_Assets |
nome
| S | O nome da conta, como aparece em relatórios e planilhas.
| Ativos atuais |
shortName | N | O nome curto da conta. | CA |
descrição | N | A descrição textual da conta. O tamanho máximo em caracteres é 2048. | Total de ativos atuais |
subType | N | Indica se a conta é PERIÓDICA ou CUMULATIVA. Se uma conta é periódica, seu valor em um determinado mês é igual à atividade líquida do mês. Os exemplos incluem contas de receita e despesa. Se uma conta é cumulativa, seu valor é igual ao saldo final de um determinado mês. Esse é o valor do mês anterior mais ou menos qualquer atividade no mês determinado. As contas de balanço patrimonial são cumulativas. Fica vazio para grupos de contas e contas de métrica. Somente leitura, identificada com base na conta pai. | Cumulativa |
planBy | N | Para contas cumulativas, indica se a conta é planejada por saldo (SALDO) ou planejada por delta (DELTA). O valor por padrão é DELTA. A alteração de planBy para DELTA NÃO é permitida quando a conta tem divisões em versões não reais. Aplicável somente a contas folha. O updateAccounts gera erros quando o usuário tenta definir planBy para uma conta não folha. | DELTA |
valores reaisPor | N | Para contas cumulativas, indica se a conta tem valores reais por saldo (SALDO) ou valores reais por delta (DELTA). O valor por padrão é SALDO. Aplicável somente a contas folha. Os erros updateAccounts são gerados quando o usuário tenta definir actualsBy para uma conta não folha. | SALDO |
enableActuals | N | 0 para mostrar somente os dados planejados da conta. 1 para importar valores reais para a conta. Para contas vinculadas, 0 mostrará valores reais somente se a conta vinculada os tiver e 1 habilitará valores reais para a conta vinculada. Fica vazio para grupos de contas e contas de métrica. A interface de usuário de administração do Planning LR usa o termo "sobreposição de valores reais". O valor por padrão é 0 quando a conta atual é um grupo. O valor por padrão é 1 quando a conta atual é uma folha | 1 |
balanceType
Atualizado na API v33 | N | Indica o tipo de saldo de uma conta: DÉBITO ou CRÉDITO. balanceType fica vazio se a conta não tem um tipo de saldo associado. Somente contas LR têm um tipo de saldo. Para a API v32 e anteriores, balanceType é uma propriedade de somente leitura identificada na conta pai. Para a API v33+, as contas filho podem usar um balanceType diferente das contas pai. | CRÉDITO |
timeStratum | N | O código do estrato de tempo da conta. Para contas modeladas e de cubo, isso é herdado da planilha proprietária da conta. Consulte Etapas: alterar calendários para obter mais informações sobre estrutura de tempo e códigos de período. Propriedade somente leitura selecionada na estrutura de tempo, na planilha modelada ou de cubo. | month |
displayAs | N | A configuração de exibição de saída da conta: NÚMERO, MOEDA ou PERCENTUAL. Fornecido somente para contas que têm uma propriedade Exibir como em Administração de conta. Propriedade somente leitura para contas LR. | NUMBER |
decimalPrecision | N | O número de casas decimais a serem exibidas para os números nesta conta. O valor especial de 99 indica uma conta vinculada que herda a precisão decimal de seu destino. O valor -1 indica que a conta é uma conta de moeda e usa a precisão da moeda que exibe. Valores permitidos: -1, 0, 1-9, 99 O valor por padrão é 0. | 0 |
exchangeRateType | N | Presente somente para instâncias com multimoeda habilitada e para contas com displayAs="CURRENCY". Valores possíveis: qualquer um dos códigos de tipo de taxa cambial presentes na instância, conforme configurado em Gerenciar moedas. "A"=Média mensal, "E"=Fim do mês. Se estiver ausente, use A para PERIÓDICA e E para CUMULATIVA. | E |
suppressZeroes | N | Indica se a conta permite que os usuários suprimam zeros nas planilhas. Se 0, os usuários não podem suprimir zeros. Se 1, os usuários podem suprimir zeros. Fornecido somente para contas com a propriedade "Suprimir em planilhas" ativada no administrador de contas. Se ausente, o valor por padrão é 1. | 1 |
startExpanded | N | Indica se uma conta e seus filhos começam em um estado expandido quando a planilha é carregada pela primeira vez. Aplica-se apenas a contas pai. 1 para expandido, 0 para recolhido. Se ausente, o valor por padrão é 1. | 1 |
dataEntryType atualizado na API v29 | N | Indica o tipo de entrada de dados para uma conta folha. STANDARD ou CUBE. Se o dataEntryType pai é CUBE, a nova conta tem como valor por padrão dataEntryType CUBE. Caso contrário, o valor por padrão das novas contas é dataEntryType STANDARD. As alterações de dataEntryType em contas não folha são ignoradas. O sistema calcula automaticamente o novo dataEntryType para todas as contas não folha. A API v29 e versões mais recentes oferecem suporte à adição de novas contas com dataEntryType = CUBE. | PADRÃO |
hasSalaryDetail | N | Indica se esta conta tem divisões que exigem a permissão Acessar detalhes de salário para visualização. Vazio se não for aplicável a esta conta. hasSalaryDetail=1 não é permitido para contas de grupo/não folha. Para tornar hasSalaryDetail = 1:
Erros quando dataEntryType NÃO É STANDARD. Erros quando dataEntryType = 1 para contas não folha. Erros para contas não LR e personalizadas. | 1 |
dataPrivacy | N | Indica os níveis em que os valores da conta são públicos e podem ser atualizados novamente em outros níveis quando você escreve fórmulas. PRIVADO indica que os valores da conta são privados. PUBLIC_TOP indica que os valores da conta são públicos somente no nível superior, ou PUBLIC_ALL para que os valores da conta sejam públicos em todos os níveis. As suposições são sempre públicas e não têm uma configuração de dadosPrivacidade. Quando ausente, o valor por padrão é PRIVADO. Erros para grupo de contas e contas de suposição. | PRIVADO |
isIntercompany | N | Indica se a conta é uma conta intercompanhias ou não. Não há suporte para alterações na propriedade isIntercompany. | 0 |
propagateToDescendants | N | Indica a propagação de alterações de mapeamento de atributos para descendentes. Quando ausente, o valor por padrão é 0. Erros se estiver vazio ou contiver qualquer valor diferente de 1 ou 0. Propriedades que se propagam para os descendentes:
| 1 |
Conteúdo do elemento
| |||
Um elemento de atributos opcionais se você quiser editar um ou mais atributos de conta associados à conta. | |||
elemento atributo
| |||
Nome da etiqueta
| atributo | ||
Descrição
| Especifica um atributo a ser atualizado. Marca a conta com o atributo se o modelo tem atributos de conta. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
nome | S | O nome do atributo. Erros se o nome ainda não existir no sistema. Ocorrem erros se o nome existe, mas o atributo não é um atributo de conta. Ocorrem erros se o nome do atributo está vazio ou ausente. | Location |
valor
atualizado na API v34 | S | O valor deste atributo. Permite um valor vazio para remover o valor atual ou qualquer um dos valores de atributo de conta definidos. O valor do atributo deve ser compatível com o atributo atribuído da conta. Para as APIs v32 e v33, esse atributo só é significativo quando a configuração Nome de exibição está DESATIVADA para a instância. Para a API v34 e versões mais recentes:
| 170 |
valueCode
Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34. | S | O código exclusivo do valor do atributo.
A entrada valueCode é significativa somente quando displayNameEnabled = 1 e a configuração de nome de exibição está ATIVADA para a instância na API v32 e API v33. Códigos de valor de atributo inválidos:
| SFO |
valueName
Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34. | N | O nome de um valor de atributo recém-criado automaticamente.
O atributo valueName é significativo somente quando:
| São Francisco |
Conteúdo do elemento
| |||
(nenhum) | |||
Processamento de carga de cima para baixo
Os atributos de conta agrupam valores e marcam contas de forma lógica. Como a updateAccounts API processa a carga XML de cima para baixo, atribua o atributo de conta a uma conta pai antes de alterar os atributos da conta filho. Contas filho podem ser marcadas com qualquer valor de atributo quando o valor do atributo da conta pai está em branco. Se os atributos da conta filho não se alinham ao atributo pai, ocorre um erro de validação de compatibilidade.
Considere a estrutura de árvore abaixo, em que a "Linha de produtos" pai tem duas contas filho "A" e "B-Ste". As contas "A" e "B-Ste" são irmãs.
Product Line|__A __A |__B-Ste __B-Ste |__B1 __Product B-1 |__B2 __Product B-2 |__B3 __Product B-3
Exemplo de solicitação XML original com atributos de conta
Observe que o valor de atributo de conta "A" é atribuído a "Other Accounts" e 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>
Exemplo de ordem incorreta para processamento de carga
A carga XML a seguir gera um erro: "
The attribute value B-1 is not compatible with the parent's attribute value
". O processamento de carga de cima para baixo considera que a conta pai "Outras contas" tem o valor "A" do bloco de código anterior e processa "B-1" como filho de "A". O erro é gerado porque o "Swiss Bank" filho só pode ter os valores de atributo "A" ou "B-Ste", conforme indicado na estrutura de árvore. <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>
Exemplo de pedido válido para processamento de carga
Reorganizar a ordem de posicionamento de "B-Ste" abaixo de "Other Accounts" permite que a API processe primeiro o atributo de conta pai "B-Ste", permitindo que "Swiss Bank" tenha valores de "B-Ste" ou qualquer um de seus filhos.
<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 da resposta
<?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 saída
| |
Nome da etiqueta
| saída |
Atributos do elemento
| |
(nenhum) | |
Conteúdo do elemento
| |
Um único elemento de contas obrigatório. Esse invólucro de saída é padrão em todas as respostas de API e inclui a saída válida de qualquer chamada de API bem-sucedida. | |
elemento de contas
| |||
Nome da etiqueta
| contas | ||
Descrição
| Contêiner para um ou mais elementos de conta. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
Conteúdo do elemento
| |||
Um ou mais elementos de conta. | |||
elemento de conta
| |||||
Nome da etiqueta | account | ||||
Descrição
| Representa uma única conta que está sendo retornada em resposta a uma chamada à API updateAccounts. Se esse elemento está diretamente dentro do elemento de contas da resposta (ou seja, não está dentro de outro elemento de conta), esse elemento de conta representa uma conta raiz (uma conta que não tem pai). | ||||
Atributos do elemento
| |||||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
| ||
ID | S | O número de ID do sistema interno da conta. Isso pode ser usado para identificar contas em outras chamadas de API, como exportDimensionFamilies. | 16 | ||
código | S | O código da conta, conforme aparece quando referenciado em fórmulas. | Cur_Assets | ||
nome | S | O nome da conta, como aparece em relatórios e planilhas. | Ativos atuais | ||
accountTypeCode | N | O código de letras correspondente ao tipo de dados desta conta | |||
Código de tipo | Tipo de conta | Classe da conta | |||
A | Ativo | Livro-razão geral | |||
B | Ativo atual | Livro-razão geral | |||
C | Passivo e patrimônio líquido | Livro-razão geral | |||
CUBE | Cubo | Cubo | |||
PT | Perda/Ganhos acumulados no ano | Livro-razão geral | |||
F | Ativo fixo | Livro-razão geral | |||
G | Custo de mercadorias vendidas | Livro-razão geral | |||
I | Receita | Livro-razão geral | |||
J | Receita não operacional | Livro-razão geral | |||
K | Ajuste cumulativo de conversão | Sistema | |||
L | Passivo | Livro-razão geral | |||
M | Passivo atual | Livro-razão geral | |||
MI | Percentuais de consolidação | Predefinido | |||
MT | Métrica | Métrica | |||
N | Renda líquida | Livro-razão geral | |||
O | Outros ativos | Livro-razão geral | |||
Q | Patrimônio líquido | Livro-razão geral | |||
R | Ativo de longo prazo | Livro-razão geral | |||
S | Suposição | Suposição | |||
Cam | Passivo de longo prazo | Livro-razão geral | |||
W | Modelada | Modelada | |||
X | Despesa | Livro-razão geral | |||
XR | Taxa cambial | Predefinido | |||
S | Despesas não operacionais | Livro-razão geral | |||
Z | Personalizado | Personalizado | |||
descrição | N | A descrição textual da conta, se houver, conforme inserida em Administração de conta | Total de ativos atuais | ||
shortName | N | O nome curto da conta, se houver, conforme inserido em Administração de conta | CA | ||
timeStratum | N | O código do estrato de tempo da conta. Para contas modeladas e de cubo, isso é herdado da planilha proprietária da conta. | Mês | ||
displayAs | N | A configuração de exibição de saída da conta: NÚMERO, MOEDA ou PERCENTUAL. Fornecido somente para contas que têm uma propriedade Exibir como em Administração de conta. | NUMBER | ||
isAssunção | N | "0" ou "1" indicando se a conta é uma suposição. É definido como 1 para suposições e contas de taxa cambial. | 1 | ||
suppressZeroes | N | Indica se a conta permite que os usuários suprimam zeros nas planilhas. Se 0, os usuários não podem suprimir zeros. Se 1, os usuários podem suprimir zeros. Fornecido somente para contas com a propriedade "Suprimir em planilhas" ativada no administrador de contas. | 1 | ||
isDefaultRoot | N | "0" ou "1" indicando se a conta ou o grupo de contas é uma raiz por padrão. | 1 | ||
decimalPrecision | N | Número de casas decimais a serem exibidas para os números nesta conta. O valor especial de 99 indica uma conta vinculada que herda a precisão decimal de seu destino. O valor -1 indica que a conta é uma conta de moeda e usa a precisão da moeda que exibe. Valores permitidos: -1, 0, 1-9, 99 O valor por padrão é 0. | 0 | ||
planBy | N | Para contas cumulativas, indica se a conta é planejada por saldo (SALDO) ou planejada por delta (DELTA). | SALDO | ||
exchangeRateType | N | Presente somente para contas com displayAs="CURENCY". Valores possíveis: qualquer um dos códigos de tipo de taxa cambial presentes na instância, conforme configurado em Gerenciar moedas. "A"=Média mensal, "E"=Fim do mês. | E | ||
balanceType | N | Indica o tipo de saldo de uma conta, DÉBITO ou CRÉDITO. Esse atributo fica vazio se a conta não tem um tipo de saldo associado. Somente contas LR têm um tipo de saldo. | DÉBITO | ||
dataEntryType atualizado na API v29 | N | Indica o tipo de entrada de dados da conta. STANDARD ou CUBE. Um valor vazio indica que o tipo de entrada de dados não é aplicável à conta. O sistema calcula automaticamente o novo dataEntryType para todas as contas não folha. Para a API v29 e versões superiores:
| PADRÃO | ||
timeRollUp | N | Indica como a conta se comporta quando é consolidada ao longo de um período. Pode ser SUM, WAITTED_AVERAGE, LAST ou AVERAGE. Fica vazio para grupos de contas e contas de métrica. | SUM | ||
timeWeightAcctId | N | Se essa conta tem um timeRollup de WATERGY_AVERAGE, esse será o número da ID do sistema interno da conta de onde os pesos são determinados. Estará vazio se não existir uma conta de ponderação ou se a conta não tiver um timeRollup de Weighted_average. | 133 | ||
hasSalaryDetail | N | Indica se esta conta tem divisões que exigem a permissão Acessar detalhes de salário para visualização. Vazio se não for aplicável a esta conta. | 1 | ||
dataPrivacy | N | Indica os níveis em que os valores da conta são públicos e podem ser atualizados novamente em outros níveis quando você escreve fórmulas. PRIVADO indica que os valores da conta são privados. PUBLIC_TOP indica que os valores da conta são públicos somente no nível superior, ou PUBLIC_ALL para que os valores da conta sejam públicos em todos os níveis. As suposições são sempre públicas e não têm uma configuração de dadosPrivacidade. | PRIVADO | ||
subType | N | Indica se a conta é PERIÓDICA ou CUMULATIVA. Se uma conta é periódica, seu valor em um determinado período é igual à atividade líquida do período. Os exemplos incluem contas de receita e despesa. Se uma conta é cumulativa, seu valor é igual ao saldo final de um determinado período. Esse é o valor do período anterior mais ou menos qualquer atividade no período especificado. As contas de balanço patrimonial são cumulativas. Fica vazio para grupos de contas e contas de métrica. | PERIODIC | ||
startExpanded | N | Isso indica se uma conta e seus filhos começam em um estado expandido quando uma planilha é carregada pela primeira vez. Isso se aplica apenas a contas pai. Estará vazio para contas folha. | 1 | ||
isBreakbackEligible | N | 0 ou 1 para indicar se essa conta pode ser usada em uma redistribuição. Isso se aplica apenas a suposições padrão. Estará vazio para outros tipos de contas. | 0 | ||
levelDimRollup | N | Indica como a conta se comporta quando consolidada em um nível ou dimensão. Pode ser SUM, WAITTED_AVERAGE, TEXT ou NONBLANK_AVERAGE. Fica vazio para grupos de contas e contas de métrica. | NONBLANK_AVERAGE | ||
levelDimWeightAcctId | N | Se essa conta tem um levelDimRollup de WATERED_AVERAGE, esse será o número da ID do sistema interno da conta de onde as ponderações são determinadas. Estará vazio se não existir uma conta de ponderação ou se o nívelDimRollup da conta não for de Weighted_average. | 118 | ||
rollupText | N | Se essa conta tem um levelDimRollup de TEXT, essa é a cadeia de caracteres de texto que aparece na célula, indicando o valor consolidado da conta. | Nenhuma | ||
enableActuals | N | 0 para mostrar somente os dados planejados da conta. 1 para importar valores reais para a conta. Para contas vinculadas, 0 mostrará valores reais somente se a conta vinculada os tiver e 1 habilitará valores reais para a conta vinculada. Fica vazio para grupos de contas e contas de métrica. | 1 | ||
isGroup | S | 0 ou 1 para indicar se este é um grupo de contas ou não. | 1 | ||
isContra
Disponível na API v34+ | N | 0 ou 1 para indicar se esta é uma conta de contrapartida. | 1 | ||
isIntercompany | N | 0 ou 1 para indicar se esta conta é uma conta intercompanhias ou não. | 1 | ||
isLinked | N | 0 ou 1 para indicar se esta conta é uma conta vinculada ou não. | 1 | ||
isSystem | N | 0 ou 1 para indicar se esta conta é uma conta do sistema ou não. | 1 | ||
status | S | O status da conta após a atualização. Para aviso e erro, o elemento de mensagem contém o conteúdo da mensagem. O status atualizado não retorna nenhum conteúdo da mensagem.
| Atualizado | ||
mensagem | N | A mensagem de erro para a entrada da conta. | A conta ModAccount33 está duplicada na carga ou já existe no sistema com ID 8 | ||
Conteúdo do elemento
| |||||
Um elemento de conta aninhada para cada conta filho direta desta conta. Um elemento de atributos se a conta tem um ou mais atributos associados a ela. | |||||
elemento atributo
| |||
Nome da etiqueta
| atributo | ||
Descrição
| Indica a marcação de atributo da conta. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
nome | S | O nome do atributo de conta | Tipo de formação |
valor
atualizado na API v34 | S | O valor do atributo de conta.
Para API v32 e API v33, esse atributo só é significativo quando a configuração Nome de exibição está DESATIVADA para a instância. | Tech1 |
valueCode
Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. | S | O código exclusivo do valor do atributo.
Para API v32 e API v33, valueCode só é significativo quando:
| |
valueName
Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. | N | O nome de um valor de atributo recém-criado automaticamente.
O atributo valueName é significativo somente quando:
| |
status | S | O status do atributo após a atualização. Para aviso e erro, o elemento de mensagem contém o conteúdo da mensagem. O status atualizado não retorna nenhum conteúdo da mensagem.
| atualizado |
mensagem | N | A mensagem de erro para uma entrada de atributo inválida. | |
Conteúdo do elemento
| |||
(nenhum) | |||