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

Verbe HTTP
Description
POST
Supprimez les comptes mentionnés dans la demande.

POST :

Demande :
/removeGLAccounts:
Supprime les comptes pour les codes de compte GL donnés.
Ce point de terminaison se trouve derrière l'indicateur de fonctionnalité "
Enable_ACCOUNTS_DOLEATION_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.
Exemple d'URI de demande :
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeGLAccounts
Exemple d'en-tête de demande :
Autorisation : base
Type de contenu : application/json
Exemple de corps de demande
Exemple de demande POST 
[
    {
        "accountCodesToDelete": ["Assets", "b"]
    }
]
Paramètres des données utiles
Nom
Description
Obligatoire
accountCodesToDelete
Les codes de compte à supprimer sont nommés.
O
Paramètre de chemin
Nom
Description
Obligatoire
tenant
Environnement client sur lequel opérer les opérations. par exemple globalales
O
Paramètres de requête
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 les valeurs. Par exemple, GLOBO. Si aucun code d'instance n'est spécifié, 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.
400 Demande incorrecte
La demande n'a pas pu être comprise par le serveur.
401 Non autorisé
L'utilisateur n'est pas autorisé.
403 interdit
L'utilisateur ne dispose pas des autorisations requises.
500 Erreur interne du serveur
Erreur interne du serveur.

POST :

Demande :
/removeAccounts
Supprime les comptes pour les codes de compte GL donnés.
Ce point de terminaison se trouve derrière l'indicateur de fonctionnalité "
EN Active_ACCOUNTS_DOLEATION_JSON_API_2
" (actuellement désactivé par défaut 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 qui peuvent fournir des avertissements facultatifs.
Exemple d'URI de demande :
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAccounts
Exemple d'en-tête de demande :
Autorisation : base
Type de contenu : application/json
Exemple de corps de demande
Exemple de demande POST 

    {
        "accountCodesToDelete": ["Assets", "b"]
    }
Paramètres des données utiles
Nom
Description
Obligatoire
accountCodesToDelete
Les codes de compte à supprimer sont nommés.
O
Paramètre de chemin
Nom
Description
Obligatoire
tenant
Environnement client sur lequel opérer les opérations. par exemple globalales
O
Paramètres de requête
Nom
Description
Par défaut
Obligatoire
forceRemove
Supprime les comptes en cours d'utilisation.
false
N
showWarnings
Affiche les avertissements en réponse.
false
N
doValidateOnly
Active le mode validation.
false
N
Avertissements
account-deletion-Warning=Certains comptes n'ont pas été supprimés.
Avertissement-default-racine=Le compte racine par défaut ne peut pas être supprimé.
Avertissement-sheet- root= Le groupe racine de la feuille ne peut pas être supprimé.
Avertissement-cta-account=le compte Écarts de conversion cumulés ne peut pas être supprimé.
Le compte Avertissement-in-Use=En cours d'utilisation ne peut pas être supprimé car forceRetirer est désactivée.
Avertissement-cannot_delete_mi_system_account=Le compte système 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 par intégration globale.
Avertissement-cannot_delete_mi_net_ Income_account=Le compte Résultat net des 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 par intégration globale.
Avertissement-cannot_delete_mi_account_ancestor=Ce compte ne peut pas être supprimé car l'un de ses comptes descendants est utilisé dans le calcul des intérêts minoritaires pour la méthode de la consolidation par intégration globale.
Nom de l'un de ses descendants utilisé dans la répartition automatique
Avertissement-cannot_delete_pCM_account=Utilisez le Planning Configuration Manager pour supprimer ce compte.
Avertissement-inexistant-code=Ce compte n'existe pas.
Avertissement- Affective-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."
            }
        ]
    }
}
400 Demande incorrecte
La demande n'a pas pu être comprise par le serveur.
401 Non autorisé
L'utilisateur n'est pas autorisé.
403 interdit
L'utilisateur a des autorisations insuffisantes/l'indicateur de fonctionnalité est désactivé. 
{
    "error": "Service Unavailable"
}
500 Erreur interne du serveur
Erreur interne du serveur.