POST api/Tenders/All

Return a batch of tender class objects

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CreditCardTenders	EskimoClassLibraries.modEnums+FilterEnum	None.
EskimoRangeTenders	EskimoClassLibraries.modEnums+FilterEnum	None.
ActiveTenders	EskimoClassLibraries.modEnums+FilterEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "CreditCardTenders": 0,
  "EskimoRangeTenders": 0,
  "ActiveTenders": 0
}

application/xml, text/xml

Sample:

<TenderArguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <ActiveTenders>Exclude</ActiveTenders>
  <CreditCardTenders>Exclude</CreditCardTenders>
  <EskimoRangeTenders>Exclude</EskimoRangeTenders>
</TenderArguments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsTender

Name	Description	Type	Additional information
ID	The Eskimo identifier for the Tender item	integer	None.
Description	The description of the Tender item, i.e. Cash	string	None.
AllowChange	Specifies if over-tendering is allowed. It TRUE, a CHANGE entry can be created for the difference. If FALSE, then the POS will deny using a tender method if the value is greater than the remaining balance.	boolean	None.
AutoCompleteChange	Only applicable for when AllowChange is true. If true (usually Cash), the same tender pressed will be automatically returned as the change. If false, then the operator can choose the tender to issue the change against.	boolean	None.
OpenCashDrawer	Controls if the cash drawer is to be fired at the completion of the sale when this tender method is used.	boolean	None.
AllowRefunds	Not all tender methods can be used to perform refunds (e.g. Cheque). This property determines if the tender should even appear in the list when the sales value is less than zero.	boolean	None.
ExternalEFTService	Specifies that, when this tender button is pressed, this EFT service should be used.	EskimoClassLibraries.clsHardwareItem+EFTAcquirerEnum	None.
Active	This tender is currently active and available to use	boolean	None.
MailOrderOptions	Some logic options that specify when the tender can and cannot be used/displayed.	EskimoClassLibraries.clsMailOrderOptions	None.
MustEnterValue	Determines if the operator can just press a Tender button without typing in the amount first.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Description": "sample string 2",
    "AllowChange": true,
    "AutoCompleteChange": true,
    "OpenCashDrawer": true,
    "AllowRefunds": true,
    "ExternalEFTService": 0,
    "Active": true,
    "MailOrderOptions": {
      "WhenMailOrderItemsPresent": 0,
      "SetTenderMax": 0
    },
    "MustEnterValue": true
  },
  {
    "ID": 1,
    "Description": "sample string 2",
    "AllowChange": true,
    "AutoCompleteChange": true,
    "OpenCashDrawer": true,
    "AllowRefunds": true,
    "ExternalEFTService": 0,
    "Active": true,
    "MailOrderOptions": {
      "WhenMailOrderItemsPresent": 0,
      "SetTenderMax": 0
    },
    "MustEnterValue": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsTender xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsTender>
    <Active>true</Active>
    <AllowChange>true</AllowChange>
    <AllowRefunds>true</AllowRefunds>
    <AutoCompleteChange>true</AutoCompleteChange>
    <Description>sample string 2</Description>
    <ExternalEFTService>NotApplicable</ExternalEFTService>
    <ID>1</ID>
    <MailOrderOptions>
      <SetTenderMax>NoMax</SetTenderMax>
      <WhenMailOrderItemsPresent>Exclude</WhenMailOrderItemsPresent>
    </MailOrderOptions>
    <MustEnterValue>true</MustEnterValue>
    <OpenCashDrawer>true</OpenCashDrawer>
  </clsTender>
  <clsTender>
    <Active>true</Active>
    <AllowChange>true</AllowChange>
    <AllowRefunds>true</AllowRefunds>
    <AutoCompleteChange>true</AutoCompleteChange>
    <Description>sample string 2</Description>
    <ExternalEFTService>NotApplicable</ExternalEFTService>
    <ID>1</ID>
    <MailOrderOptions>
      <SetTenderMax>NoMax</SetTenderMax>
      <WhenMailOrderItemsPresent>Exclude</WhenMailOrderItemsPresent>
    </MailOrderOptions>
    <MustEnterValue>true</MustEnterValue>
    <OpenCashDrawer>true</OpenCashDrawer>
  </clsTender>
</ArrayOfclsTender>