updateAccounts

HTTP	Beschreibung
Method	Post
Content-Type	text/xml

Beispiel für Locken


curl -H "Content-Type: text/xml" -d @C:/temp/updateAccounts.xml -X POST https://api.adaptiveplanning.com/api/v20

updateAccounts.xml contents

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateAccounts" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"/>
<accounts proceedWithWarnings="0">
<account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets"
displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1"
exchangeRateType="E" isIntercompany="0" planBy="DELTA" timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE"
subType="CUMULATIVE" enableActuals="1">
<account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets"
displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1"
exchangeRateType="E" isIntercompany="0" planBy="DELTA"
timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE"
subType="CUMULATIVE" enableActuals="1" propagateToDescendants="1">
  <attribute name="SEC Reporting" value="Yes" />
  <attribute name="GAAP Reporting" value="No" />
</account>
</account>
</accounts>
</call>

Bei großen Nutzlasten können Sie zusammengefasste XML-Dateien (gezippt) hochladen. Wie das geht, erfahren Sie hier.

Die folgenden Bedingungen gelten für updateAccounts:

Konten werden für die Aktualisierung über ihre interne ID-Nummer identifiziert.

Um neue Konten zu erstellen, geben Sie diesen eine leere oder fehlende ID-Eigenschaft.

Sie können ein vorhandenes (nicht neues) Element verschieben, sodass es zu einem untergeordneten Element eines neuen Elements wird. Dadurch wird das neue Element erstellt und das vorhandene Element wird als untergeordnetes Element darunter verschoben.

Für API v31 und höher können Sie ein neues übergeordnetes Konto zwischen einem vorhandenen übergeordneten und seinen untergeordneten Konten erstellen.

Neue übergeordnete Konten festlegen

updateAccounts

wird ausgeführt, wenn der Attributwert für ein untergeordnetes Attribut nicht mit dem neuen übergeordneten Attribut kompatibel ist. Beispiel: Das Attribut „reparentedAccount1“ hat den Wert „SEC Reporting“ = „Nein“ und ist nicht kompatibel, weil das Attribut „newParentAccount2“ den Wert „Ja“ hat.

updateAccounts

korrigiert nicht kompatible Attributwerte, damit sie beim Festlegen eines neuen übergeordneten Elements mit dem neuen übergeordneten Attribut übereinstimmen, wenn

proceedWithWarnings=1.

Für Konten, die ein neues übergeordnetes Konto festlegen, kann keine zyklische Beziehung hergestellt werden.

Für vom System generierte Root-Konten ist ein neues übergeordnetes Konto nicht zulässig:

Assets, Liabilities and Equities, Net Income, PL Income, Non-Operating Income, PL COGS, PL Expense, Non-Operating Expenses

.

Abhängig von der API-Version:

updateAccounts

ermöglicht das Erstellen eines neuen übergeordneten Kontos zwischen einem vorhandenen übergeordneten und seinen untergeordneten Konten:

Quellkonto	Verschoben unter	API v30 und niedriger	API v31 +
root	root	verhindert	verhindert
root	Übergeordnetes Element	verhindert	verhindert
root	Blatt	verhindert	verhindert
Übergeordnetes Element	root	zulässig	zulässig
Übergeordnetes Element	Übergeordnetes Element	zulässig	zulässig
Übergeordnetes Element	ein vorhandenes Leaf als erstes untergeordnetes Element	verhindert	verhindert
Übergeordnetes Element	ein vorhandenes Leaf als nicht erstes untergeordnetes Element	zulässig	zulässig
Übergeordnetes Element	ein neues erstes Konto, das einem vorhandenen übergeordneten Konto untergeordnet ist	verhindert	zulässig
Übergeordnetes Element	ein neues, nicht erstes Konto, das einem vorhandenen übergeordneten Konto untergeordnet ist	zulässig	zulässig
Blatt	root	zulässig	zulässig
Blatt	Übergeordnetes Element	zulässig	zulässig
Blatt	ein vorhandenes Leaf als erstes untergeordnetes Element	verhindert	verhindert
Blatt	ein vorhandenes Leaf als nicht erstes untergeordnetes Element	zulässig	zulässig
Blatt	ein neues erstes Konto, das einem vorhandenen übergeordneten Konto untergeordnet ist	verhindert	zulässig
Blatt	ein neues, nicht erstes Konto, das einem vorhandenen übergeordneten Konto untergeordnet ist	zulässig	zulässig
Blatt	ein neues erstes Konto, das einem vorhandenen Leaf untergeordnet ist	verhindert	verhindert
Blatt	ein neues, nicht erstes Konto, das einem vorhandenen Leaf untergeordnet ist	zulässig	zulässig

Untergeordnete Leaf-Konten

Das erste untergeordnete Element eines Leaf-Kontos kann nur ein neues Konto sein. Ein vorhandenes Hauptbuch-Konto kann nicht unter ein vorhandenes Leaf-Konto verschoben werden.

Wenn ein Konto beim Festlegen eines neuen übergeordneten Kontos sein erstes untergeordnetes Element erhält, wird das Konto-Mapping unter Integration > Importkonto-Mappings gelöscht.

Wenn Sie für Konten ein neues übergeordnetes Konto festlegen,

balanceType

und

subType

-Eigenschaften werden von ihrem übergeordneten Hauptbuch-Konto geerbt.

Cube-Konten und Cube-Eingabedaten

Für Konten mit Cube-Eingabe kann ein neues übergeordnetes Konto festgelegt werden.

Nur Konten, die keine Daten mit Cube-Eingabe in ihren Quell- und Zielunterbäumen haben, können als neue übergeordnete Konten festgelegt werden.

Für CUBE-/GEMIESE Konten kann kein neues übergeordnetes Konto festgelegt werden.

Neue Konten unter einem CUBE-ACCOUNT sind nicht zulässig. Neue Konten unter einem STANDARD-/MISCHKonten sind zulässig.

Anforderungsformat für die Erstellung eines neuen Kontos

Um ein neues Konto zu erstellen, geben Sie das übergeordnete Konto anhand der ID an. Um z. B. ein neues untergeordnetes Konto unter L hinzuzufügen

ocalAssets

Konto, das hat

id 1441

können Sie Folgendes verwenden:


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateAccounts" callerName="Steve C">
<credentials login="sampleuser@company.com" password="my_password"/>
<accounts>
 <account id="1441">
   <account id="" code="newLocalAssets" name="new Local Assets" description="new local assets account for this area" shortName="" >
   </account>
 </account>
</accounts>
</call>

Diese Methode ändert nichts am Konto

id 1441

. Es wird ein neues untergeordnetes Element mit dem Namen erstellt

new Local Assets

für

id 1441

. Alle nicht erwähnten untergeordneten Elemente von

LocalAssets

an das Ende der untergeordneten Liste verschoben. Dies entspricht der Festlegung des übergeordneten Kontos für das neue Konto.

Verarbeitung mehrerer Umbenennungen in einem einzigen updateAccounts-Aufruf

Zwischendurch können mehrere Umbenennungen derselben Entität in einem Remote-System stattfinden

updateAccounts

-Anrufe. Die Namen von Entitäten im Remote-System können durch dieselben Entitäts-IDs ersetzt werden. Wann

updateAccounts

-Aufrufe erfolgen nach dem Namenstausch

updateAccounts

aufrufen verwaltet diese Änderungen, indem die IDs bei Namensänderungen verfolgt werden. Der Aufruf kann auch die Einführung einer neuen ID verarbeiten, die einen vorhandenen Namen verwendet.

Damit jedes der Beispiele erfolgreich ist, muss der vollständige Tausch der IDs mit den eindeutigen Werten erfolgen.

Beispiel 1: Ein einfacher Namenstausch im Remote-System.


ID     Unique Value   New Unique Value
1      AA             BB
2      BB             AA

Beispiel 2: Eine Sequenz von drei Umbenennungen im Remote-System.


ID     Unique Value   New Unique Value
1      AA             BB
2      BB             CC
3      CC             AA

Beispiel 3: Eine neue Entität, die einen vorhandenen eindeutigen Wert verwendet.


ID     Unique Value   New Unique Value
4                     AA
1      AA             BB
2      BB             Old BB

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann erfolgreich ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
anmelden	J	Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen.	sampleuser@company.com
Kennwort	J	Das Kennwort des Benutzers, der die API-Methode aufruft.	my_password
Gebietsschema	N	Geben Sie das Gebietsschema an, das verwendet werden soll, um eingehende Zahlen und Datumsangaben zu interpretieren und ausgehende Zahlen und Datumsangaben zu formatieren (mit dem entsprechenden Tausendertrennzeichen, den Monatsnamen und der Datumsformatierung). Das Gebietsschema wird auch verwendet, um die Sprache anzugeben, in der Systemmeldungen in der Antwort angezeigt werden sollen. Wenn nicht angegeben, wird en_US (amerikanisches Englisch) verwendet.	fr_FR
instanceCode	N	Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von Adaptive Planning hat, kann dieses Attribut verwendet werden, um anzugeben, dass der Benutzer auf eine andere Instanz als seine Standardinstanz zugreifen möchte. Wenn nicht angegeben, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln.	MYINSTANCE1
Inhalt des Elements
(Keine)

Kontenelement
Tag-Name		Konten
Beschreibung		Pro Nutzlast ist nur eine Kontoelementanforderung zulässig. Es enthält ein oder mehrere Kontoelemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
proceedWithWarnings	N	proceedWithWarnings="1" gibt an, dass die updateAccounts-API die Attribute und Eigenschaften des Kontos basierend auf Änderungen der übergeordneten Ebene anpassen soll. proceedWithWarnings = "0" gibt an, dass die updateAccounts API die Attribute und Eigenschaften eines Kontos nicht basierend auf Änderungen der übergeordneten Ebene anpassen sollte. Der Fehler UpdateAccounts wird mit einer Meldung beendet, die den Fehlergrund übermittelt. Beispielsweise wird das Attribut-Mapping nach einem neuen übergeordneten Element ungültig. Standardwert ist 0, falls vorhanden.	1
RetainExistingOrder Verfügbar in API v26 +	N	RetainExistingOrder = "1" gibt an, dass die updateAccounts-API die Reihenfolge der Elemente in der XML-Nutzlast ignorieren soll und die vorhandene definierte Reihenfolge beibehalten wird. RetainExistingOrder = "0" gibt an, dass die updateAccounts-API die Reihenfolge der Elemente basierend auf der Tag-Position relativ zu anderen gleichgeordneten Elementen in der XML-Nutzlast aktualisieren soll. Das Attribut „retainExistingOrder“ wird in API-Versionen vor API v26 ignoriert. Der Standardwert für RetainExistingOrder ist für Version 26 „0“. Für die API-Versionen v27 und höher ist der Standardwert für behältExistingOrder „1“.	1
displayNameEnabled Nur in API v32 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	N	displayNameEnabled=1 gibt an, dass updateAccounts die Eigenschaften des Anzeigenamens von berücksichtigen soll code , displayNameType , und description wenn Enable Anzeige Name für die Instanz EIN ist. displayNameEnabled=0 gibt an, dass die updateAccounts API weiterhin den API-Vertrag vor v32 befolgen soll, auch wenn "Anzeigename aktivieren" für die Instanz auf EIN gesetzt ist. Die updateAccounts-API ignoriert die Eigenschaften des Anzeigenamens code , displayNameType und description . Der Standardwert für displayNameEnabled ist „0“.	1
Inhalt des Elements
Enthält ein oder mehrere Kontoelemente.

Kontoelement
Tag-Name		account
Beschreibung		Gibt ein zu erstellendes Konto an.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne System-ID-Nummer des Kontos.	16
-Code	N	Der Code des Kontos, nur alphanumerische Zeichen und Unterstriche. Sollte kein Code-Attribut für Kontogruppen angeben.	Cur_Assets
Name	J	Der Name des Kontos, wie er in Berichten und Tabellenblättern angezeigt wird.	Kurzfristige Vermögenswerte
shortName	N	Der Kurzname des Kontos.	CA
Beschreibung	N	Die Textbeschreibung des Kontos. Maximale Zeichenlänge ist 2048.	Summe kurzfristige Vermögenswerte
subType	N	Gibt an, ob das Konto periodisch oder kumulativ ist. Wenn ein Konto periodisch ist, entspricht sein Wert in einem bestimmten Monat der Nettoaktivität für den Monat. Beispiele hierfür sind Ertrags- und Aufwandskonten. Wenn ein Konto kumulativ ist, entspricht sein Wert dem Endsaldo für einen bestimmten Monat. Dies ist der Wert des vorherigen Monats plus oder minus Aktivitäten im angegebenen Monat. Konten der Bilanz sind kumulativ. Dies ist für Kontogruppen und Metrikkonten leer. Schreibgeschützt, wird basierend auf dem übergeordneten Konto identifiziert.	Kumulativ
planBy	N	Gibt für kumulative Konten an, ob das Konto eine Planung nach Saldo (BALANCE) oder eine Planung nach Delta (DELTA) ist. Der Standardwert ist DELTA. Eine Änderung des Plans nach DELTA ist NICHT zulässig, wenn das Konto Splits in Nicht-Istzahlen-Versionen enthält. Gilt nur für Leaf-Konten. updateAccounts wird beendet, wenn der Benutzer versucht, planBy für ein Nicht-Leaf-Konto festzulegen.	DELTA
Istzahlennach	N	Gibt für kumulative Konten an, ob es sich bei dem Konto um Istzahlen nach Saldo (BALANCE) oder Istzahlen nach Delta (DELTA) handelt. Die Standardvorgabe ist BALANCE. Gilt nur für Leaf-Konten. updateAccounts wird beendet, wenn der Benutzer versucht, IstzahlenBy für ein Nicht-Leaf-Konto festzulegen.	BSALDO
enableActuals	N	0, um nur Plandaten für das Konto anzuzeigen. 1, um Istzahlen in das Konto zu importieren. Bei verknüpften Konten werden durch 0 nur dann Istzahlen angezeigt, wenn das verknüpfte Konto sie enthält, und 1 aktiviert Istzahlen für das verknüpfte Konto. Dies ist für Kontogruppen und Metrikkonten leer. Die Verwaltungsoberfläche des Hauptbuchs in Planning verwendet den Begriff "Istzahlen-Überlagerung". Der Standardwert ist 0, wenn das aktuelle Konto eine Gruppe ist. Der Standardwert ist 1, wenn das aktuelle Konto ein Leaf ist	1
balanceType Aktualisiert in API v33	N	Gibt die Saldoart eines Kontos an: Soll oder Haben. Die Saldoart ist leer, wenn dem Konto keine Saldoart zugeordnet ist. Nur Hauptbuch-Konten haben eine Saldoart. Für API v32 und älter istbalanceType eine schreibgeschützte Eigenschaft, die im übergeordneten Konto identifiziert wird. Bei API v33 + verwenden untergeordnete Konten möglicherweise eine andere Saldoart als ihre übergeordneten Konten.	HABEN
timeStratum	N	Der Code der Zeitschicht des Kontos. Bei modellierten Konten und Cube-Konten wird dies vom Tabellenblatt des Kontos geerbt, das dem Konto gehört. Siehe: Schritte: Kalender ändern finden Sie weitere Informationen zur Zeitstruktur und zu Zeitperiodencodes. Schreibgeschützte Eigenschaft, ausgewählt aus Zeitstruktur, modelliertem oder Cube-Tabellenblatt.	month
displayAs	N	Anzeigeeinstellung für die Ausgabe des Kontos: Zahl, WÄHRUNG oder PROZENTSATZ. Wird nur für Konten bereitgestellt, die in der Kontoverwaltung eine Eigenschaft „Anzeigen als“ haben. Schreibgeschützte Eigenschaft für Hauptbuch-Konten.	NUMBER
decimalPrecision	N	Die Anzahl der Dezimalstellen, die für Zahlen in diesem Konto angezeigt werden sollen. Der Sonderwert 99 gibt ein verknüpftes Konto an, das die Dezimalgenauigkeit seines Ziels erbt. Der Wert -1 gibt an, dass das Konto ein Währungskonto ist und die Genauigkeit der angezeigten Währung verwendet. Zulässige Werte: -1, 0, 1-9, 99 Standard ist 0.	0
exchangeRateType	N	Nur vorhanden für Instanzen mit aktivierten mehreren Währungen und für Konten mit displayAs="CURRENCY". Mögliche Werte: Alle in der Instanz vorhandenen Codes für die Wechselkursart, wie unter „Währungen verwalten“ konfiguriert. „A“ = Monatlicher Durchschnitt, „E“ = Ende des Monats. Falls nicht vorhanden, verwenden Sie A für periodisch und E für kumulativ.	E
unterdrücken von Nullen	N	Gibt an, ob Benutzer mit dem Konto Nullen in Tabellenblättern unterdrücken können. Bei 0 können Benutzer Nullen nicht unterdrücken. Bei 1 können Benutzer Nullen unterdrücken. Wird nur für Konten bereitgestellt, bei denen in der Kontenverwaltung die Eigenschaft „In Tabellenblättern unterdrücken“ aktiviert ist. Wenn kein Wert vorhanden ist, wird der Standardwert auf 1 gesetzt.	1
startExpanded	N	Gibt an, ob ein Konto und seine untergeordneten Konten beim ersten Laden des Tabellenblatts in einem eingeblendeten Status beginnen. Gilt nur für übergeordnete Konten. „1“ für eingeblendet, „0“ für ausgeblendet. Wenn kein Wert vorhanden ist, wird der Standardwert auf 1 gesetzt.	1
dataEntryType aktualisiert in API v29	N	Gibt die Dateneingabeart für ein Leaf-Konto an. Entweder STANDARD oder CUBE. Wenn der übergeordnete Wert dataEntryType CUBE ist, wird als Standard für ein neues Konto dataEntryType CUBE festgelegt. Andernfalls wird als Standardwert für neue Konten die Dateneingabeart STANDARD festgelegt. Änderungen des Dateneingabetyps für Nicht-Leaf-Konten werden ignoriert. Das System berechnet automatisch neue Dateneingabeart für alle Nicht-Leaf-Konten. API v29 und höher unterstützen das Hinzufügen neuer Konten mit dataEntryType=CUBE.	STANDARD
hasSalaryDetail	N	Gibt an, ob dieses Konto Splits enthält, für die zur Anzeige die Berechtigung „Zugriff auf Gehaltsdetails“ erforderlich ist. Leer, wenn für dieses Konto nicht zutreffend. hasSalaryDetail = 1 ist für Kontogruppen-/Nicht-Leaf-Konten nicht zulässig. To make hasSalaryDetail=1: dataEntryType muss STANDARD sein accountType muss Hauptbuch sein Wird beendet, wenn dataEntryType NOT STANDARD ist. Wird beendet, wenn dataEntryType = 1 für Nicht-Leaf-Konten. Bei Nicht-Hauptbuch- und benutzerdefinierten Konten werden Fehler angezeigt.	1
dataPrivacy	N	Gibt die Ebenen an, die die Werte des Kontos beim Schreiben von Formeln auf anderen Ebenen öffentlich sind und abgerufen werden können. PRIVAT gibt an, dass die Werte des Kontos privat sind. PUBlic_TOP gibt an, dass die Werte des Kontos nur auf der obersten Ebene öffentlich sind, oder PUBlic_ALL, sodass die Werte des Kontos auf allen Ebenen öffentlich sind. Annahmen sind immer öffentlich und haben keine Einstellung dataPrivacy. Wenn keine Angabe vorhanden ist, wird als Standard PRIVAT festgelegt. Zugehörige Fehler für Kontogruppe und Annahmekonten.	PRIVAT
isIntercompany	N	Gibt an, ob das Konto ein Intercompany-Konto ist oder nicht. Änderungen an der Eigenschaft „isIntercompany“ werden nicht unterstützt.	0
propagateToDescendants	N	Gibt die Weitergabe von Änderungen des Attribut-Mappings an Nachfolger an. Wenn kein Wert vorhanden ist, wird der Standardwert auf 0 gesetzt. Wird beendet, wenn leer oder wenn ein anderer Wert als "1" oder "0" vorhanden ist. Eigenschaften, die an Nachfolger weitergegeben werden: subType planBy displayAs Istzahlennach decimalPrecision exchangeRateType accountTypeCode	1
Inhalt des Elements
Ein optionales Attributelement, wenn Sie ein oder mehrere mit dem Konto verknüpfte Kontoattribute bearbeiten möchten.

Attributelement
Tag-Name		Attribut
Beschreibung		Gibt ein zu aktualisierendes Attribut an. Taggt das Konto mit dem Attribut, wenn das Modell Kontoattribute hat.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Der Name des Attributs. Wird ausgeführt, wenn der Name im System noch nicht vorhanden ist. Wird mit einem Fehler beendet, wenn der Name vorhanden ist, das Attribut aber kein Kontoattribut ist. Wird beendet, wenn der Attributname leer ist oder fehlt.	Standort
Wert aktualisiert in API v34	J	Der Attributwert für dieses Attribut. Ermöglicht entweder einem leeren Wert das Entfernen des aktuellen Werts oder einem der definierten Kontoattributwerte. Der Attributwert muss mit dem zugewiesenen Attribut des Kontos kompatibel sein. Für API v32 und v33 ist dieses Attribut nur sinnvoll, wenn die Einstellung „Anzeigename“ für die Instanz auf „AUS“ gesetzt ist. Für API v34 und höher: Wird unterstützt, wenn die Einstellung Effektiver Anzeigename auf EIN gesetzt ist. Das Vorhandensein von valueCode und valueName führt zu einem Fehler. Wenn Kontoimport erstellt automatisch Attributwerte aktiviert ist, wird die Wertezeichenfolge zum Code und Namen, wenn der Wert noch nicht vorhanden ist. Setzen Sie value="", um dieses Attribut-Tagging zu entfernen.	170
valueCode Nur in API v32 und API v33 für Instanzen verfügbar, die den Anzeigenamen aktivieren. Wird in API v34 nicht unterstützt.	J	Der eindeutige Code des Attributwerts. Die Eingabe valueCode ist nur sinnvoll, wenn displayNameEnabled=1 und die Einstellung Anzeigename für die Instanz in API v32 und API v33 auf EIN gesetzt ist. Unzulässige Codes von Attributwerten: this Namen, die mit (+) oder (-) enden Attributname beliebige/-beliebige/beliebige-/-beliebige- Setzen Sie valueCodee="", um dieses Attribut-Tagging zu entfernen.	SFO
valueName Nur in API v32 und API v33 für Instanzen verfügbar, die den Anzeigenamen aktivieren. Wird in API v34 nicht unterstützt.	N	Der Name für einen neu automatisch erstellten Attributwert. Das AttributwertName ist nur in folgenden Fällen sinnvoll: valueCode enthält einen nicht vorhandenen Attributwert. Die Einstellung "Anzeigename" ist für die Instanz EIN. displayNameEnabled=1 API v32 und API v33 werden aufgerufen. valueName wird ignoriert, wenn valueCode einen vorhandenen Attributwert enthält.	San Francisco
Inhalt des Elements
(Keine)

Verarbeitung der Nutzlast von oben nach unten

Kontoattribute gruppieren Werte logisch und taggen Konten. Da die updateAccounts-API die XML-Nutzlast von oben nach unten verarbeitet, weisen Sie das Kontoattribut für ein übergeordnetes Konto zu, bevor Sie die Attribute für untergeordnete Konten ändern. Untergeordnete Konten können mit einem beliebigen Attributwert getaggt werden, wenn der Attributwert des übergeordneten Kontos leer ist. Wenn Attribute für untergeordnete Konten nicht auf das übergeordnete Attribut abgestimmt werden können, tritt ein Fehler bei der Kompatibilitätsvalidierung auf.

Beachten Sie die Baumstruktur unten, in der das übergeordnete Element „Produktlinie“ zwei untergeordnete Konten „A“ und „B-Ste“ hat. Die Konten „A“ und „B-Ste“ sind gleichgeordnet.


Product Line|__A        __A                                
|__B-Ste    __B-Ste
  |__B1      __Product B-1
  |__B2      __Product B-2
  |__B3      __Product B-3

Beispiel für ursprüngliche Anforderung - XML mit Kontoattributen

Beachten Sie, dass der Kontoattributwert "A" sowohl "Sonstige Konten" als auch "Swiss Bank" zugewiesen ist.


<accounts>
 <account id="60" code="70140" name="Other Accounts">
 <attribute name="Product Line" value="A"  />
    <account id="91" code="70150" name="Swiss Bank">
       <attribute name="Product Line" value="A"  />
    </account>
 </account>
</accounts>

Beispiel für falsche Reihenfolge bei Nutzlastverarbeitung

Die folgende XML-Nutzlast generiert den folgenden Fehler:

The attribute value B-1 is not compatible with the parent's attribute value

". Bei der Verarbeitung der Nutzlast von oben nach unten wird davon ausgegangen, dass das übergeordnete Konto „Sonstige Konten“ den Wert „A“ aus dem vorherigen Codeblock hat und verarbeitet „B-1“ als untergeordnetes Element von „A“. Der Fehler wird generiert, weil das untergeordnete Element "Swiss Bank" nur die Attributwerte "A" oder "B-Ste" haben kann, wie in der Baumstruktur angegeben.


<accounts>
 <account id="60" code="70140" name="Other Accounts">
    <account id="91" code="70150" name="Swiss Bank">
       <attribute name="Product Line" value="B-1"  />
    </account>
    <attribute name="Product Line" value="B-Ste"  /> <!-- Account Attribute change ignored due to placement order-->
 </account>
</accounts>

Beispiel für gültige Reihenfolge bei Nutzlastverarbeitung

Durch die Änderung der Reihenfolge der Platzierung von "B-Ste" unter "Sonstige Konten" kann die API zuerst das übergeordnete Kontoattribut "B-Ste" verarbeiten, sodass "Swiss Bank" die Werte "B-Ste" oder haben kann einem seiner untergeordneten Elemente


<accounts>
 <account id="60" code="70140" name="Other Accounts">
    <attribute name="Product Line" value="B-Ste"  /> <!-- Account Attribute change processed due to correct placement order-->
    <account id="91" code="70150" name="Swiss Bank">
       <attribute name="Product Line" value="B-1"  />
    </account>
 </account>
</accounts>

Antwortformat


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<messages>
<message type="INFO">Accounts were saved successfully.</message>
</messages>
<output>
<accounts>
 <account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets"displayAs="CURRENCY"
 decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0"
 planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText=""
 startExpanded="true" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true">
   <account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets" displayAs="CURRENCY"
   decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0" planBy="DELTA" timeRollup="LAST"
   timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="true" hasSalaryDetail=""
   dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true">
   </account>
 </accounts>
</output>
</response>

Ausgabeelement
Tag-Name	Ausgabe
Attribute des Elements
(Keine)
Inhalt des Elements
Ein einzelnes erforderliches Kontenelement Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein.

Kontenelement
Tag-Name		Konten
Beschreibung		Container für ein oder mehrere Kontoelemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Inhalt des Elements
Einem oder mehreren Kontoelementen.

Kontoelement
Tag-Name		account
Beschreibung		Stellt ein einzelnes Konto dar, das in der Antwort auf einen updateAccounts-API-Aufruf zurückgegeben wird. Wenn sich dieses Element direkt im umschließenden Element „Konten“ der Antwort befindet (d. h. es ist nicht in ein anderes Kontoelement eingeschlossen), stellt dieses Kontoelement ein Root-Konto (ein Konto ohne übergeordnetes Konto) dar.
Attribute des Elements
Name des Attributs	erforderlich?	Wert			Beispiel
id	J	Die interne System-ID-Nummer des Kontos. Dies kann verwendet werden, um Konten in anderen API-Aufrufen zu identifizieren, z. B. exportDimensionFamilies.			16
-Code	J	Der Code des Kontos, wie er bei der Referenzierung in Formeln angezeigt wird.			Cur_Assets
Name	J	Der Name des Kontos, wie er in Berichten und Tabellenblättern angezeigt wird.			Kurzfristige Vermögenswerte
accountTypeCode	N	Der Buchstabencode, der dem Datentyp dieses Kontos entspricht
		Artcode	Kontoart	Kontoklasse
		A	Assets	Hauptbuch
		B	Kurzfristige Vermögenswerte	Hauptbuch
		C	Verbindlichkeiten und Eigenkapital	Hauptbuch
		CUBE	Cube	Cube
		DE	YTD-Gewinn/-Verlust	Hauptbuch
		F	Anlagevermögen	Hauptbuch
		G	Umsatzkosten	Hauptbuch
		I	Income	Hauptbuch
		J	Nicht-operativer Ertrag	Hauptbuch
		K	Kumulative Umrechnungsanpassung	System
		L	Verbindlichkeiten	Hauptbuch
		M	Kurzfristige Verbindlichkeiten	Hauptbuch
		MI	Konsolidierungsprozentsätze	Vordefiniert
		MT	Metrik	Metrik
		N	Überschuss	Hauptbuch
		O	Sonstige Vermögenswerte	Hauptbuch
		Q	Eigenkapital	Hauptbuch
		R	Langfristige Vermögenswerte	Hauptbuch
		S	Annahme	Annahme
		T	Langfristige Verbindlichkeiten	Hauptbuch
		W	Modelliert	Modelliert
		X	Aufwand	Hauptbuch
		XR	Wechselkurs	Vordefiniert
		J	Nicht-operativer Aufwand	Hauptbuch
		Z	Benutzerdefiniert	Benutzerdefiniert
Beschreibung	N	Die textuelle Beschreibung des Kontos, falls vorhanden, wie in der Kontoverwaltung eingegeben			Summe kurzfristige Vermögenswerte
shortName	N	Der Kurzname für das Konto, falls vorhanden, wie in der Kontoverwaltung eingegeben			CA
timeStratum	N	Der Code der Zeitschicht des Kontos. Bei modellierten Konten und Cube-Konten wird dies vom Tabellenblatt des Kontos geerbt, das dem Konto gehört.			Monat
displayAs	N	Anzeigeeinstellung für die Ausgabe des Kontos: Zahl, WÄHRUNG oder PROZENTSATZ. Wird nur für Konten bereitgestellt, die in der Kontoverwaltung die Eigenschaft Anzeigen als haben.			NUMBER
isAsoption	N	Entweder „0“ oder „1“, was angibt, ob das Konto eine Annahme ist. Für Annahmen und Wechselkurskonten wird dieser Wert auf „1“ gesetzt.			1
unterdrücken von Nullen	N	Gibt an, ob Benutzer mit dem Konto Nullen in Tabellenblättern unterdrücken können. Bei 0 können Benutzer Nullen nicht unterdrücken. Bei 1 können Benutzer Nullen unterdrücken. Wird nur für Konten bereitgestellt, bei denen in der Kontenverwaltung die Eigenschaft „In Tabellenblättern unterdrücken“ aktiviert ist.			1
isDefaultRoot	N	Entweder "0" oder "1", was angibt, ob das Konto oder die Kontogruppe ein Standard-Root-Konto ist.			1
decimalPrecision	N	Anzahl der Dezimalstellen, die für Zahlen in diesem Konto angezeigt werden sollen. Der Sonderwert 99 gibt ein verknüpftes Konto an, das die Dezimalgenauigkeit seines Ziels erbt. Der Wert -1 gibt an, dass das Konto ein Währungskonto ist und die Genauigkeit der angezeigten Währung verwendet. Zulässige Werte: -1, 0, 1-9, 99 Standard ist 0.			0
planBy	N	Gibt für kumulative Konten an, ob das Konto eine Planung nach Saldo (BALANCE) oder eine Planung nach Delta (DELTA) ist.			BSALDO
exchangeRateType	N	Nur für Konten mit displayAs="CureRENCY" vorhanden. Mögliche Werte: Alle in der Instanz vorhandenen Codes für die Wechselkursart, wie unter „Währungen verwalten“ konfiguriert. „A“ = Monatlicher Durchschnitt, „E“ = Ende des Monats.			E
balanceType	N	Gibt die Saldoart eines Kontos an, SOLL oder Haben. Dieses Attribut ist leer, wenn dem Konto keine Saldoart zugeordnet ist. Nur Hauptbuch-Konten haben eine Saldoart.			SOLL
dataEntryType aktualisiert in API v29	N	Gibt die Dateneingabeart für das Konto an. Entweder STANDARD oder CUBE. Ein leerer Wert zeigt an, dass die Dateneingabeart für das Konto nicht anwendbar ist. Das System berechnet automatisch neue Dateneingabeart für alle Nicht-Leaf-Konten. Für API v29 und höher: Nicht-Leaf-Konten enthalten immer eine leere Zeichenfolge. Leaf-Konten werden immer mit dem dataEntryType-Wert STANDARD oder CUBE ausgefüllt.			STANDARD
timeRollUp	N	Gibt an, wie sich das Konto beim Rollup über eine Zeitperiode verhält. Mögliche Werte sind SUM, Gewichted_AVERAGE, LAST oder AVERAGE. Dies ist für Kontogruppen und Metrikkonten leer.			SUM
timeWeightAcctId	N	Wenn dieses Konto ein timeRollup von WEightED_AVERAGE hat, ist dies die interne System-ID des Kontos, aus dem die Gewichtungen bestimmt werden. Dieses Feld ist leer, wenn kein Gewichtungskonto vorhanden ist oder das Konto kein Zeit-Rollup von „WEightED_AVERAGE“ hat.			133
hasSalaryDetail	N	Gibt an, ob dieses Konto Splits enthält, für die zur Anzeige die Berechtigung „Zugriff auf Gehaltsdetails“ erforderlich ist. Leer, wenn für dieses Konto nicht zutreffend.			1
dataPrivacy	N	Gibt die Ebenen an, die die Werte des Kontos beim Schreiben von Formeln auf anderen Ebenen öffentlich sind und abgerufen werden können. PRIVAT gibt an, dass die Werte des Kontos privat sind. PUBlic_TOP gibt an, dass die Werte des Kontos nur auf der obersten Ebene öffentlich sind, oder PUBlic_ALL, sodass die Werte des Kontos auf allen Ebenen öffentlich sind. Annahmen sind immer öffentlich und haben keine Einstellung dataPrivacy.			PRIVAT
subType	N	Gibt an, ob das Konto periodisch oder kumulativ ist. Wenn ein Konto periodisch ist, entspricht sein Wert in einer bestimmten Zeitperiode der Nettoaktivität für die Zeitperiode. Beispiele hierfür sind Ertrags- und Aufwandskonten. Wenn ein Konto kumulativ ist, entspricht sein Wert dem Endsaldo für eine bestimmte Zeitperiode. Dies ist der Wert der vorherigen Zeitperiode plus oder minus Aktivitäten in der angegebenen Zeitperiode. Konten der Bilanz sind kumulativ. Dies ist für Kontogruppen und Metrikkonten leer.			PERIODIC
startExpanded	N	Diese gibt an, ob ein Konto und seine untergeordneten Elemente beim ersten Laden eines Tabellenblatts in einem eingeblendeten Status beginnen. Dies gilt nur für übergeordnete Konten. Bei Leaf-Konten ist dies leer.			1
isBreakbackEligible	N	Entweder 0 oder 1, um anzugeben, ob dieses Konto in einem Breakback verwendet werden kann. Dies gilt nur für Standardannahmen. Dieses Feld ist für andere Arten von Konten leer.			0
levelDimRollup	N	Gibt an, wie sich das Konto beim Rollup entlang einer Ebene oder Dimension verhält. Mögliche Werte sind SUM, WEightED_AVERAGE, TEXT oder ONBlank_AVERAGE. Dies ist für Kontogruppen und Metrikkonten leer.			NONBLANK_AVERAGE
levelDimWeightAcctId	N	Wenn dieses Konto eine EbeneDimRollup von WEightED_AVERAGE hat, ist dies die interne System-ID des Kontos, aus dem die Gewichtungen bestimmt werden. Dies ist leer, wenn kein Gewichtungskonto vorhanden ist oder die Ebene "DimRollup" des Kontos nicht "Weighted_AVERAGE" ist.			118
rollupText	N	Wenn dieses Konto die EbeneDimRollup von TEXT hat, ist dies die Textzeichenfolge, die in der Zelle angezeigt wird, die den Rollup-Wert des Kontos angibt.			Keine
enableActuals	N	0, um nur Plandaten für das Konto anzuzeigen. 1, um Istzahlen in das Konto zu importieren. Bei verknüpften Konten werden durch 0 nur dann Istzahlen angezeigt, wenn das verknüpfte Konto sie enthält, und 1 aktiviert Istzahlen für das verknüpfte Konto. Dies ist für Kontogruppen und Metrikkonten leer.			1
isGroup	J	0 oder 1, um anzugeben, ob dies eine Kontogruppe ist oder nicht.			1
isContra Verfügbar in API v34 und höher	N	0 oder 1, um anzugeben, ob es sich um ein Gegenkonto handelt.			1
isIntercompany	N	0 oder 1, um anzugeben, ob dieses Konto ein Intercompany-Konto ist oder nicht.			1
isLinked	N	0 oder 1, um anzugeben, ob dieses Konto ein verknüpftes Konto ist oder nicht.			1
isSystem	N	0 oder 1, um anzugeben, ob dieses Konto ein Systemkonto ist oder nicht.			1
status	J	Status des Kontos nach der Aktualisierung Bei Warnungen und Fehlern enthält das Nachrichtenelement den Nachrichteninhalt. Der Status "Aktualisiert" gibt keine Nachrichteninhalte zurück. Fehler: In der Entität wurde ein Fehler gefunden Warnung: In der Entität wurde eine Warnung gefunden Erstellt: Die Entität wurde erfolgreich erstellt Aktualisiert: Die Entität wurde erfolgreich aktualisiert			Aktualisiert
Nachricht	N	Die Fehlermeldung für die Kontoeingabe.			Das Konto "ModAccount33" ist entweder in der Nutzlast doppelt oder im System bereits mit der ID "8" vorhanden
Inhalt des Elements
Ein verschachteltes Kontoelement für jedes direkt untergeordnete Konto dieses Kontos. Ein Element „Attribute“, wenn dem Konto mindestens ein Attribut zugeordnet ist.

Attributelement
Tag-Name		Attribut
Beschreibung		Gibt das Attribut-Tagging für das Konto an.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Der Name des Kontoattributs	Art der Ausbildung
Wert aktualisiert in API v34	J	Wert des Kontoattributs. Für API v32 und API v33 ist dieses Attribut nur sinnvoll, wenn die Einstellung „Anzeigename“ für die Instanz auf „AUS“ gesetzt ist.	Tech1
valueCode Nur in API v32 und API v33 für Instanzen verfügbar, die den Anzeigenamen aktivieren.	J	Der eindeutige Code des Attributwerts. Für API v32 und API v33 ist valueCode nur in folgenden Fällen sinnvoll: Die Einstellung "Anzeigename" ist für die Instanz EIN. displayNameEnabled=1
valueName Nur in API v32 und API v33 für Instanzen verfügbar, die den Anzeigenamen aktivieren.	N	Der Name für einen neu automatisch erstellten Attributwert. Das AttributwertName ist nur in folgenden Fällen sinnvoll: valueCode enthält einen nicht vorhandenen Attributwert. Die Einstellung "Anzeigename" ist für die Instanz EIN. displayNameEnabled=1value Aufruf der API v32 und v33. Der Name wird ignoriert, wenn valueCode einen vorhandenen Attributwert enthält.
status	J	Status des Attributs nach der Aktualisierung Bei Warnungen und Fehlern enthält das Nachrichtenelement den Nachrichteninhalt. Der Status "Aktualisiert" gibt keine Nachrichteninhalte zurück. Fehler: In der Entität wurde ein Fehler gefunden Warnung: In der Entität wurde eine Warnung gefunden Erstellt: Das Konto wurde zum ersten Mal erfolgreich mit einem Attribut getaggt. Aktualisiert: Das Kontoattribut-Tag wurde erfolgreich aktualisiert	aktualisiert
Nachricht	N	Die Fehlermeldung für eine ungültige Attributeingabe.
Inhalt des Elements
(Keine)

Kategorie	Änderung von Metadaten
Beschreibung	Aktualisieren Sie eine Gruppe vorhandener Hauptbuch-Konten oder erstellen Sie neue Hauptbuch-Konten. In einem einzigen Aufruf können mehrere Konten mit mehreren Werten aktualisiert werden. Bei erfolgreicher Ausführung gibt die API Details für die Konten zurück, die aktualisiert/erstellt wurden. Wenn die API fehlschlägt, wird eine umfassende Liste der Fehler und deren Ursachen zurückgegeben.
Zum Aufrufen sind Berechtigungen erforderlich	Modell und Berechtigungen auf jeder Ebene
Auf Anforderung erforderliche Parameter	Zugangsdaten