POST api/vouchers/select

Retrieves a list of vouchers that match the given criteria.

Request Information

URI Parameters

None.

Body Parameters

The criteria model to filter vouchers by.

VoucherFilterCriteria
NameDescriptionTypeAdditional information
Id

integer

None.
Code

string

None.
TenantId

globally unique identifier

None.
IsDeleted

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Code": "sample string 1",
  "TenantId": "df105b3c-8be6-40b2-b41b-c2127ab6e2f6",
  "IsDeleted": true
}

application/xml, text/xml

Sample: 
<VoucherFilterCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models.FilterCriteria">
  <Code>sample string 1</Code>
  <Id>1</Id>
  <IsDeleted>true</IsDeleted>
  <TenantId>df105b3c-8be6-40b2-b41b-c2127ab6e2f6</TenantId>
</VoucherFilterCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.