API ReferenceGuides
Guides
Home
Start typing to search…

Read Pos Channel Drawer Count

Retrieves the details of a Pos Channel Drawer Count object that has been previously created.

Parameters

Path Params

yourCompany:

string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Pos-Channel-Drawer-Count will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Pos-Channel-Drawer-Count

Query Params

filter:

string
In this parameter fieldname needs to be provided with condition and value
to fetch related details.for eg. Sales Channel Name,eq,Store 1;Lane Number,eq,1;Date,eq,04-29-2021

  • *NOTE:** For Pos Channel Drawer Count
    All three filters Sales Channel ,Lane Number and Date are mandatory.\
  1. To fetch Pos Channel Drawer Count with Sales Channel equal to Store 1,Lane Number equal to 1,Date equal to Store 04-29-2021, the following url must be used

List of condition abbrevations to be used:
"cs": contain string (string contains value)
"sw": start with (string starts with value)
"ew": end with (string end with value)
"neq": not equal (string or number should not match)
"eq": equal (string or number matches exactly)
"lt": lower than (number is lower than value)
"le": lower or equal (number is lower than or equal to value)
"ge": greater or equal (number is higher than or equal to value)
"gt": greater than (number is higher than value)
"bt": between (number is between two comma separated values)

page:

int
Page number needs to be passed in this variable ,to paginate the response.

pageSize:

int
In this parameter pageSize number needs to be provided to fetch related page details.

Header Params

Accept:

string
Response header need to be passed for eg. application/json or application/xml.

Query Auth

key:

string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.

Header Auth

apiKey:

string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

{
	"DrawerCounts": {
		"DrawerCount": [{
				"Begin": "0.000",
				"Leave": "1100.000",
				"PaidOut": "0.000",
				"Deposit": "-1100.000",
				"NonCurrencyTotal": "0.000",
				"NonCurrencyCreditCards": "0.000",
				"NonCurrencyChecks": "0.000",
				"NonCurrencyOther": "0.000",
				"Type": "Begin",
				"Comments": null
			},
			{
				"Begin": "1100.000",
				"Leave": "100.000",
				"PaidOut": "0.000",
				"Deposit": "-100.000",
				"NonCurrencyTotal": "0.000",
				"NonCurrencyCreditCards": "0.000",
				"NonCurrencyChecks": "0.000",
				"NonCurrencyOther": "0.000",
				"Type": "Drawer",
				"ExpectedBeginingCash": "400.000",
				"BeginCash": "1100.000",
				"ClosingKeep": "0.000",
				"CashDeposit": "0.000",
				"CheckDeposit": "0.000",
				"Comments": null
			}
		],
		"CreatedDate": "2023-01-30",
		"TotalRecords": "2",
		"CurrentPage": "1",
		"TotalPages": "1",
		"PageSize": "50"
	}
}
<DrawerCounts>
    <DrawerCount>
        <Begin>0.000</Begin>
        <Leave>1100.000</Leave>
        <PaidOut>0.000</PaidOut>
        <Deposit>-1100.000</Deposit>
        <NonCurrencyTotal>0.000</NonCurrencyTotal>
      	<NonCurrencyCreditCards>0.000</NonCurrencyCreditCards>
      	<NonCurrencyChecks>0.000</NonCurrencyChecks>
      	<NonCurrencyOther>0.000</NonCurrencyOther>
      	<Type>Begin</Type>
        <Comments></Comments>
    </DrawerCount>
    <DrawerCount>
        <Begin>1100.000</Begin>
        <Leave>100.000</Leave>
        <PaidOut>0.000</PaidOut>
        <Deposit>-100.000</Deposit>
        <NonCurrencyTotal>0.000</NonCurrencyTotal>
      	<NonCurrencyCreditCards>0.000</NonCurrencyCreditCards>
      	<NonCurrencyChecks>0.000</NonCurrencyChecks>
      	<NonCurrencyOther>0.000</NonCurrencyOther>
      	<Type>Drawer</Type>
        <ExpectedBeginingCash>400.000</ExpectedBeginingCash>
        <BeginCash>1100.000</BeginCash>
        <ClosingKeep>0.000</ClosingKeep>
        <CashDeposit>0.000</CashDeposit>
        <CheckDeposit>0.000</CheckDeposit>
        <Comments></Comments>
    </DrawerCount>
  	<CreatedDate>2023-01-30</CreatedDate>
    <TotalRecords>2</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</DrawerCounts>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="Pos-Channel-Drawer-Count"> 
       <method name="GET">
	   			<resource path="{filter}">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>

Updated about 21 hours ago

© Copyright 2022 Agiliron - All Rights Reserved.