als_get_vouchers.cgi

Top Previous Next

Description

The als_get_vouchers.cgi interface will retrieve voucher information.

Example Usage http://www.alstracker.dnsalias.com/aldesk/als_get_vouchers.cgi?voucher=20578

Vouchers can be identified by either the primekey (seq) or by using the client:Integer identifier along with the voucher number. When editing a voucher with AL-Desk, the Client Identifier along with a voucher number that is unique for that client is used.

A voucher can be uniquely identified by one of two methods

•

seq

•	client and voucher

Inputs

Parameter	Description	Required	Example	Data Type
seq	Primekey of vouchers	Required	seq=20843	Integer
voucher	Voucher Code to limit the result set to one voucher	Required	voucher=20000	Integer
client	Returns vouchers for the unique client identifier that ties to als_get_client.cgi	Required	client=103046	Integer
issued	for use with client parameter to show vouchers not issued. Could be used to view vouchers written but not issued.	Optional	issued=false	Boolean

Returned Fields

#	Field Name	Description	Data Type

Example XML

<?xml version="1.0" encoding="utf-8" ?>

- <root>

- <vouchers>

</vouchers>

</root>