Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
Ultimo aggiornamento: 2023-06-23
Conti

Conti

Versione: v1

VERBI HTTP supportati

Verbo HTTP
Descrizione
POST
Eliminare i conti menzionati nella richiesta.

POST:

Richiesta:
/removeGLAccounts:
Elimina i conti per i codici conto CoGe specificati.
Questo endpoint si trova dietro il flag della funzionalità "
ENABLE_ACCOUNTS_DELETION_JSON_API
" (attualmente ATTIVO per impostazione predefinita).
Supporta tutti i conti CoGe che possono essere eliminati nell'interfaccia utente. Ignora i conti che non possono essere eliminati.
URI richiesta di esempio:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeGLAccounts
Intestazione richiesta di esempio:
Autorizzazione: di base
Content-Type: application/json
Esempio di corpo richiesta
Richiesta POST di esempio 
[
    {
        "accountCodesToDelete": ["Assets", "b"]
    }
]
Parametri del carico utile
Nome
Descrizione
Obbligatorio
accountCodesToDelete
Codici conto da eliminare
S
Parametro percorso
Nome
Descrizione
Obbligatorio
tenant
Tenant su cui operare es. globosales
S
Parametri query
Nome
Descrizione
Obbligatorio
forceRemove
Elimina i conti in uso quando forceRemove=true e ignora i conti in uso quando forceRemove=false.
Il valore predefinito è sempre forceRemove=false.
N
instanceCode
instanceCode da cui recuperare i valori. Ad esempio, GLOBO. Se non viene specificato instanceCode, viene utilizzata l'estensione predefinita dell'utente.
N
Risposta di esempio:
204 Nessun contenuto
La risposta corretta è vuota con codice di stato 204.
400 Richiesta non valida
Impossibile interpretare la richiesta dal server.
401 Non autorizzato
L'utente non è autorizzato.
403 Forbidden
L'utente non dispone di autorizzazioni sufficienti.
500 Errore interno del server
Errore interno del server.

POST:

Richiesta:
/removeAccounts
Elimina i conti per i codici conto CoGe specificati.
Questo endpoint si trova dietro il flag della funzionalità "
ENABLE_ACCOUNTS_DELETION_JSON_API_2
" (attualmente DISATTIVATO per impostazione predefinita).
Supporta tutti gli account che possono essere eliminati nell'interfaccia utente. Ignora i conti che non possono essere eliminati e può fornire avvisi facoltativi.
URI richiesta di esempio:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAccounts
Intestazione richiesta di esempio:
Autorizzazione: di base
Content-Type: application/json
Esempio di corpo richiesta
Richiesta POST di esempio 

    {
        "accountCodesToDelete": ["Assets", "b"]
    }
Parametri del carico utile
Nome
Descrizione
Obbligatorio
accountCodesToDelete
Codici conto da eliminare
S
Parametro percorso
Nome
Descrizione
Obbligatorio
tenant
Tenant su cui operare es. globosales
S
Parametri query
Nome
Descrizione
Predefinita
Obbligatorio
forceRemove
Elimina i conti in uso.
falso
N
showWarnings
Mostra gli avvisi in risposta.
falso
N
doValidateOnly
Abilita la modalità di convalida.
falso
N
Avvisi
account-deletion-warning=Alcuni conti non sono stati eliminati.
warning-default-root=Impossibile eliminare l'account radice predefinito.
warning-sheet-root=Impossibile eliminare il gruppo radice del foglio.
warning-cta-account=Impossibile eliminare il conto di rettifica conversione cumulativa.
warning-in-use=Impossibile eliminare l'account in uso perché forceRemove è impostato su OFF.
warning-cannot_delete_mi_system_account=Impossibile eliminare il conto del sistema partecipazione di minoranza. Viene utilizzato nel calcolo della partecipazione di minoranza per il metodo di consolidamento completo.
warning-cannot_delete_mi_net_income_account=Il conto Utile netto partecipazione di minoranza non può essere eliminato. Viene utilizzato nel calcolo della partecipazione di minoranza per il metodo di consolidamento completo.
warning-cannot_delete_mi_account_ancestor=Il conto non può essere eliminato perché uno dei conti discendenti viene utilizzato nel calcolo della partecipazione di minoranza per il metodo Consolidamento completo.
warning-delete_child_used_in_breakback-msg=Il conto non può essere eliminato perché questo conto o uno dei suoi discendenti viene utilizzato nella ripartizione automatica.
warning-cannot_delete_pcm_account=Utilizzare Planning Configuration Manager per eliminare il conto.
warning-nonesistente-code=Questo conto non esiste.
warning-ambiguous-code=Questo codice è condiviso da più conti.
Risposta di esempio:
200 OK
 
{
    "total": 0
}
200 OK (con avvisi)
 
{
    "total": 0,
    "warning": {
        "info": "Some accounts were not deleted.",
        "warnings": [
            {
                "field": "xyz",
                "warning": "This account does not exist."
            }
        ]
    }
}
400 Richiesta non valida
Impossibile interpretare la richiesta dal server.
401 Non autorizzato
L'utente non è autorizzato.
403 Forbidden
L'utente non dispone di autorizzazioni sufficienti/il flag della funzionalità è DISATTIVATO. 
{
    "error": "Service Unavailable"
}
500 Errore interno del server
Errore interno del server.