POST api/Voucher/Info

POST api/Voucher/Info

Get all Informations about a voucher by his number

Request Information

URI Parameters

None.

Body Parameters

VoucherNumber, InventoryNumber

Voucher
NameDescriptionTypeAdditional information
VoucherNumber

Number of the Voucher

string

None.

InventoryNumber

Number of the Inventory where the voucher was sold

string

None.

Amount

Amount of money that will be taken in a sale Decimal

decimal number

None.

GUID

GUID of the transaction Decimal

string

None.

Request Formats

application/json, text/json

Sample:
{
  "VoucherNumber": "sample string 1",
  "InventoryNumber": "sample string 2",
  "Amount": 3.0,
  "GUID": "sample string 4"
}

application/xml, text/xml

Sample:
<Voucher xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KOSTIFC">
  <Amount>3</Amount>
  <GUID>sample string 4</GUID>
  <InventoryNumber>sample string 2</InventoryNumber>
  <VoucherNumber>sample string 1</VoucherNumber>
</Voucher>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Voucher Infos

VoucherInfo
NameDescriptionTypeAdditional information
Valid

Boolean to determine if the voucher is marked as valid and the Valdi Until date hasn't ben reached

boolean

None.

Balance

Amount of money the Voucher is good for Decimal

decimal number

None.

PLUSale

PLU of the item to be used when a voucher is sold

integer

None.

PLUCharge

PLU of the item to be used when a voucher is charged up

integer

None.

MaxBalance

Maximum amount of money the voucher can stand for

decimal number

None.

Chargeable

Boolean to determine if the voucher is chargeable

boolean

None.

Saleable

Boolean to determine if the voucher is saleable

boolean

None.

PaymentMethod

PaymentMethod tthe voucher is assigned to

string

None.

ValueMode

0=value of voucher can be assigned freely at POS; 1= Fixed value from StandardValue has to be used when sold

integer

None.

StandardValue

StandardValue for the balance of the voucher. (0 = can be freely assigned at POS)

decimal number

None.

ValidFrom

Date from which on the voucher is valid

date

None.

ValidUntil

Date until which the voucher is valid

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Valid": true,
  "Balance": 2.0,
  "PLUSale": 3,
  "PLUCharge": 4,
  "MaxBalance": 5.0,
  "Chargeable": true,
  "Saleable": true,
  "PaymentMethod": "sample string 8",
  "ValueMode": 9,
  "StandardValue": 10.0,
  "ValidFrom": "2026-04-14T03:16:37.5893897+00:00",
  "ValidUntil": "2026-04-14T03:16:37.5893897+00:00"
}

application/xml, text/xml

Sample:
<VoucherInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KOSTIFC">
  <Balance>2</Balance>
  <Chargeable>true</Chargeable>
  <MaxBalance>5</MaxBalance>
  <PLUCharge>4</PLUCharge>
  <PLUSale>3</PLUSale>
  <PaymentMethod>sample string 8</PaymentMethod>
  <Saleable>true</Saleable>
  <StandardValue>10</StandardValue>
  <Valid>true</Valid>
  <ValidFrom>2026-04-14T03:16:37.5893897+00:00</ValidFrom>
  <ValidUntil>2026-04-14T03:16:37.5893897+00:00</ValidUntil>
  <ValueMode>9</ValueMode>
</VoucherInfo>