Zum Inhalt

Zahlungen

Eine Zahlung in xTool erfasst eine Geldbewegung für eine Organisation. Sie ist eine eigenständige Entität: Sie kann ohne Dokument oder Transaktion existieren.

Nutzen Sie Zahlungen, wenn Sie speichern müssen, wie viel gezahlt wurde, wann, in welcher Währung und auf welche Rechnungsdokumente sich das Geld bezieht.

Richtung

Die Richtung ist relativ zur Organisation:

  • incoming — Geld, das die Organisation erhalten hat
  • outgoing — Geld, das die Organisation gesendet hat

Währung und Betrag

Anlegen und Aktualisieren verwenden einen eingeschränkten ISO-4217-Währungscode (z. B. EUR).

amount ist eine positive Dezimalzahl. Beim Anlegen ist currency Pflicht.

Das Aktualisieren des Zahlungsbetrags mit PATCH ändert vorhandene Zuordnungen nicht automatisch. Wenn die Zahlung bereits Dokumenten zugeordnet ist und die zugeordneten Beträge dem neuen Zahlungsbetrag (oder einer neuen Aufteilung) entsprechen sollen, senden Sie im selben Request ein aktualisiertes Array allocations. Lassen Sie allocations nur weg, wenn Sie die bestehenden Zuordnungen bewusst unverändert lassen.

Zuordnungen (Allocations)

Eine Zahlung kann über Zuordnungen auf Dokumente aufgeteilt werden.

Jede Zuordnung verknüpft:

  • eine document_id
  • einen auf dieses Dokument angewandten amount

Faustregeln:

  • Eine Zahlung kann mehreren Dokumenten zugeordnet werden
  • Ein Dokument kann über die Zeit mehrere Zahlungen erhalten
  • Teilzahlungen sind üblich: nur den bisher gezahlten Betrag zuordnen, später eine weitere Zahlung für den Rest anlegen

Beim Aktualisieren einer Zahlung ersetzen gesendete allocations die bestehende Menge für diese Zahlung.

Zuordnungsform in der API

In der Zahlungsdetail-Antwort (GET / POST / PATCH) enthält jede Zuordnung:

Feld Beschreibung
id Zuordnungs-ID
document_id Zieldokument
amount Zugeordneter Betrag

Listenantworten verwenden eine kürzere Zuordnungsansicht (document_id, document_number, amount).

Bezug zu Transaktionen

Zahlungen sind keine Transaktionen.

Entität Verfolgt
Transaktion Senden / Empfangen eines Dokuments über einen Kanal
Zahlung Geldbewegung und Dokumentzuordnungen

Für Frankreich-Rechnungen, die bereits eine Transaktion send.france haben, kann das Anlegen einer dem Rechnungsdokument zugeordneten Zahlung die Zahlung auch an den Frankreich-Provider synchronisieren. Nutzen Sie france.invoice.payment_received auf der Send-Transaktion als Shortcut. Für eingehende Rechnungen (receive.france) verwenden Sie france.invoice.payment_sent, um die Zahlung als übermittelt zu markieren, ohne ein Payment zu erstellen. Bei B2B Inland entsprechen diese CDV 212 / 211; bei B2C und B2B grenzüberschreitend gilt CDV möglicherweise nicht.

Siehe Rechnungen senden und empfangen und Transaktionen.

API-Übersicht

Methode Pfad Hinweise
GET /api/v2/payments Liste. Optional direction. Liefert data + count
GET /api/v2/payments/{payment_id} Abruf mit Zuordnungen
POST /api/v2/payments Anlegen (201). currency Pflicht
PATCH /api/v2/payments/{payment_id} Aktualisieren. Änderung von amount aktualisiert Zuordnungen nur, wenn Sie auch allocations senden
DELETE /api/v2/payments/{payment_id}/delete Löschen

Beispiel Anlegen:

{
  "direction": "incoming",
  "amount": "300.00",
  "currency": "EUR",
  "paid_at": "2026-08-09T00:00:00Z",
  "allocations": [
    {
      "document_id": "invoice-document-uuid",
      "amount": "300.00"
    }
  ]
}

Beispiel — Zahlungsbetrag aktualisieren und die Zuordnung synchron halten:

1
2
3
4
5
6
7
8
9
{
  "amount": "500.00",
  "allocations": [
    {
      "document_id": "invoice-document-uuid",
      "amount": "500.00"
    }
  ]
}

Bezug zu Steuerberichten

Zahlungen können Quellen eines Steuerberichts werden, wenn die regulatorische Meldung geeignete Rechnungen und Zahlungen aggregiert (z. B. bestimmte Frankreich-e-Reporting-Szenarien).