Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Comptes

Comptes

Version : v1

VERB(s) HTTP pris en charge

Configurer HTTP HTTP
Description
POST
Supprimez les comptes indiqués dans la demande.

POST :

Demande :
/removeGLAccounts:
Supprime les comptes pour les codes de compte GL donnés.
Ce point de terminaison est associé à l'indicateur de la fonction «
Active_ACCOUNTS_DÉLECTION_JSON_API
» (actuellement ACTIVÉ par défaut).
Prend en charge tous les comptes GL pouvant être supprimés dans l'interface utilisateur. Ignore les comptes qui ne peuvent pas être supprimés.
URI de la demande exemple :
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeGLAccounts
En-tête de demande d’exemple :
Autorisation : De base
Type de contenu : application/json
Corps de la demande d'exemple
Demande d'exemple de POST 
[
    {
        "accountCodesToDelete": ["Assets", "b"]
    }
]
Paramètres des données utiles
Nom
Description
Obligatoire
accountCodesToDelete
Codes de compte à supprimer.
Y
Paramètre de chemin
Nom
Description
Obligatoire
tenant
Locataire sur lequel effectuer l’exploitation. ex. achat global
Y
Paramètres d'interrogation
Nom
Description
Obligatoire
forceRemove
Supprime les comptes en cours d’utilisation lorsque forceRemove=true et ignore les comptes en cours d’utilisation lorsque forceRemove=false.
La valeur par défaut est toujours forceRemove=false.
N
instanceCode
InstanceCode à partir de laquelle extraire des valeurs. Par exemple, GLOBO. Si aucune instanceCode n’est indiquée, l’instance par défaut de l’utilisateur est utilisée.
N
Exemple de réponse :
204 Aucun contenu
La réponse réussie est vide avec le code de statut 204.
Demande de type 400 Mauvais
La demande n'a pas pu être comprise par le serveur.
401 non autorisé
L’utilisateur n’est pas autorisé.
403 - Interdit
L'utilisateur dispose d'autorisations insuffisantes.
Erreur de serveur interne 500
Erreur de serveur interne.

POST :

Demande :
/removeAccounts
Supprime les comptes pour les codes de compte GL donnés.
Ce point de terminaison est associé à l'indicateur de la fonctionnalité
ENable_ACCOUNTS_DÉLECTION_JSON_API_2
(actuellement désactivé par défaut).
Prend en charge tous les comptes pouvant être supprimés dans l'interface utilisateur. Ignore les comptes qui ne peuvent pas être supprimés et peut fournir des avertissements facultatifs.
URI de la demande exemple :
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAccounts
En-tête de demande d’exemple :
Autorisation : De base
Type de contenu : application/json
Corps de la demande d'exemple
Demande d'exemple de POST 

    {
        "accountCodesToDelete": ["Assets", "b"]
    }
Paramètres des données utiles
Nom
Description
Obligatoire
accountCodesToDelete
Codes de compte à supprimer.
Y
Paramètre de chemin
Nom
Description
Obligatoire
tenant
Locataire sur lequel effectuer l’exploitation. ex. achat global
Y
Paramètres d'interrogation
Nom
Description
Par défaut
Obligatoire
forceRemove
Supprime les comptes en cours d’utilisation.
faux
N
showWarnings
Affiche des avertissements en réponse.
faux
N
doValidateOnly
Active le mode validation.
faux
N
Avertissements
account-deletion-avertissement Certains comptes n'ont pas été supprimés.
error-Default- Définissez qu'un compte racine par défaut ne peut pas être supprimé.
Avertissement-sheet- Défini
Avertissement-cta-account= Le compte d’ajustement de conversion cumulé ne peut pas être supprimé.
Avertissement-in-use=Le compte en cours d'utilisation ne peut pas être supprimé car l'option forceRemove est désactivée.
Avertissement-cannot_delete_mi_system_account=Le compte de système d'intérêts minoritaires ne peut pas être supprimé. Il est utilisé dans le calcul des intérêts minoritaires avec la méthode de consolidation complète.
prépaiement Il est utilisé dans le calcul des intérêts minoritaires avec la méthode de consolidation complète.
Avertissement-cannot_delete_mi_account_ancestor=Le compte ne peut pas être supprimé parce que l'un de ses comptes descendants est utilisé dans le calcul de la participation minoritaire pour la méthode de consolidation complète.
Avertissement-delete_enfant_utilisé_in_breakback-msg=Le compte ne peut pas être supprimé puisque ce compte ou l'un de ses descendants est utilisé dans Auto Auto Rupture.
Avertissement-cannot_delete_pcm_account=Utilisez le gestionnaire de configuration Planning pour supprimer ce compte.
Avertissement-nonexistant-code=Ce compte n'existe pas.
error-arrondi-code=Ce code est partagé par plusieurs comptes.
Exemple de réponse :
200 OK
 
{
    "total": 0
}
200 OK (avec avertissements)
 
{
    "total": 0,
    "warning": {
        "info": "Some accounts were not deleted.",
        "warnings": [
            {
                "field": "xyz",
                "warning": "This account does not exist."
            }
        ]
    }
}
Demande de type 400 Mauvais
La demande n'a pas pu être comprise par le serveur.
401 non autorisé
L’utilisateur n’est pas autorisé.
403 - Interdit
L'utilisateur dispose d'autorisations insuffisantes/l'indicateur de fonction est désactivé. 
{
    "error": "Service Unavailable"
}
Erreur de serveur interne 500
Erreur de serveur interne.