Skip to content
Developer

Voucher

Billing21 EndpointsBilling / Voucher

Returns the expired entries.

GET/api/invoice/voucher/expired

Responses

200Paid vouchers with a balance after their validity ended (setting voucher_expiry_write_off_enabled)

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

Creates a new entry from an invoice.

POST/api/invoice/voucher/from_invoice

Responses

200Refunds a paid invoice as a voucher (setting voucher_refund_enabled)

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

Creates several records in one request.

POST/api/invoice/voucher/bulk

Responses

200Creates a batch of vouchers (setting voucher_bulk_enabled)

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

Returns a batch as CSV.

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

Path parameters

batchIdrequiredstring

Responses

200The vouchers of a batch as CSV (setting voucher_bulk_enabled)

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

Sends an e-mail.

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

Path parameters

idrequiredstring

Responses

200Sends the voucher PDF by mail (again) (setting voucher_bulk_enabled)

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

Returns a list of voucher entries.

GET/api/invoice/voucher

Responses

200Returns a list of Vouchers

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

Creates a new voucher entry.

POST/api/invoice/voucher

Responses

200Creates a new Voucher

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

Returns a single voucher entry.

GET/api/invoice/voucher/{id}

Path parameters

idrequiredstring

Responses

200Returns a single Voucher

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

Updates an existing voucher entry.

PUT/api/invoice/voucher/{id}

Path parameters

idrequiredstring

Responses

200Updates a Voucher

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

Updates an existing voucher entry.

PATCH/api/invoice/voucher/{id}

Path parameters

idrequiredstring

Responses

200Updates a Voucher

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

Returns the PDF document.

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

Path parameters

idrequiredstring

Responses

200Returns the Voucher as PDF

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

Redeems a code or voucher.

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

Path parameters

idrequiredstring

Responses

200Redeems amount from voucher

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

Marks the entry as paid.

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

Path parameters

idrequiredstring

Responses

200Marks voucher as paid

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

Cancels the entry.

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

Path parameters

idrequiredstring

Responses

200Cancels a voucher

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

Imports credit.

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

Path parameters

idrequiredstring

Responses

200Imports voucher balance as company credit

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

Pays an invoice.

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

Path parameters

idrequiredstring

Responses

200Pays an invoice with voucher balance

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

Blocks the entry.

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

Path parameters

idrequiredstring

Responses

200Blocks a voucher (setting voucher_block_enabled)

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

Unblocks the entry.

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

Path parameters

idrequiredstring

Responses

200Unblocks a voucher (setting voucher_block_enabled)

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

Writes off the open amount.

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

Path parameters

idrequiredstring

Responses

200Writes off the balance of an expired voucher (setting voucher_expiry_write_off_enabled)

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

Reverses the entry.

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

Path parameters

idrequiredstring
transactionIdrequiredstring

Responses

200Reverses a booking of the voucher (setting voucher_reversal_enabled)

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

Returns the transactions.

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

Path parameters

idrequiredstring

Responses

200Returns transactions for a voucher

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