updateAccount

Adaptive Planning

updateAccount

Categoria	Modificação de metadados
Descrição	Atualize uma conta existente no sistema. Essa API retorna uma mensagem de erro quando a validação ou atualização falha, ou retorna metadados para a conta atualizada em caso de êxito. Essa API oferece suporte apenas aos seguintes tipos de conta: suposição, conta LR e conta personalizada. Ele não oferece suporte a contas do sistema ou vinculadas.
Permissões obrigatórias para invocar	Modelo para contas LR e personalizadas. Suposições para suposições.
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 a permissão Modelo ou Suposições para criar a conta. A solicitação XML é validada para cada campo e em relação a determinada lógica de negócios. As mensagens de erro são retornadas como parte da resposta quando a criação falha. A operação pode ser interrompida e uma mensagem de aviso é exibida quando uma operação de risco é detectada. A solicitação precisa ser reenviada com o atributo "ignoreWarnings" definido como 1 para que a atualização da conta seja concluída.

Formato da solicitação

O esquema de solicitação é fornecido no 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 }
        }* 
    }?
}

Exemplo


<?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 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 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. Ele pode ser usado para identificar contas em outras chamadas de API, como exportDimensionFamilies.	16
nome	S	O nome da conta, como aparece em relatórios e planilhas.	Ativos atuais
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
descrição	N	A descrição textual da conta.	Total de ativos atuais
shortName	N	O nome curto da conta.	CA
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.	E
hasSalaryDetail	N	A visualização de divisões de conta requer permissão de detalhes de salário. 0 para não, 1 para sim.	1
dataPrivacy	N	Escolha se o valor da conta é privado (PRIVATE), público somente no nível superior (PUBLIC_TOP) ou público em todos os níveis (PUBLIC_ALL). O valor por padrão é PRIVADO.	PRIVADO
isBreakbackEligible	N	Disponível em redistribuição. 0 para não, 1 para sim. Aplicável apenas a suposições.	0
proceedWithWarnings	N	Indica se o usuário quer ignorar as mensagens de aviso e prosseguir com a operação de atualização: 0 para não, 1 para sim. Se houver avisos e continueWithWarnings=0, a conta não será atualizada. Defina prosseguiWithWarnings=1 para atualizar a conta quando houver avisos.	1
Conteúdo do elemento
Um elemento de atributos opcionais se você quiser editar um ou mais atributos de conta associados à conta.

elemento de atributos
Nome da etiqueta		atributos
Descrição		Contêiner para um ou mais elementos de atributo de conta.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de atributo.

elemento atributo
Nome da etiqueta		atributo
Descrição		Representa um elemento de atributo de conta.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
attributeID	S	A ID do atributo de conta que foi gerada pelo sistema.	20
valueID	S	A ID exclusiva do valor do atributo de conta que foi gerado pelo sistema. Se esse valor é 0, esse atributo é removido da conta.	170
Conteúdo do elemento
nenhum

Formato da resposta

Estes são exemplos de respostas para atualização bem-sucedida e malsucedida de uma conta.

Exemplo 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>

Exemplo de erro


<?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 resposta
Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	Verdadeiro ou falso, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso em sua resposta.	verdadeiro
Conteúdo do elemento
Um único elemento de mensagens opcionais e/ou um único elemento de saída opcional.

elemento de saída
Nome da etiqueta	saída
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de contas. 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 mensagens
Nome da etiqueta	mensagens
Descrição	Contêiner para um ou mais elementos de mensagem.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos de mensagem.

elemento de mensagem
Nome da etiqueta		mensagem
Descrição		Representa uma mensagem que está sendo enviada pelo sistema de volta para o autor da chamada. As mensagens são usadas para mensagens de erro quando as solicitações não são bem-sucedidas, para mensagens de aviso quando as solicitações são bem-sucedidas e para mensagens de confirmação quando as solicitações são bem-sucedidas.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
type	S	O tipo é uma maneira de identificar o tipo de mensagem. Os diferentes tipos são INFORMAÇÃO, AVISO e ERRO. Type ERROR significa que esta solicitação não foi processada.	AVISO
chave	S	Uma chave é uma forma de identificar uma determinada mensagem ou tipo de mensagem, útil para fins de registro automatizado de erros e recuperação em programas cliente. As chaves não são alteradas em diferentes parâmetros regionais de solicitações, mesmo quando o idioma da mensagem é alterado. As chaves também não devem ser alteradas no futuro devido a ajustes de texto ou alterações de terminologia.	warning-invalid- timespan-start
valores	N	Quando fornecidos, os valores representam variáveis usadas no texto da mensagem.	199,12
parentId	N	Quando disponível, a ID da conta pai da nova que foi fornecida na solicitação.	50
Conteúdo do elemento
O texto da mensagem. Esse texto está no idioma dos parâmetros regionais especificados na solicitação (supondo que os parâmetros regionais tenham suporte). O texto também pode conter informações variáveis, como o número de linhas que foram processadas ou a coluna ou valor específico que causou um erro.

elemento de contas
Nome da etiqueta	contas
Descrição	Contêiner para um ou mais elementos de conta.
Atributos do elemento
(nenhum)
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 exportAccounts. 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

nome

O nome da conta, como aparece em relatórios e planilhas.

Atual

Ativos

código

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

O número de ID do sistema interno da conta. Ele pode ser usado para identificar contas em outras chamadas de API, como exportDimensionFamilies.

accountTypeCode

O código de letras correspondente ao tipo de dados account.

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

A descrição textual da conta.

Total

ativos atuais

shortName

O nome curto da conta, se houver, conforme inserido em Administração de conta.

timeStratum

Com suporte na API v16+

O estrato de tempo da conta, como o código do estrato de tempo. Para contas de cubo, contas modeladas e contas LR com entrada de dados no cubo, o estrato de tempo é determinado pelo estrato de tempo da planilha proprietária. Todas as outras contas usam o estrato de tempo por padrão definido na interface de usuário de administração de tempo.

Mês

displayAs

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

"0" ou "1" indicando se a conta é uma suposição. É definido como "1" para suposições e contas de taxa cambial.

suppressZeroes

Indicador que indica se a conta permite ou não aos usuários suprimir zeros nas planilhas. 0 não é permitido, 1 é permitido. Fornecido somente para contas que têm a propriedade Suprimir zeros em Administração de conta.

isDefaultRoot

"0" ou "1" indicando se a conta ou o grupo de contas é uma raiz por padrão.

decimalPrecision

Número de casas decimais a serem exibidas para os números nesta conta. O valor por padrão é 0. O valor especial de 99 é usado para indicar uma conta vinculada que herda a precisão decimal de seu destino. O valor -1 significa que a conta é uma conta em moeda e usa a precisão da moeda que está exibindo.

planBy

Para contas cumulativas, indica se a conta é planejada por saldo (SALDO) ou planejada por delta (DELTA).

SALDO

exchangeRateType

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.

isImportable

Indica se a conta pode aceitar dados importados. 0 significa que a conta não pode ser importada e 1 é importável. Presente somente se versionName ou versionId é especificado na solicitação.

Observação: isImportable indica apenas que uma conta está disponível para importação na versão especificada, não que o usuário que faz a chamada à API tem permissão para importar para a versão ou conta. Use exportVersions para ver quais versões estão disponíveis para importação pelo usuário.

hasSalaryDetail

A visualização de divisões de conta requer permissão de detalhes de salário. 0 para não, 1 para sim.

balanceType

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

Indica o tipo de entrada de dados de uma conta. STANDARD ou CUBE. Um valor em branco indica que o tipo de entrada de dados não é aplicável a uma conta. Por exemplo, uma conta vinculada ou modelada terá um tipo de entrada de dados em branco.

CUBE

timeRollUp

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

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

0 ou 1 para indicar se esta conta tem divisões que exigem a permissão Acessar detalhes de salário para serem visualizadas. Estará vazio se não for aplicável a esta conta.

dataPrivacy

Indica em quais níveis os valores da conta são públicos e podem ser referenciados em outros níveis ao escrever fórmulas. Pode ser PRIVATE para que os valores da conta sejam privados, PUBLIC_TOP para que os valores da conta sejam 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 não têm uma configuração de dataPrivacy porque são sempre públicas.

PRIVADO

subType

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.

PERIODIC

startExpanded

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.

isBreakbackEligible

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.

levelDimRollup

Indica como a conta se comporta quando consolidada em um nível ou dimensão. Pode ser SUM, WATERTED_AVER-AGE, TEXT ou NONBLANK_AVERAGE. Fica vazio para grupos de contas e contas de métrica.

NONBLANK_AVERAGE

levelDimWeightAcctId

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

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

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.

isGroup

0 ou 1 para indicar se este é um grupo de contas ou não.

isIntercompany

0 ou 1 para indicar se esta conta é uma conta intercompanhias ou não.

formula

A fórmula da conta, se houver uma.

ACCT.Revenue - ACCT.Expenses

isLinked

0 ou 1 para indicar se esta conta é uma conta vinculada ou não.

isSystem

0 ou 1 para indicar se esta conta é uma conta do sistema ou não.

owningSheetId

Para contas que podem estar em planilhas modeladas e de cubo, o número da ID do sistema interno da planilha em que a conta está. Estará vazio se não for uma conta desse tipo ou se for uma conta, mas não estiver atualmente atribuída a uma planilha.

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 de atributos
Nome da etiqueta		atributos
Descrição		Contêiner para um ou mais elementos de atributo.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de atributo.

elemento atributo
Nome da etiqueta		atributo
Descrição		Representa um único mapeamento de atributos de conta não em branco ao qual uma conta está associada.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
nome	S	O nome do atributo de conta.	Relatório SEC
valor	S	O nome do atributo de conta associado à conta.	Sim
attributeId	S	O número da ID do sistema interno do atributo de conta.	10
valueId	S	O número de ID do sistema interno do valor de atributo de conta.	108
Conteúdo do elemento
Nenhum.