Übertragen einer Prüfermatrix (d.velop smart invoice)

Sie können eine API nutzen, um Daten aus einer beliebigen Datenquelle in eine konfigurierte Prüfermatrix zu übertragen.

Jobs

Sie können mehrere Datensätze gleichzeitig übertragen. d.velop smart invoice verarbeitet die Daten asynchron. Es wird immer genau ein Job erzeugt, dessen Job-ID Sie als Antwort zurückerhalten.

Response

{
  "job_id": "65866efa-e8a6-4c9c-ae30-60121b6d039f"
}

Abrufen des aktuellen Status zu einem Job

Sie können den Status des Jobs anhand der Job-ID, die Sie vom Endpunkt zurückgeliefert bekommen haben, und der Matrix-ID wie folgt abrufen:

Request

   GET 
/smartinvoice/api/v1/verification_matrices/:matrix_id/rows/batch/jobs/:job_id
Accept: application/json

Als Antwort erhalten Sie ein JSON-Objekt mit Informationen über den Job.

Response

{
  "status": "successful",
  "issues": []
}

Eigenschaft

Beschreibung

status

String. Der aktuelle Status des Jobs. Folgende Möglichkeiten existieren:

  • waiting: Der Job befindet sich in der Warteschlange.

  • processing: Der Job befindet sich in der Verarbeitung.

  • successful: Der Job wurde erfolgreich verarbeitet.

  • failed: Ein Fehler ist aufgetreten.

more_issues

Boolean. Zeigt an, ob mehr Fehler aufgetreten sind als unter issues angegeben.

issues

Objekt. Enthält die bei der Verarbeitung aufgetretenen Probleme.

message: String. Eine Fehlermeldung, die das aufgetretene Problem beschreibt.

record number: Number. Datensatz aus dem JSON, das als Request Payload an den Endpunkt gesendet wurde.

Verification matrices (Prüfermatrizen)

Mit einer Prüfermatrix können Sie im Rahmen der erweiterten Prüfung geeignete Prüfer für eine Rechnung bestimmen. Dies erfolgt anhand der für die Rechnung erfassten Daten. Sie können Datensätze für eine in d.velop smart invoice konfigurierte Prüfermatrix wie folgt übertragen:

   POST /smartinvoice/api/v1/verification_matrices/:matrix_id/rows/batch
Content-Type: application/json
{
  "rows": [
    {
      "verifiers": [
        {
          "id": "fa2461f6-f112-408c-aaad-4f35f996bd66",
          "user": {
            "type": "idp",
            "name": "username@domain.de"
          },
        },
        {
          "id": "bc7748fc-a73a-401d-ab1d-4f3111a6be12",
          "group": {
            "type": "idp",
            "name": "groupname"
          },
        }
      ],
      "limit": {
        "amount": 10000.00,
        "currency": "EUR"
      },
      "column1": "01",
      "column2": "1300"
    }
  ]
}

Jede Zeile einer Prüfermatrix unterstützt die folgenden Eigenschaften:

Eigenschaft

Beschreibung

verifiers

Objekt. Verpflichtend. Enthält die Prüfer oder Prüfergruppen für die Prüfungstypen der Matrixzeile.

id

String. Verpflichtend. Die ID des Prüfungstyps aus der Workflow-Definition.

user|group

Objekt. Verpflichtend. Für den angegebenen Prüfungstypen zuständiger Benutzer oder zuständige Benutzergruppe.

Wert soll ein Benutzer sein:

user: Objekt. Verpflichtend. Benutzerobjekt, das als Prüfer für den angegebenen Prüfungstypen zuständig ist.

  • type: String. Verpflichtend. Der Typ des Benutzerobjekts

    • idp: Über IDP bereitgestellter Benutzer.

    • aad: Benutzer aus Azure AD.

  • name: String. Verpflichtend. Name des Benutzers.

Wert soll eine Benutzergruppe sein:

group: Objekt. Verpflichtend. Benutzergruppenobjekt, das als Prüfergruppe für den angegebenen Prüfungstypen zuständig ist.

  • type: String. Verpflichtend. Der Typ des Benutzergruppenobjekts.

    • idp: Über IDP bereitgestellte Benutzergruppe.

    • aad: Benutzergruppe aus SharePoint.

  • name: String. Verpflichtend. Name der Benutzergruppe.

limit

Objekt. Verpflichtend. Betragsgrenze für die Prüfer dieser Matrixzeile in angegebener Währung.

amount: Nummer. Verpflichtend. Der Betrag der Betragsgrenze.

currency: String. Verpflichtend. Währungscode nach ISO 4217 für die Betragsgrenze.

column1-20

String. Optional. Wert für die zu column<1-20> zugehörige Spalte für diese Matrixzeile. Sie finden die Zuordnung von column<1-20> zu den Matrixspalten in der Matrixkonfiguration.