Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
Konten

Konten

Version: v1

Unterstützte HTTP-VERB(s)

HTTP Verb
Beschreibung
POST
Löschen Sie die in der Anforderung genannten Konten.

POST:

Anfrage:
/removeGLAccounts:
Löscht die Konten für die angegebenen Hauptbuch-Kontocodes.
Dieser Endpunkt befindet sich hinter dem Feature Flag "
ENABLE_ACCOUNTS_DELETION_JSON_API
" (aktuell standardmäßig EIN).
Unterstützt alle Hauptbuch-Konten, die in der Benutzeroberfläche gelöscht werden können. Ignoriert Konten, die nicht gelöscht werden können.
Beispiel für eine Anforderungs-URI:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeGLAccounts
Beispiel für Anforderungs-Header:
Autorisierung: Basic
Inhaltsart: application/json
Beispielanforderungstext
POST-Beispielanforderung 
[
    {
        "accountCodesToDelete": ["Assets", "b"]
    }
]
Nutzlastparameter
Name
Beschreibung
Erforderlich
accountCodesToDelete
Name der zu löschenden Kontocodes
J
Pfadparameter
Name
Beschreibung
Erforderlich
Mandant
Mandant, auf dem Transaktionen ausgeführt werden sollen. z. B. Global Sales
J
Abfrageparameter
Name
Beschreibung
Erforderlich
forceRemove
Löscht verwendete Konten, wennforceRemove=true, und ignoriert verwendete Konten, wennforceRemove=false.
Standard ist immerforceRemove=false.
N
instanceCode
instanceCode, aus dem Werte abgerufen werden sollen. Beispiel: GLOBO. Wenn kein instanceCode angegeben wird, wird die Standardinstanz des Benutzers verwendet.
N
Beispielantwort:
204 Kein Inhalt
Erfolgreiche Antwort ist leer mit Statuscode 204.
400 Unzulässige Anforderung
Die Anforderung konnte vom Server nicht gelesen werden.
401: Nicht autorisiert
Benutzer ist nicht autorisiert.
403 Forbidden
Benutzer hat unzureichende Berechtigungen.
500 Interner Serverfehler
Interner Serverfehler.

POST:

Anfrage:
/removeAccounts
Löscht die Konten für die angegebenen Hauptbuch-Kontocodes.
Dieser Endpunkt befindet sich hinter dem Feature Flag "
ENABLE_ACCOUNTS_DELETION_JSON_API_2
" (aktuell standardmäßig AUS).
Unterstützt alle Konten, die in der Benutzeroberfläche gelöscht werden können. Workday ignoriert Konten, die nicht gelöscht werden können, und kann optionale Warnungen anzeigen.
Beispiel für eine Anforderungs-URI:
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/accounts/removeAccounts
Beispiel für Anforderungs-Header:
Autorisierung: Basic
Inhaltsart: application/json
Beispielanforderungstext
POST-Beispielanforderung 

    {
        "accountCodesToDelete": ["Assets", "b"]
    }
Nutzlastparameter
Name
Beschreibung
Erforderlich
accountCodesToDelete
Name der zu löschenden Kontocodes
J
Pfadparameter
Name
Beschreibung
Erforderlich
Mandant
Mandant, auf dem Transaktionen ausgeführt werden sollen. z. B. Global Sales
J
Abfrageparameter
Name
Beschreibung
Standard
Erforderlich
forceRemove
Löscht verwendete Konten.
false
N
ShowWarnings
Als Reaktion werden Warnungen angezeigt.
false
N
doValidateOnly
Aktiviert den Validierungsmodus.
false
N
Warnungen
account-deletion-Warning = Einige Konten wurden nicht gelöscht.
Warnung-Standard-Root=Standard-Root-Konto kann nicht gelöscht werden.
Warnung-Tabellenblatt-Root=Tabellenblatt-Root-Gruppe kann nicht gelöscht werden.
warning-cta-account=Konto für kumulative Umrechnungsanpassung kann nicht gelöscht werden.
warning-in-use=Konto in Verwendung kann nicht gelöscht werden, daforceRemove auf AUS gesetzt ist.
warning-cannot_delete_mi_system_account=Systemkonto für Minderheitenanteile kann nicht gelöscht werden. Es wird in der Berechnung von Minderheitenanteilen beim vollständigen Konsolidierungsverfahren verwendet.
warning-cannot_delete_mi_net_income_account=Konto für den Nettoertrag von Minderheitenanteilen kann nicht gelöscht werden. Es wird in der Berechnung von Minderheitenanteilen beim vollständigen Konsolidierungsverfahren verwendet.
warning-cannot_delete_mi_account_ancestor=Das Konto kann nicht gelöscht werden, da eines seiner Nachfolger-Konten bei der Berechnung des Minderheitenanteils für die Methode „Vollständige Konsolidierung“ verwendet wird.
warning-delete_Child_used_in_breakback-msg = Das Konto kann nicht gelöscht werden, da dieses Konto oder einer seiner Nachfolger in „Auto-Breakback“ verwendet wird.
warning-cannot_delete_pCM_account=Verwenden Sie den Planning Configuration Manager, um dieses Konto zu löschen.
warning-nonexistent-code=Dieses Konto ist nicht vorhanden.
Warnung-Mehrwertigkeitscode=Dieser Code wird von mehreren Konten geteilt.
Beispielantwort:
200 OK
 
{
    "total": 0
}
200 OK (mit Warnungen)
 
{
    "total": 0,
    "warning": {
        "info": "Some accounts were not deleted.",
        "warnings": [
            {
                "field": "xyz",
                "warning": "This account does not exist."
            }
        ]
    }
}
400 Unzulässige Anforderung
Die Anforderung konnte vom Server nicht gelesen werden.
401: Nicht autorisiert
Benutzer ist nicht autorisiert.
403 Forbidden
Benutzer hat unzureichende Berechtigungen/Feature Flag ist AUS. 
{
    "error": "Service Unavailable"
}
500 Interner Serverfehler
Interner Serverfehler.