POST pos/cashregister/open
Authorized only.
Request Information
URI Parameters
None.
Body Parameters
CashRegisterApiModelName | Description | Type | Additional information |
---|---|---|---|
CompanyId | integer |
None. |
|
EmployeeId | integer |
None. |
|
CloseEmployeeId | integer |
None. |
|
StartUpCash | decimal number |
None. |
|
StartUpCashDenominations | string |
None. |
|
ExpectedCashInDrawer | decimal number |
None. |
|
AmountLeftInDrawer | decimal number |
None. |
|
AmountToDeposit | decimal number |
None. |
|
CashError | decimal number |
None. |
|
ExpectedCheckTotal | decimal number |
None. |
|
CheckTotal | decimal number |
None. |
|
DrawerCount | decimal number |
None. |
|
DrawerCountDenominations | string |
None. |
|
OpenDateTime | date |
None. |
|
CloseDateTime | date |
None. |
|
DeviceId | string |
None. |
|
DeviceName | string |
None. |
|
CreditCardPaymentsBreakdown | string |
None. |
|
DiscountsBreakdown | string |
None. |
|
SalesBreakdown | string |
None. |
|
OrdersCount | integer |
None. |
|
SalesSubTotal | decimal number |
None. |
|
ReturnsSubTotal | decimal number |
None. |
|
OrdersTax | decimal number |
None. |
|
OrdersDiscount | decimal number |
None. |
|
OrdersTips | decimal number |
None. |
|
CashTotal | decimal number |
None. |
|
CashReturns | decimal number |
None. |
|
GiftCardTotal | decimal number |
None. |
|
CreditCardTotal | decimal number |
None. |
|
DrawerEntries | decimal number |
None. |
|
DrawerEntryDrops | decimal number |
None. |
|
DrawerEntryPayouts | decimal number |
None. |
|
SpecialDiscountsCount | integer |
None. |
|
SpecialDiscountsAmount | decimal number |
None. |
|
GiftCardsCount | integer |
None. |
|
GiftCardsAmount | decimal number |
None. |
|
VoidsCount | integer |
None. |
|
VoidsAmount | decimal number |
None. |
|
InternalMobileId | integer |
None. |
|
Id | integer |
None. |
|
MobileId | integer |
None. |
|
IsInserted | boolean |
None. |
|
IsUpdated | boolean |
None. |
|
IsDeleted | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "CompanyId": 1, "EmployeeId": 2, "CloseEmployeeId": 1, "StartUpCash": 3.0, "StartUpCashDenominations": "sample string 4", "ExpectedCashInDrawer": 5.0, "AmountLeftInDrawer": 6.0, "AmountToDeposit": 7.0, "CashError": 8.0, "ExpectedCheckTotal": 9.0, "CheckTotal": 10.0, "DrawerCount": 11.0, "DrawerCountDenominations": "sample string 12", "OpenDateTime": "2024-10-18T01:19:41.1531322-04:00", "CloseDateTime": "2024-10-18T01:19:41.1531322-04:00", "DeviceId": "sample string 14", "DeviceName": "sample string 15", "CreditCardPaymentsBreakdown": "sample string 16", "DiscountsBreakdown": "sample string 17", "SalesBreakdown": "sample string 18", "OrdersCount": 19, "SalesSubTotal": 20.0, "ReturnsSubTotal": 21.0, "OrdersTax": 22.0, "OrdersDiscount": 23.0, "OrdersTips": 24.0, "CashTotal": 25.0, "CashReturns": 26.0, "GiftCardTotal": 27.0, "CreditCardTotal": 28.0, "DrawerEntries": 29.0, "DrawerEntryDrops": 30.0, "DrawerEntryPayouts": 31.0, "SpecialDiscountsCount": 32, "SpecialDiscountsAmount": 33.0, "GiftCardsCount": 34, "GiftCardsAmount": 35.0, "VoidsCount": 36, "VoidsAmount": 37.0, "InternalMobileId": 38, "Id": 1, "MobileId": 1, "IsInserted": true, "IsUpdated": true, "IsDeleted": true }
application/xml, text/xml
Sample:
<CashRegisterApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Data.Mapping.Mobile.Catalog"> <Id xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">1</Id> <InternalMobileId xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">38</InternalMobileId> <IsDeleted xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">true</IsDeleted> <IsInserted xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">true</IsInserted> <IsUpdated xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">true</IsUpdated> <MobileId xmlns="http://schemas.datacontract.org/2004/07/IConnect.Core.Entities.Mobile.Base">1</MobileId> <AmountLeftInDrawer xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">6</AmountLeftInDrawer> <AmountToDeposit xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">7</AmountToDeposit> <CashError xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">8</CashError> <CashReturns xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">26</CashReturns> <CashTotal xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">25</CashTotal> <CheckTotal xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">10</CheckTotal> <CloseDateTime xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">2024-10-18T01:19:41.1531322-04:00</CloseDateTime> <CloseEmployeeId xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">1</CloseEmployeeId> <CompanyId xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">1</CompanyId> <CreditCardPaymentsBreakdown xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">sample string 16</CreditCardPaymentsBreakdown> <CreditCardTotal xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">28</CreditCardTotal> <DeviceId xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">sample string 14</DeviceId> <DeviceName xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">sample string 15</DeviceName> <DiscountsBreakdown xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">sample string 17</DiscountsBreakdown> <DrawerCount xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">11</DrawerCount> <DrawerCountDenominations xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">sample string 12</DrawerCountDenominations> <DrawerEntries xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">29</DrawerEntries> <DrawerEntryDrops xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">30</DrawerEntryDrops> <DrawerEntryPayouts xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">31</DrawerEntryPayouts> <EmployeeId xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">2</EmployeeId> <ExpectedCashInDrawer xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">5</ExpectedCashInDrawer> <ExpectedCheckTotal xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">9</ExpectedCheckTotal> <GiftCardTotal xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">27</GiftCardTotal> <GiftCardsAmount xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">35</GiftCardsAmount> <GiftCardsCount xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">34</GiftCardsCount> <OpenDateTime xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">2024-10-18T01:19:41.1531322-04:00</OpenDateTime> <OrdersCount xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">19</OrdersCount> <OrdersDiscount xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">23</OrdersDiscount> <OrdersTax xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">22</OrdersTax> <OrdersTips xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">24</OrdersTips> <ReturnsSubTotal xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">21</ReturnsSubTotal> <SalesBreakdown xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">sample string 18</SalesBreakdown> <SalesSubTotal xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">20</SalesSubTotal> <SpecialDiscountsAmount xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">33</SpecialDiscountsAmount> <SpecialDiscountsCount xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">32</SpecialDiscountsCount> <StartUpCash xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">3</StartUpCash> <StartUpCashDenominations xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">sample string 4</StartUpCashDenominations> <VoidsAmount xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">37</VoidsAmount> <VoidsCount xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Register">36</VoidsCount> </CashRegisterApiModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |