Zum Inhalt springen
Developer

Voucher

Abrechnung21 EndpunkteBilling / Voucher

Liefert die abgelaufenen Einträge.

GET/api/invoice/voucher/expired

Antworten

200Bezahlte Gutscheine mit Restguthaben nach Ablauf der Gültigkeit (Einstellung voucher_expiry_write_off_enabled)

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/expired \
  --header 'x-iw-jwt-token: <TOKEN>'

Legt einen neuen Eintrag aus einer Rechnung an.

POST/api/invoice/voucher/from_invoice

Antworten

200Erstattet eine bezahlte Rechnung als Gutschein (Einstellung voucher_refund_enabled)

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/from_invoice \
  --header 'x-iw-jwt-token: <TOKEN>'

Erstellt mehrere Datensätze in einer Anfrage.

POST/api/invoice/voucher/bulk

Antworten

200Erstellt einen Gutschein-Stapel (Einstellung voucher_bulk_enabled)

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/bulk \
  --header 'x-iw-jwt-token: <TOKEN>'

Liefert einen Batch als CSV.

GET/api/invoice/voucher/batch/{batchId}.csv

Pfad-Parameter

batchIdPflichtstring

Antworten

200Die Gutscheine einer Charge als CSV (Einstellung voucher_bulk_enabled)

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/batch/42.csv \
  --header 'x-iw-jwt-token: <TOKEN>'

Sendet eine E-Mail.

POST/api/invoice/voucher/{id}/send_mail

Pfad-Parameter

idPflichtstring

Antworten

200Versendet das Gutschein-PDF erneut per E-Mail (Einstellung voucher_bulk_enabled)

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/send_mail \
  --header 'x-iw-jwt-token: <TOKEN>'

Liefert eine Liste der Gutschein-Einträge.

GET/api/invoice/voucher

Antworten

200Liefert eine Liste von Vouchers.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher \
  --header 'x-iw-jwt-token: <TOKEN>'

Legt einen neuen Gutschein-Eintrag an.

POST/api/invoice/voucher

Antworten

200Legt einen neuen Gutschein an

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher \
  --header 'x-iw-jwt-token: <TOKEN>'

Liefert einen einzelnen Gutschein-Eintrag.

GET/api/invoice/voucher/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert einen einzelnen Voucher-Eintrag.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Aktualisiert einen vorhandenen Gutschein-Eintrag.

PUT/api/invoice/voucher/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Gutschein aktualisieren

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Aktualisiert einen vorhandenen Gutschein-Eintrag.

PATCH/api/invoice/voucher/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Gutschein aktualisieren

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Liefert das PDF-Dokument.

GET/api/invoice/voucher/{id}/pdf

Pfad-Parameter

idPflichtstring

Antworten

200Liefert den Gutschein als PDF

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/pdf \
  --header 'x-iw-jwt-token: <TOKEN>'

Löst einen Code oder Gutschein ein.

POST/api/invoice/voucher/{id}/redeem

Pfad-Parameter

idPflichtstring

Antworten

200Löst Betrag aus Gutschein ein

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/redeem \
  --header 'x-iw-jwt-token: <TOKEN>'

Markiert den Eintrag als bezahlt.

POST/api/invoice/voucher/{id}/mark_paid

Pfad-Parameter

idPflichtstring

Antworten

200Gutschein als bezahlt markieren

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/mark_paid \
  --header 'x-iw-jwt-token: <TOKEN>'

Storniert den Eintrag.

POST/api/invoice/voucher/{id}/cancel

Pfad-Parameter

idPflichtstring

Antworten

200Storniert einen Gutschein

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/cancel \
  --header 'x-iw-jwt-token: <TOKEN>'

Importiert Guthaben.

POST/api/invoice/voucher/{id}/import_credit

Pfad-Parameter

idPflichtstring

Antworten

200Importiert das Gutscheinguthaben als Firmenguthaben

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/import_credit \
  --header 'x-iw-jwt-token: <TOKEN>'

Begleicht eine Rechnung.

POST/api/invoice/voucher/{id}/pay_invoice

Pfad-Parameter

idPflichtstring

Antworten

200Begleicht eine Rechnung mit Gutscheinguthaben

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/pay_invoice \
  --header 'x-iw-jwt-token: <TOKEN>'

Sperrt den Eintrag.

POST/api/invoice/voucher/{id}/block

Pfad-Parameter

idPflichtstring

Antworten

200Sperrt einen Gutschein (Einstellung voucher_block_enabled)

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/block \
  --header 'x-iw-jwt-token: <TOKEN>'

Entsperrt den Eintrag.

POST/api/invoice/voucher/{id}/unblock

Pfad-Parameter

idPflichtstring

Antworten

200Entsperrt einen Gutschein (Einstellung voucher_block_enabled)

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/unblock \
  --header 'x-iw-jwt-token: <TOKEN>'

Schreibt den offenen Betrag ab.

POST/api/invoice/voucher/{id}/write_off

Pfad-Parameter

idPflichtstring

Antworten

200Schreibt den Restbetrag eines abgelaufenen Gutscheins ab (Einstellung voucher_expiry_write_off_enabled)

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/write_off \
  --header 'x-iw-jwt-token: <TOKEN>'

Storniert den Eintrag.

POST/api/invoice/voucher/{id}/transactions/{transactionId}/reverse

Pfad-Parameter

idPflichtstring
transactionIdPflichtstring

Antworten

200Storniert eine Buchung des Gutscheins (Einstellung voucher_reversal_enabled)

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/transactions/42/reverse \
  --header 'x-iw-jwt-token: <TOKEN>'

Liefert die Transaktionen.

GET/api/invoice/voucher/{id}/transactions

Pfad-Parameter

idPflichtstring

Antworten

200Liefert die Transaktionen eines Gutscheins

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/voucher/42/transactions \
  --header 'x-iw-jwt-token: <TOKEN>'