Skip to navigation
VouchersVouchers

Create Voucher

Use this endpoint to create a new voucher. If Reference No is blank, a new Reference No will be generated.

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
documentNostringRequired
DocumentNo for which voucher is issued.
voucherTypestringRequired
The type of the voucher
referenceNostringOptional
A unique reference number for the voucher
namestringOptional
The name of the customer who purchased the voucher
name2stringOptional
Other name of the buying customer
addressstringOptional
The address of the buying customer
address2stringOptional
The address of the buying customer
postCodestringOptional
The postal code of the buying customer
citystringOptional
The city of the buying customer
countystringOptional
The county of the buying customer
countryCodestringOptional
The country where the buying customer resides.
emailstringOptional
the email address of the buying customer
phoneNostringOptional
The phone number of the buying customer.
voucherMessagestringOptional
indicates message on voucher
descriptionstringOptional
A description of the voucher, usually includes Voucher Type and Voucher Number
startingDatedatetimeOptional
The datetime as from which the voucher is valid

Response

This endpoint returns an object.
documentNostring
DocumentNo for which voucher is issued.
voucherTypestring
The type of the voucher
referenceNostringOptional
A unique reference number for the voucher
namestringOptional
The name of the customer who purchased the voucher
name2stringOptional
Other name of the buying customer
addressstringOptional
The address of the buying customer
address2stringOptional
The address of the buying customer
postCodestringOptional
The postal code of the buying customer
citystringOptional
The city of the buying customer
countystringOptional
The county of the buying customer
countryCodestringOptional
The country where the buying customer resides.
emailstringOptional
the email address of the buying customer
phoneNostringOptional
The phone number of the buying customer.
voucherMessagestringOptional
indicates message on voucher
descriptionstringOptional
A description of the voucher, usually includes Voucher Type and Voucher Number
startingDatedatetimeOptional
The datetime as from which the voucher is valid