POST api/v1/{posId}/cashregsettlements
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| posId | string |
None. |
Body Parameters
CashRegSettlementHeaderPosted| Name | Description | Type | Additional information |
|---|---|---|---|
| Key | string |
None. |
|
| StoreID | string |
None. |
|
| AmountToBank | decimal number |
None. |
|
| COGS | decimal number |
None. |
|
| CommissionAmount | decimal number |
None. |
|
| CreditCardCommissionAmount | decimal number |
None. |
|
| Date | date |
None. |
|
| DateFrom | date |
None. |
|
| Deposit | decimal number |
None. |
|
| GiftCertificate | decimal number |
None. |
|
| IncomingAmount | decimal number |
None. |
|
| IsSynchronized | boolean |
None. |
|
| No | string |
None. |
|
| NoOfCommission | integer |
None. |
|
| NoOfCreditCardCommission | decimal number |
None. |
|
| NoOfDeposits | integer |
None. |
|
| NoOfGiftCertificate | integer |
None. |
|
| NoOfPayments | integer |
None. |
|
| NoOfReturns | integer |
None. |
|
| NoOfWithdrawals | integer |
None. |
|
| OutgoingAmount | decimal number |
None. |
|
| Payment | decimal number |
None. |
|
| Return | decimal number |
None. |
|
| SalesPersonNo | string |
None. |
|
| SettlementBagNo | string |
None. |
|
| StoreSettlement | boolean |
None. |
|
| SumExVAT | decimal number |
None. |
|
| SumInclVAT | decimal number |
None. |
|
| SumNoVAT | decimal number |
None. |
|
| SumRounding | decimal number |
None. |
|
| SyncTime | date |
None. |
|
| TotalSales | decimal number |
None. |
|
| Withdrawal | decimal number |
None. |
|
| Lines | Collection of CashRegSettlementLinePosted |
None. |
|
| Reconciliations | Collection of CashRegSettlementReconciliation |
None. |
|
| Created | date |
None. |
|
| IsSyncedToMaster | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Key": "sample string 2",
"StoreID": "sample string 1",
"AmountToBank": 1.0,
"COGS": 1.0,
"CommissionAmount": 1.0,
"CreditCardCommissionAmount": 1.0,
"Date": "2025-12-06T05:45:06.5933465+01:00",
"DateFrom": "2025-12-06T05:45:06.5933465+01:00",
"Deposit": 1.0,
"GiftCertificate": 1.0,
"IncomingAmount": 1.0,
"IsSynchronized": true,
"No": "sample string 2",
"NoOfCommission": 1,
"NoOfCreditCardCommission": 1.0,
"NoOfDeposits": 1,
"NoOfGiftCertificate": 1,
"NoOfPayments": 1,
"NoOfReturns": 1,
"NoOfWithdrawals": 1,
"OutgoingAmount": 1.0,
"Payment": 1.0,
"Return": 1.0,
"SalesPersonNo": "sample string 3",
"SettlementBagNo": "sample string 4",
"StoreSettlement": true,
"SumExVAT": 1.0,
"SumInclVAT": 1.0,
"SumNoVAT": 1.0,
"SumRounding": 1.0,
"SyncTime": "2025-12-06T05:45:06.5933465+01:00",
"TotalSales": 1.0,
"Withdrawal": 1.0,
"Lines": [
{
"AmountToBank": 1.0,
"CurrencyRate": 1.0,
"CurrencyCode": "sample string 1",
"Description": "sample string 2",
"Difference": 1.0,
"DifferenceCurrency": 1.0,
"IncomingAmount": 1.0,
"No": "sample string 3",
"OutgoingAmount": 1.0,
"Quantity": 1.0,
"SettlementNo": "sample string 4",
"StoreID": "sample string 5",
"SumCalculated": 1.0,
"SumCalculatedCurrency": 1.0,
"SumCalculatedLocalCurrency": 1.0,
"SumCounted": 1.0,
"SumCountedCurrency": 1.0
},
{
"AmountToBank": 1.0,
"CurrencyRate": 1.0,
"CurrencyCode": "sample string 1",
"Description": "sample string 2",
"Difference": 1.0,
"DifferenceCurrency": 1.0,
"IncomingAmount": 1.0,
"No": "sample string 3",
"OutgoingAmount": 1.0,
"Quantity": 1.0,
"SettlementNo": "sample string 4",
"StoreID": "sample string 5",
"SumCalculated": 1.0,
"SumCalculatedCurrency": 1.0,
"SumCalculatedLocalCurrency": 1.0,
"SumCounted": 1.0,
"SumCountedCurrency": 1.0
}
],
"Reconciliations": [
{
"Key": "3",
"CashRegSettlementNo": "sample string 1",
"Date": "2025-12-06T05:45:06.5933465+01:00",
"LineNo": 3,
"StoreID": "sample string 4",
"Text": "sample string 5",
"IsSyncedToMaster": true
},
{
"Key": "3",
"CashRegSettlementNo": "sample string 1",
"Date": "2025-12-06T05:45:06.5933465+01:00",
"LineNo": 3,
"StoreID": "sample string 4",
"Text": "sample string 5",
"IsSyncedToMaster": true
}
],
"Created": "2025-12-06T05:45:06.5933465+01:00",
"IsSyncedToMaster": true
}
text/html
Sample:
{"Key":"sample string 2","StoreID":"sample string 1","AmountToBank":1.0,"COGS":1.0,"CommissionAmount":1.0,"CreditCardCommissionAmount":1.0,"Date":"2025-12-06T05:45:06.5933465+01:00","DateFrom":"2025-12-06T05:45:06.5933465+01:00","Deposit":1.0,"GiftCertificate":1.0,"IncomingAmount":1.0,"IsSynchronized":true,"No":"sample string 2","NoOfCommission":1,"NoOfCreditCardCommission":1.0,"NoOfDeposits":1,"NoOfGiftCertificate":1,"NoOfPayments":1,"NoOfReturns":1,"NoOfWithdrawals":1,"OutgoingAmount":1.0,"Payment":1.0,"Return":1.0,"SalesPersonNo":"sample string 3","SettlementBagNo":"sample string 4","StoreSettlement":true,"SumExVAT":1.0,"SumInclVAT":1.0,"SumNoVAT":1.0,"SumRounding":1.0,"SyncTime":"2025-12-06T05:45:06.5933465+01:00","TotalSales":1.0,"Withdrawal":1.0,"Lines":[{"AmountToBank":1.0,"CurrencyRate":1.0,"CurrencyCode":"sample string 1","Description":"sample string 2","Difference":1.0,"DifferenceCurrency":1.0,"IncomingAmount":1.0,"No":"sample string 3","OutgoingAmount":1.0,"Quantity":1.0,"SettlementNo":"sample string 4","StoreID":"sample string 5","SumCalculated":1.0,"SumCalculatedCurrency":1.0,"SumCalculatedLocalCurrency":1.0,"SumCounted":1.0,"SumCountedCurrency":1.0},{"AmountToBank":1.0,"CurrencyRate":1.0,"CurrencyCode":"sample string 1","Description":"sample string 2","Difference":1.0,"DifferenceCurrency":1.0,"IncomingAmount":1.0,"No":"sample string 3","OutgoingAmount":1.0,"Quantity":1.0,"SettlementNo":"sample string 4","StoreID":"sample string 5","SumCalculated":1.0,"SumCalculatedCurrency":1.0,"SumCalculatedLocalCurrency":1.0,"SumCounted":1.0,"SumCountedCurrency":1.0}],"Reconciliations":[{"Key":"3","CashRegSettlementNo":"sample string 1","Date":"2025-12-06T05:45:06.5933465+01:00","LineNo":3,"StoreID":"sample string 4","Text":"sample string 5","IsSyncedToMaster":true},{"Key":"3","CashRegSettlementNo":"sample string 1","Date":"2025-12-06T05:45:06.5933465+01:00","LineNo":3,"StoreID":"sample string 4","Text":"sample string 5","IsSyncedToMaster":true}],"Created":"2025-12-06T05:45:06.5933465+01:00","IsSyncedToMaster":true}
application/x-www-form-urlencoded
Sample:
Sample not available.
application/xml, text/xml
Sample:
<Root>
<Data>
<Key>sample string 2</Key>
<StoreID>sample string 1</StoreID>
<AmountToBank>1</AmountToBank>
<COGS>1</COGS>
<CommissionAmount>1</CommissionAmount>
<CreditCardCommissionAmount>1</CreditCardCommissionAmount>
<Date>2025-12-06T05:45:06.5933465+01:00</Date>
<DateFrom>2025-12-06T05:45:06.5933465+01:00</DateFrom>
<Deposit>1</Deposit>
<GiftCertificate>1</GiftCertificate>
<IncomingAmount>1</IncomingAmount>
<IsSynchronized>true</IsSynchronized>
<No>sample string 2</No>
<NoOfCommission>1</NoOfCommission>
<NoOfCreditCardCommission>1</NoOfCreditCardCommission>
<NoOfDeposits>1</NoOfDeposits>
<NoOfGiftCertificate>1</NoOfGiftCertificate>
<NoOfPayments>1</NoOfPayments>
<NoOfReturns>1</NoOfReturns>
<NoOfWithdrawals>1</NoOfWithdrawals>
<OutgoingAmount>1</OutgoingAmount>
<Payment>1</Payment>
<Return>1</Return>
<SalesPersonNo>sample string 3</SalesPersonNo>
<SettlementBagNo>sample string 4</SettlementBagNo>
<StoreSettlement>true</StoreSettlement>
<SumExVAT>1</SumExVAT>
<SumInclVAT>1</SumInclVAT>
<SumNoVAT>1</SumNoVAT>
<SumRounding>1</SumRounding>
<SyncTime>2025-12-06T05:45:06.5933465+01:00</SyncTime>
<TotalSales>1</TotalSales>
<Withdrawal>1</Withdrawal>
<Lines>
<AmountToBank>1</AmountToBank>
<CurrencyRate>1</CurrencyRate>
<CurrencyCode>sample string 1</CurrencyCode>
<Description>sample string 2</Description>
<Difference>1</Difference>
<DifferenceCurrency>1</DifferenceCurrency>
<IncomingAmount>1</IncomingAmount>
<No>sample string 3</No>
<OutgoingAmount>1</OutgoingAmount>
<Quantity>1</Quantity>
<SettlementNo>sample string 4</SettlementNo>
<StoreID>sample string 5</StoreID>
<SumCalculated>1</SumCalculated>
<SumCalculatedCurrency>1</SumCalculatedCurrency>
<SumCalculatedLocalCurrency>1</SumCalculatedLocalCurrency>
<SumCounted>1</SumCounted>
<SumCountedCurrency>1</SumCountedCurrency>
</Lines>
<Lines>
<AmountToBank>1</AmountToBank>
<CurrencyRate>1</CurrencyRate>
<CurrencyCode>sample string 1</CurrencyCode>
<Description>sample string 2</Description>
<Difference>1</Difference>
<DifferenceCurrency>1</DifferenceCurrency>
<IncomingAmount>1</IncomingAmount>
<No>sample string 3</No>
<OutgoingAmount>1</OutgoingAmount>
<Quantity>1</Quantity>
<SettlementNo>sample string 4</SettlementNo>
<StoreID>sample string 5</StoreID>
<SumCalculated>1</SumCalculated>
<SumCalculatedCurrency>1</SumCalculatedCurrency>
<SumCalculatedLocalCurrency>1</SumCalculatedLocalCurrency>
<SumCounted>1</SumCounted>
<SumCountedCurrency>1</SumCountedCurrency>
</Lines>
<Reconciliations>
<Key>3</Key>
<CashRegSettlementNo>sample string 1</CashRegSettlementNo>
<Date>2025-12-06T05:45:06.5933465+01:00</Date>
<LineNo>3</LineNo>
<StoreID>sample string 4</StoreID>
<Text>sample string 5</Text>
<IsSyncedToMaster>true</IsSyncedToMaster>
</Reconciliations>
<Reconciliations>
<Key>3</Key>
<CashRegSettlementNo>sample string 1</CashRegSettlementNo>
<Date>2025-12-06T05:45:06.5933465+01:00</Date>
<LineNo>3</LineNo>
<StoreID>sample string 4</StoreID>
<Text>sample string 5</Text>
<IsSyncedToMaster>true</IsSyncedToMaster>
</Reconciliations>
<Created>2025-12-06T05:45:06.5933465+01:00</Created>
<IsSyncedToMaster>true</IsSyncedToMaster>
</Data>
</Root>
application/csv
Sample:
Sample not available.
text/csv
Sample:
Sample not available.
Response Information
Resource Description
stringResponse Formats
application/json, text/json, text/html
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<Root> <Data>sample string 1</Data> </Root>
application/csv
Sample:
Sample not available.
text/csv
Sample:
Sample not available.