exportActiveCurrencies

Diese API unterstützt nur Benutzer Konzept: Zugriffsregeln in API v22 und höher.

Kategorie	Abrufen von Metadaten
Beschreibung	Gibt Metadaten für die vollständige Liste aller Währungen zurück, die im System konfiguriert wurden.
Zum Aufrufen sind Berechtigungen erforderlich	Keine (es müssen gültige Zugangsdaten für die Instanz sein)
Auf Anforderung erforderliche Parameter	Zugangsdaten

Die Anforderung dieser Methode enthält nur ein Credentials-Tag zur Identifizierung und Autorisierung des aufrufenden Benutzers. Nach der Verifizierung gibt die Methode ein XML-Dokument zurück, das den vollständigen Satz aller Währungen beschreibt, die im System konfiguriert wurden. Eine Währung ist „konfiguriert“, sobald sie zur Währungsliste in der Währungsverwaltung hinzugefügt wurde, auch wenn sie noch keinen Wechselkurs hat. Instanzen, für die das Feature „Mehrere Währungen“ nicht aktiviert ist, geben in dieser Liste nur eine einzige Währung zurück.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportActiveCurrencies" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_pwd"/>
  </call>

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 hat, Adaptive Planning : Dieses Attribut kann 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)

Antwortformat


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<currencies seqNo="42">
  <currency id="2" code="EUR"  precision="4" isReportingCurrency="0" userDefined="0" description="Euro Member Countries, Euro" />
  <currency id="3" code="EUR1" precision="4" isReportingCurrency="0" userDefined="1" description="User-defined Euro 1" />
  <currency id="1" code="USD" precision="2" isReportingCurrency="1" userDefined="0" description="United States of America, Dollars" />
</currencies>
</output>
</response>

Antwortelement
Tag-Name		-Antwort
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Erfolg haben	J	Entweder wahr oder falsch, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten.	wahr
veraltet	N	Wenn dieses Attribut im Antwort-Tag vorhanden ist und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet und offiziell veraltet ist. Auch wenn es zu diesem Zeitpunkt noch funktioniert, kann es sein, dass Sie in Kürze nicht mehr funktionieren. In der Regel ist dieses Attribut nicht vorhanden.	false
Inhalt des Elements
Ein einzelnes optionales Nachrichtenelement und genau ein erforderliches Ausgabeelement.

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

Element „Währungen“
Tag-Name		Währungen
Beschreibung		Container für ein oder mehrere Währungselemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Sequenznr Hinzugefügt in API v17, aber für zukünftige Verwendung reserviert.
Inhalt des Elements
Ein oder mehrere Währungselemente

Währungselement
Tag-Name		Währung
Beschreibung		Stellt eine einzelne Währung dar, die in der Antwort auf einen API-Aufruf exportActiveCurrencies zurückgegeben wird. Für Versionen vor API v17 werden das benutzerdefinierte Attribut und die benutzerdefinierten Währungen nicht angezeigt.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne System-ID-Nummer für die Währung. Diese Nummer kann verwendet werden, um die Währung eindeutig zu identifizieren, wird jedoch in keinen anderen API-Aufrufen verwendet.	1
-Code	J	Der aus drei Buchstaben bestehende Code für die Währung, wie im Standard ISO 4217 angegeben.	USD
Genauigkeit	J	Die typische Dezimalgenauigkeit (Anzahl der Stellen nach der Dezimalstelle), die bei der Anzeige von Beträgen in dieser Währung verwendet werden soll. Diese Genauigkeit wird nur für Konten verwendet, die die Anzeigeart Währung haben und deren Dezimalgenauigkeit auf "Währungsgenauigkeit verwenden" festgelegt ist.	2
isReportingCurrency	J	Ob die Währung von einem Administrator als verfügbar für die Verwendung in „arbiträren Berichtsumrechnungen“ ausgewählt wurde True=1, False=0.	1
userDefined Verfügbar in API v17 und höher	J	Ob die Währung vom Benutzer erstellt wurde oder nicht. True=1, False=0.	0
Beschreibung	J	Grundlegende Beschreibung der Währung, die aus dem Land der Währung und ihrem Namen besteht.	Vereinigte Staaten von Amerika, Dollar
Inhalt des Elements
(Keine)