Entwicklerhandbuch für die API für Kreditorenrechnungen

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 3 Minuten Lesedauer
  • In diesem Entwicklerleitfaden wird beschrieben, wie Sie anwenderdefinierte Rechnungsfelder definieren, die nicht standardmäßig mit der Kreditorenrechnungs- API für Rechnungsbearbeitung für Kreditorenbuchhaltungbereitgestellt werden. Außerdem werden Anweisungen zum Festlegen der Authentifizierung bei Verwendung von cXML als Nutzlast bereitgestellt.

    Sie können anwenderdefinierte Rechnungsfelder für den Anforderungstext definieren. Verwenden Sie den folgenden Flow, um anwenderdefinierte Felder hinzuzufügen, Zieltabellen zuzuordnen und sie für die Verfügbarkeit in der Nutzlast zu formatieren:
    1. Fügen Sie anwenderdefinierte Felder für den Rechnungsimport hinzu
    2. Ordnen Sie anwenderdefinierte Felder zwischen Quell- und Zieltabellen zu
    3. Ordnen Sie einem Nutzlastquellformat anwenderdefinierte Felder zu

    Definieren Sie Anmeldeinformationen für cXML-Nutzlasten in der Tabelle „Anmeldeinformationen für Quellsystem“ [sn_spend_intg_source_system_credential]. Anweisungen dazu finden Sie unter Anmeldeinformationen für die Authentifizierung in der cXML-Payload festlegen.

    Fügen Sie anwenderdefinierte Felder für den Rechnungsimport hinzu

    Verwenden Sie das folgende Verfahren, um anwenderdefinierte Felder für Rechnungen, Rechnungspositionen und Rechnungssteuerpositionen hinzuzufügen, die mit der API für Kreditorenrechnungen verwendet werden sollen.

    Vorbereitungen

    • Erforderliche Rolle: Administrator
    • Anwendungsbereich:

    Prozedur

    1. Navigieren zu Alle > Systemdefinition > Tabellen.
    2. Wählen Sie eine der folgenden Rechnungsimporttabellen aus:
      • Rechnungsimport [sn_spend_intg_imp_invoice]
      • Rechnungspositionsimport [sn_spend_intg_imp_invoice_line]
      • Import von Rechnungssteuerpositionen [sn_spend_intg_imp_invoice_tax_line]
    3. Wählen Sie auf der Registerkarte Tabellenspalten die Option Neuaus.
    4. Wählen Sie im Menü Typeinen Typ aus, der dem Feldwert zugeordnet ist (z.  B. Ganzzahl ).
      Hinweis:
      Eine Liste der gültigen Typen finden Sie unter Field types reference.
    5. Geben Sie im Feld Spaltenbezeichnung einen aussagekräftigen Namen ein.
      Text einschließlich der Bezeichnung wird automatisch im Feld Spaltenname ausgefüllt.
    6. Wählen Sie Speichern oder Absenden.
    7. Fügen Sie der Rechnungstabelle [sn_shop_invoice] eine Spalte mit demselben Namen und Typ hinzu.
      Hinweis:
      Weitere Informationen zu Spalten und Feldern finden Sie unter Exploring field administration.
    8. Ordnen Sie die Felder zwischen den Quell- und Zieltabellen zu.

    Ordnen Sie anwenderdefinierte Felder zwischen Quell- und Zieltabellen zu

    Verwenden Sie das folgende Verfahren, um anwenderdefinierte Felder zwischen Quell- und Zieltabellen für die Kreditorenrechnungs-API zuzuordnen.

    Vorbereitungen

    • Erforderliche Rolle: Administrator
    • Anwendungsbereich:

    Erstellen Sie Tabellenspalten für die Zuordnung des neuen Felds aus der Quelltabelle zur Zieltabelle. Führen Sie die Schritte in Fügen Sie anwenderdefinierte Felder für den Rechnungsimport hinzuaus.

    Prozedur

    1. Navigieren zu Alle > System-Importsätze > Transformationszuordnungen.
    2. Öffnen Sie die Transformationszuordnung der Rechnungsimporttabelle.
    3. Klicken Sie auf Neu auf der Registerkarte Feldzuordnungen.
    4. Wählen Sie den Namen des anwenderdefinierten Felds im Menü Quellfeld aus.
    5. Wählen Sie den Namen des anwenderdefinierten Felds im Menü Zielfeld aus.
    6. Wählen Sie Speichern oder Absenden.
    7. Ordnen Sie einem Nutzlastquellformat anwenderdefinierte Felder zu.

    Ordnen Sie einem Nutzlastquellformat anwenderdefinierte Felder zu

    Verwenden Sie das folgende Verfahren, um anwenderdefinierte Felder einem Nutzlasteintrag in JSON, cXML oder XML für die Kreditorenrechnungs-API zuzuordnen.

    Vorbereitungen

    Prozedur

    1. Navigieren zu Alle > Beschaffungsintegrationen > Lieferanten > Zuordnungen des Rechnungsintegrationsfelds.
    2. Wählen Sie Neu.
    3. Fügen Sie dem Feld Quellsystem den Namen des Quellsystems hinzu.
      • Wenn diese Feldzuordnung für alle Quellsysteme gilt, geben Sie Standardein.
      • Wenn die Zuordnung spezifisch für ein bestimmtes Quellsystem ist, muss dieser Wert mit dem Wert des Headerparameters „Quellsystem“ übereinstimmen, der in der API empfangen wurde.
        Hinweis:
        Alle verbleibenden Feldzuordnungen müssen speziell für dieses Quellsystem konfiguriert werden.
    4. Wählen Sie das Format des Quellsystems, für das die Zuordnung erstellt wird, aus der Auswahlliste Quellformat (cXML oder JSON).
    5. Geben Sie einen Namen (JSON-Eigenschaft) oder Pfad (cXML/XML-Attribut oder Element) für den Nutzlasteintrag im Feld Quelle an.
      Beispiele für cXML- und XML-Pfadeinstellungen finden Sie in der Tabelle „Rechnungsintegrationsfeldzuordnung“ [sn_spend_intg_invoice_intg_field_mapping].
    6. Fügen Sie den Namen eines Attributs hinzu, wenn das Feld als Elementattribut für cXML-Nutzlasten definiert werden soll, andernfalls lassen Sie das Feld leer.
    7. Wählen Sie den Namen der Zieltabelle, die Ihr anwenderdefiniertes Feld enthält, aus der Liste Zugehörige Tabellen aus.
    8. Wählen Sie den Namen des anwenderdefinierten Felds aus der Liste Zielfeld aus.
    9. Wählen Sie Speichern oder Absenden.
      Das zugeordnete Feld wird der Tabelle „Rechnungsintegrationsfeldzuordnung“ [sn_spend_intg_invoice_intg_field_mapping] hinzugefügt.

    Anmeldeinformationen für die Authentifizierung in der cXML-Payload festlegen

    Der Endpunkt sn_spend_intg/ap_invoice/cxml wird in der Nutzlast mithilfe von Anmeldeinformationen authentifiziert, die in der Tabelle „Quellsystem-Anmeldeinformationen“ [sn_spend_intg_source_system_credential] gespeichert sind.

    Vorbereitungen

    Erforderliche Rolle: Administrator

    Identifizieren Sie das Nutzlastquellsystem, das in der Tabelle „Rechnungsintegrationsfeldzuordnungen“ [sn_spend_intg_invoice_intg_field_mapping] aufgeführt ist.

    Siehe auch Kreditorenrechnung: POST sn_spend_intg/ap_invoice/cxml.

    Prozedur

    1. Navigieren zu Alle > Beschaffungsintegrationen > Quellsystem-Anmeldeinformationen.
    2. Wählen Sie Neu.
    3. Fügen Sie den Namen des Quellsystems hinzu, das in der Tabelle „Rechnungsintegrationsfeldzuordnungen“ [sn_spend_intg_invoice_intg_field_mapping] im Feld Quellsystem aufgeführt ist.
      Der Quellsystemname muss mit dem Headerparameter „Source-System“ übereinstimmen.
    4. Fügen Sie den abzurufenden Anwendernamen im Feld Anwendername hinzu.
      Verwenden Sie diesen Wert im Element „/cXML/Header/To/Credential [@domain='NetworkID']/Identity“.
    5. Fügen Sie dem Feld Passwort eine starke Kombination aus Buchstaben, Ziffern und Sonderzeichen hinzu.
      Verwenden Sie diesen Wert im Element /cXML/Header/Sender/Credential [@domain='NetworkID']/SharedSecret.
    6. Wählen Sie Absenden.