Invoice

Vorkommen

Inhalt

Key	Type	Description
number	string	Kommagetrennte Produktnamen
products	array of Invoice Products	/pages/cAppYOYUoFqP5CLRMyKR
shippingAmount	int\|null	Versandkosten, die dem Käufer berechnet werden
currency	string	ISO 4217 der verwendeten Währung
test	int	Wurde die Zahlung simuliert? Mögliche Werte: `0` für nein oder `1` für ja
referenceId	string	Interne Referenz-ID deines Systems
purpose	string	Verwendungszweck der Zahlung
paymentRequestId	int\|null	ID der über die API erstellten Invoice oder des zahls.ch-Gateways
paymentLink	Payment Link\|null	/pages/u4F7debOZ9ZvgkBwfmVf Invoice-/Gateway-Daten
googleAnalyticProducts	array of Google Analytic Products	/pages/bgLhob0yVNBmoFPYEa2w
originalAmount	int	Vom Käufer bezahlter Betrag
refundedAmount	int	An den Käufer zurückerstatteter Betrag
custom_fields	array of Custom Fields	/pages/P6ITfbEnvJyxBX5UH7IR Nur gesetzt, wenn das Array nicht leer ist

Beispiel

{
  "test": 1,
  "number": "IV_123",
  "currency": "CHF",
  "discount": {
    "code": null,
    "amount": 0,
    "percentage": null
  },
  "products": [
    {
      "sku": null,
      "name": "Product 1",
      "price": 1000,
      "vatRate": "8.1",
      "quantity": 1,
      "description": "sample-email@mail.com"
    }
  ],
  "paymentLink": null,
  "referenceId": "Custom API Reference",
  "custom_fields": [
    {
      "name": "E-Mail",
      "type": "email",
      "value": "sample-email@mail.com"
    }
  ],
  "originalAmount": 1000,
  "refundedAmount": 0,
  "shippingAmount": null,
  "paymentRequestId": null,
  "googleAnalyticProducts": [
    {
      "price": 10,
      "item_id": 112233,
      "quantity": 1,
      "item_name": "Product 1"
    }
  ]
}

Changelog

2024-12-10

Aktualisierung am Invoice-Product-Objekt.

2021-10-12

Das Feld amount wurde entfernt und durch zwei Felder ersetzt: originalAmount (bezahlter Betrag) und refundedAmount (zurückerstatteter Betrag).

2019-10-15

Der Typ von amount ändert sich von float zu int. Der Preis wird in der kleinsten Währungseinheit angegeben.

Aktualisierung am Discount- und Invoice-Product-Objekt.

2019-02-13

Aktualisierung am Invoice-Product-Objekt.