Get Non-Invoiced Vouchers
Request Profile Table
Element | @Attribute |
Description/Contents |
GetNonInvoicedVouchers_RQ |
Root element of message. |
@WebResUsername |
The WebRes username of the requesting agent. |
@WebResPassword |
The WebRes password of the requesting agent. |
Scenario:
You want to get a list of all the non-invoiced vouchers where you (the WebRes user) are the supplier.
Example message:
<?xml version="1.0" encoding="utf-16"?>
<GetNonInvoicedVouchers_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" WebResUsername="myuser" WebResPassword="mypassword" />
Response Profile Table
Element | @Attribute |
Description/Contents |
GetNonInvoicedVouchers_RS |
Root element of message. |
Vouchers |
Start element for list of vouchers to be invoiced. |
VoucherDetail |
Element containing information about the request result vouchers. |
@VoucherRef |
The voucher reference code. |
@VoucherType |
The voucher type code. Typically "A" for an accommodation voucher or "O" for an operator voucher. |
@Description |
The voucher description. |
@Quantity |
The quantity of the voucher that was issued and redeemed. |
@NetCost |
The cost of a single unit of the voucher. |
@Currency |
Currency code of the voucher. |
@Redeemed |
The redemption status of the voucher. This should always be true. |
@DateRedeemed (optional) |
The date the voucher was redeemed. |
Example message:
<?xml version="1.0" encoding="utf-16"?>
<GetNonInvoicedVouchers_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<TimeStamp xmlns="ResLink">2009-01-21T11:34:11.0596246+10:00</TimeStamp>
<Errors xmlns="ResLink" />
<Warnings xmlns="ResLink" />
<Vouchers xmlns="ResLink">
<VoucherDetail VoucherRef="R5DYGY" VoucherType="A" Description="Accommodation Voucher " Quantity="1" NetCost="15" Redeemed="true" Currency="AUD" />
<VoucherDetail VoucherRef="DR5BY5" VoucherType="A" Description="Accommodation Voucher " Quantity="1" NetCost="15" Redeemed="true" Currency="AUD" />
<VoucherDetail VoucherRef="DR5BUY" VoucherType="A" Description="Accommodation Voucher " Quantity="1" NetCost="15" Redeemed="true" Currency="AUD" />
<VoucherDetail VoucherRef="MMN2ID" VoucherType="A" Description="Accommodation Voucher " Quantity="1" NetCost="15" Redeemed="true" Currency="AUD" />
<VoucherDetail VoucherRef="GY79NI" VoucherType="A" Description="Accommodation Voucher " Quantity="1" NetCost="15" Redeemed="true" Currency="AUD" />
<VoucherDetail VoucherRef="4DXEF6" VoucherType="O" Description="Pride of Airlie" Quantity="1" NetCost="261.75" Redeemed="true" Currency="AUD" />
</Vouchers>
</GetNonInvoicedVouchers_RS>