Ir para o conteúdo principal
Documentação
Documentação
Adaptive Planning
Última atualização: 2023-06-23
Contas

Contas

Versão: v1

VERBOS HTTP com suporte

Verbo HTTP
Descrição
POST
Exclua as contas mencionadas na solicitação.

PUBLICAR:

Solicitação:
/removeGLAccounts:
Exclui as contas para os códigos de conta LR fornecidos.
Esse ponto de extremidade está protegido pelo indicador de funcionalidade "
ENable_ACCOUNTS_DELETION_JSON_API
" (atualmente ativado por padrão).
Oferece suporte a todas as contas LR que podem ser excluídas na interface de usuário. Ignora contas que não podem ser excluídas.
Exemplo de URI de solicitação:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeGLAccounts
Cabeçalho de solicitação de amostra:
Autorização: básica
Content-Type: application/json
Corpo da solicitação de amostra
Exemplo de solicitação POST 
[
    {
        "accountCodesToDelete": ["Assets", "b"]
    }
]
Parâmetros de carga
Nome
Descrição
Obrigatório
accountCodesToDelete
Nome de Códigos de conta a ser excluído.
S
Parâmetro de caminho
Nome
Descrição
Obrigatório
tenant
Locatário no qual operar. por exemplo, globosales
S
Parâmetros de consulta
Nome
Descrição
Obrigatório
forceRemove
Exclui contas em uso quando forceRemove=true e ignora contas em uso quando forceRemove=false.
O valor por padrão é sempre forceRemove=false.
N
instanceCode
O instanceCode do qual recuperar valores. Por exemplo, GLOBO. Se nenhum instanceCode é especificado, a instância por padrão do usuário é usada.
N
Exemplo de resposta:
204 Nenhum conteúdo
A resposta bem-sucedida está em branco com o código de status 204.
400 Solicitação inválida
A solicitação não foi compreendida pelo servidor.
401 Não autorizado
O usuário não está autorizado.
403 Forbidden
O usuário não tem permissões suficientes.
500 Erro interno do servidor
Erro interno do servidor.

PUBLICAR:

Solicitação:
/removeAccounts
Exclui as contas para os códigos de conta LR fornecidos.
Este ponto de extremidade está protegido pelo indicador de funcionalidade "
ENable_accounts_DELETION_JSON_API_2
" (atualmente DESATIVADO por padrão).
Oferece suporte a todas as contas que podem ser excluídas na interface de usuário. Ignora contas que não podem ser excluídas e pode fornecer avisos opcionais.
Exemplo de URI de solicitação:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAccounts
Cabeçalho de solicitação de amostra:
Autorização: básica
Content-Type: application/json
Corpo da solicitação de amostra
Exemplo de solicitação POST 

    {
        "accountCodesToDelete": ["Assets", "b"]
    }
Parâmetros de carga
Nome
Descrição
Obrigatório
accountCodesToDelete
Nome de Códigos de conta a ser excluído.
S
Parâmetro de caminho
Nome
Descrição
Obrigatório
tenant
Locatário no qual operar. por exemplo, globosales
S
Parâmetros de consulta
Nome
Descrição
Valor por padrão
Obrigatório
forceRemove
Exclui contas em uso.
false
N
showWarnings
Mostra avisos em resposta.
false
N
doValidateOnly
Habilita o modo de validação.
false
N
Avisos
account-deletion-warning=Algumas contas não foram excluídas.
warning-default-root=A conta raiz por padrão não pode ser excluída.
warning-sheet-root=O grupo raiz da planilha não pode ser excluído.
warning-cta-account=A conta de ajuste cumulativo de conversão não pode ser excluída.
warning-in-use=A conta Em uso não pode ser excluída porque forceRemove está definido como DESATIVADO.
warning-cannot_delete_mi_system_account=A conta do sistema de participação minoritária não pode ser excluída. Ela é usada no cálculo da participação minoritária para o método de consolidação total.
warning-cannot_delete_mi_net_income_account=A conta Renda líquida da participação minoritária não pode ser excluída. Ela é usada no cálculo da participação minoritária para o método de consolidação total.
warning-cannot_delete_mi_account_ancestor=A conta não pode ser excluída porque uma de suas contas descendentes é usada no cálculo da participação minoritária para o método de consolidação total.
warning-delete_criança_used_in_breakback-msg=A conta não pode ser excluída porque esta conta ou uma de suas descendentes é usada na redistribuição automática.
warning-cannot_delete_pcm_account=Use o Planning Configuration Manager para excluir esta conta.
warning-nonexistente-code=Esta conta não existe.
warning-ambiguous-code=Este código é compartilhado por várias contas.
Exemplo de resposta:
200 OK
 
{
    "total": 0
}
200 OK (com avisos)
 
{
    "total": 0,
    "warning": {
        "info": "Some accounts were not deleted.",
        "warnings": [
            {
                "field": "xyz",
                "warning": "This account does not exist."
            }
        ]
    }
}
400 Solicitação inválida
A solicitação não foi compreendida pelo servidor.
401 Não autorizado
O usuário não está autorizado.
403 Forbidden
O usuário não tem permissões suficientes/o indicador de funcionalidade está DESATIVADO. 
{
    "error": "Service Unavailable"
}
500 Erro interno do servidor
Erro interno do servidor.