Sign in

v1

latestSwagger 2.02026-07-13285166341.1 KB
Vouchers

Get a voucher

No Documentation Found.

get/api/v2/Vouchers/{VoucherCode}

Path parameters

VoucherCodestring required

The voucher code of the voucher to get.

Query parameters

Deleted'NotDeleted' | 'Deleted' | 'All'

Optional. Filter vouchers by Deleted state. By default only vouchers that are not deleted are returned.

Response

OK

VoucherCodestring

The voucher code.

Type'Commercial' | 'Internal' | 'Temporary' | 'RightToRepair'

The type of voucher. Commercial is the default if not specified.

DealerCodestring

The dealer code the voucher is assigned to. Required for commercial and right to repair vouchers.

LicenseTostring

Required for Internal Vouchers

Purposestring

Required for Internal Vouchers. Not supported for other Vouchers.

OrderNumberstring

The order number of a license. Required for Commercial and Right To Repair Vouchers. Not supported for other Vouchers.

Emailstring

Required for internal vouchers.

ModifiedBystring

Read-Only. The user that made the last modification to the voucher.

CreatedDatestring date-time

Read-Only. The date the voucher was created.

PunchedDatestring date-time

Read-Only. The date the voucher was punched.

Punchedboolean

True if voucher has aleady been used. False if the voucher has not been used.

Deletedboolean

Read-Only. True if voucher has been deleted.

ExpirationDatestring date-time

The expiration date of the voucher. Required for Temporary and Right to Repair Vouchers.