| PUT | /POS/Batches/{BatchID}/Receipts |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BatchID | form | Guid | Yes | |
| POSNum | form | int | Yes | |
| BatchNum | form | int | Yes | |
| OpDate | form | DateTime | Yes | |
| Receipts | form | List<Receipt> | Yes | |
| POSData | form | POSData | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReceiptID | form | Guid | Yes | |
| ReceiptNum | form | int | No | |
| ReceiptLink | form | int? | No | |
| OpType | form | byte | Yes | 1 - Sale, 2 - Return sale, 3 - Void sale, 4 - Void return sale, 5 - Cash in, 6 - Cash out, 7 - X report, 8 - Z report (Close batch), 9 - Open batch, 11 - Gift, 12 - Return gift, 13 - Void gift, 14 - Void return gift |
| DiplomatID | form | string | No | |
| DiscountCard | form | string | No | |
| DicountCardRate | form | decimal? | No | |
| Prods | form | List<ReceiptProduct> | No | Sold goods/services |
| Payments | form | List<ReceiptPayment> | No | Received payments |
| InnerOpers | form | List<ReceiptInnerOper> | No | X/Z/CashIn/CashOut - info |
| ClientInfo | form | List<ReceiptCLInfo> | No | Wholesale client info + waybill info |
| AltX | form | int | No | |
| Offline | form | bool | No | |
| ServiceCode | form | string | No | |
| ServicePrice | form | decimal? | No | |
| RecStatus | form | int | Yes | 0 - active(open), 1 - suspended, 2 - deleted, 3 - suspended deleted, 4 - closed, 5 - rezerved for future 6 - closed deleted |
| EditedStatus | form | int? | No | |
| ActionId | form | Guid? | No | |
| ActionPoints | form | decimal | No | |
| ActionNote | form | string | No | |
| DiscountCardPointK | form | decimal? | No | |
| PointsSpent | form | decimal? | No | |
| Coupons | form | List<ReceiptCoupon> | No | |
| PhInfo | form | ReceiptPhInfo | No | |
| TaxFreeInfo | form | List<ReceiptTaxFreeInfo> | No | |
| Consultant | form | List<ReceiptConsultant> | No | |
| Lottery | form | List<ReceiptLottery> | No | |
| ManzanaCheques | form | List<ReceiptManzCheques> | No | |
| Prescriptions | form | List<MohPrescription> | No | |
| PrescriptionProds | form | List<MohPrescriptionProds> | No | |
| ReceiptData | form | List<PosReceiptData> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProdRecID | form | Guid | Yes | |
| RecType | form | byte | No | |
| ProdPPID | form | string | Yes | ProductId |
| Price | form | decimal | Yes | |
| SCount | form | decimal | Yes | Quantity |
| Vg | form | decimal | Yes | Total amount = (Price * Scount) * ( 1 - Discount) |
| Vat | form | decimal | Yes | Vat % |
| Discount | form | decimal? | No | Discount % |
| CashierID | form | int | Yes | |
| Points | form | decimal? | No | |
| OpDate | form | DateTime | Yes | |
| RecStatus | form | byte | Yes | Same as receipt RecStatus |
| UTypeH | form | bool | No | |
| SupplieId | form | string | No | |
| IsService | form | int | Yes | Good or service |
| Description | form | string | No | |
| PType | form | int? | No | |
| OpDtCh | form | DateTime? | No | |
| OpDtDel | form | DateTime? | No | |
| OrdNum | form | int? | No | |
| GiftStatus | form | int? | No | |
| ChangeLog | form | List<ReceiptProductLog> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecId | form | Guid | No | |
| SCount | form | decimal | No | |
| CashierID | form | int | No | |
| OpDtCh | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentID | form | Guid | Yes | |
| RecType | form | byte | No | |
| PaymentType | form | byte | Yes | 0 - Cash, for other see /POS/PaymentTypes |
| Amount | form | decimal? | Yes | |
| CashierID | form | int | Yes | |
| OpDate | form | DateTime | Yes | |
| RecStatus | form | byte | Yes | Same as receipt RecStatus |
| PaymentSubType | form | string | No | |
| PaymentSubTypeId | form | string | No | |
| OpDtDel | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | form | Guid | No | |
| RecType | form | byte | No | |
| CashierID | form | int | No | |
| OpDate | form | DateTime | No | |
| Amount | form | decimal? | No | |
| PriceG | form | decimal? | No | |
| SPriceG | form | decimal? | No | |
| GDiscount | form | decimal? | No | |
| PriceU | form | decimal? | No | |
| SPriceDefD | form | decimal? | No | |
| PriceDefG | form | decimal? | No | |
| SPriceDefG | form | decimal? | No | |
| GPoints | form | decimal? | No | |
| SGPoints | form | decimal? | No | |
| BPriceU | form | decimal? | No | |
| BPriceDefG | form | decimal? | No | |
| PaymentID | form | Guid? | No | |
| PaymentType | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| rec_id | form | Guid | No | |
| docs_id | form | string | No | |
| buer_n | form | string | No | |
| buer_in | form | string | No | |
| buer_addr | form | string | No | |
| cons_n | form | string | No | |
| consee_n | form | string | No | |
| tr_mark | form | string | No | |
| tr_n | form | string | No | |
| tr_sert | form | string | No | |
| payment_n | form | string | No | |
| payment_d | form | DateTime? | No | |
| acc | form | string | No | |
| opkind | form | int? | No | |
| trkind | form | int? | No | |
| tr_other | form | string | No | |
| drforeign | form | bool? | No | |
| drname | form | string | No | |
| trpay | form | decimal? | No | |
| trwhopay | form | decimal? | No | |
| bforeign | form | bool? | No | |
| notes | form | string | No | |
| delivery_d | form | DateTime? | No | |
| id | form | int? | No | |
| status | form | decimal? | No | |
| Chained | form | DateTime? | No | |
| Deleted | form | bool | No | |
| taxdoc_id | form | long? | No | |
| car_model | form | string | No | |
| cashierid | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecId | form | Guid | No | |
| CouponId | form | int | No | |
| CashierId | form | int | No | |
| OpDate | form | DateTime | No | |
| Status | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompId | form | int? | No | |
| Acc | form | string | No | |
| AccNu | form | string | No | |
| ProviderServiceId | form | string | No | |
| MarketPartId | form | string | No | |
| MarketPartName | form | string | No | |
| InsurancePolice | form | string | No | |
| PrescriptionNum | form | string | No | |
| Pernum | form | string | No | |
| CardN | form | string | No | |
| Doctor | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Limit1 | form | decimal? | No | |
| Limit2 | form | int? | No | |
| Ensurer | form | decimal? | No | |
| Ensured | form | decimal? | No | |
| Note | form | string | No | |
| ByService | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| rec_id | form | Guid | No | |
| first_name | form | string | No | |
| last_name | form | string | No | |
| pasport_num | form | string | No | |
| pasport_serie | form | string | No | |
| personal_number | form | string | No | |
| country_id | form | string | No | |
| address | form | string | No | |
| cashierid | form | int | No | |
| opdatetime | form | DateTime | No | |
| opkind | form | int | No | |
| rec_status | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| rec_id | form | Guid | No | |
| consultant_id | form | int | No | |
| note | form | string | No | |
| cashierid | form | int | No | |
| opdatetime | form | DateTime | No | |
| opkind | form | int | No | |
| rec_status | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecId | form | Guid | No | |
| LinkRecId | form | Guid? | No | |
| LotteryCode | form | string | No | |
| InnerOperId | form | Guid? | No | |
| PaymentId | form | Guid? | No | |
| Idunique | form | int | No | |
| Stage | form | int | No | |
| Dtstamp | form | DateTime? | No | |
| Lotoptype | form | int | No | |
| PersonalId | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| BirthDate | form | DateTime? | No | |
| MobilePh | form | string | No | |
| Address | form | string | No | |
| UniqueReqId | form | long? | No | |
| ConfigVersion | form | string | No | |
| CurrentTime | form | DateTime? | No | |
| Description | form | string | No | |
| DetailedReason | form | string | No | |
| DrawConfigVersion | form | string | No | |
| DrawPrizes | form | string | No | |
| GameId | form | string | No | |
| GameName | form | string | No | |
| HumanMessage | form | string | No | |
| Payout | form | decimal? | No | |
| Result | form | string | No | |
| Serial | form | string | No | |
| Taxes | form | string | No | |
| TotalPrize | form | decimal? | No | |
| TotalTax | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| cardid | form | string | No | |
| soft_request | form | string | No | |
| soft_response | form | string | No | |
| soft_error_xml | form | string | No | |
| fiscal_request | form | string | No | |
| fiscal_response | form | string | No | |
| fiscal_error_xml | form | string | No | |
| back_request | form | string | No | |
| back_response | form | string | No | |
| back_error_xml | form | string | No | |
| back_time | form | DateTime? | No | |
| back_points | form | decimal? | No | |
| upload_status | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UNID | form | int | No | |
| DS | form | string | No | |
| Is_Generic | form | int | No | |
| Product_ID | form | int | No | |
| Prescr_ID | form | string | No | |
| RecipeNo | form | string | No | |
| Oper_Date | form | DateTime? | No | |
| Duration | form | DateTime? | No | |
| Prod_Descr | form | string | No | |
| ProductGeneric | form | string | No | |
| Dosage_Priv | form | bool | No | |
| Prod_Count | form | int | No | |
| Prod_Left | form | int | No | |
| Status | form | string | No | |
| PharmaTherapyGroup | form | string | No | |
| IssuanceMode | form | string | No | |
| IdNumber | form | string | No | |
| Birthday | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| good_id | form | Guid | No | |
| receipt_id | form | Guid | No | |
| UNID | form | int | No | |
| ProdPharmCnt | form | int | No | |
| ProdCnt | form | int | No | |
| NewDS | form | string | No | |
| ReciverID | form | string | No | |
| Sale_UNID | form | int? | No | |
| SaleStatus | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| id | form | int? | No | |
| receipt_id | form | Guid | No | |
| card_id | form | string | No | |
| data_type | form | ReceiptDataType | No | |
| data | form | string | No | |
| rec_status | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrentBatchId | form | Guid? | No | |
| CurrentBatchDate | form | DateTime? | No | |
| LastBatchDate | form | DateTime? | No | |
| IsBatchOpen | form | bool | No | |
| CurrentBatchNumber | form | int? | No | |
| LastReceiptNumbers | form | LastReceiptNumbers | No | |
| ReceiptTotals | form | ReceiptTotals | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Sale | form | int? | No | |
| Return | form | int? | No | |
| SaleStorn | form | int? | No | |
| ReturnStorn | form | int? | No | |
| CashIn | form | int? | No | |
| CashOut | form | int? | No | |
| XReport | form | int? | No | |
| ZReport | form | int? | No | |
| BatchOpen | form | int? | No | |
| form | long? | No | ||
| Gift | form | int? | No | |
| ReturnGift | form | int? | No | |
| GiftStorn | form | int? | No | |
| ReturnGiftStorn | form | int? | No | |
| Movement | form | int? | No | |
| CashBackOut | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InCash | form | decimal? | No | |
| InNonCash | form | decimal? | No | |
| OutCash | form | decimal? | No | |
| OutNonCash | form | decimal? | No | |
| Current | form | decimal? | No | |
| SaleCash | form | decimal? | No | |
| SaleStornCash | form | decimal? | No | |
| ReturnCash | form | decimal? | No | |
| ReturnStornCash | form | decimal? | No | |
| Gift | form | decimal? | No | |
| GiftStorn | form | decimal? | No | |
| ReturnGift | form | decimal? | No | |
| ReturnGiftStorn | form | decimal? | No | |
| ReturnCashBack | form | decimal? | No | |
| ReturnStornCashBack | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Result | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /POS/Batches/{BatchID}/Receipts HTTP/1.1
Host: 10.10.0.107
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
BatchID: 00000000000000000000000000000000,
POSNum: 0,
BatchNum: 0,
OpDate: 0001-01-01,
Receipts:
[
{
ReceiptID: 00000000000000000000000000000000,
ReceiptNum: 0,
ReceiptLink: 0,
OpType: 0,
DiplomatID: String,
DiscountCard: String,
DicountCardRate: 0,
Prods:
[
{
ProdRecID: 00000000000000000000000000000000,
RecType: 0,
ProdPPID: String,
Price: 0,
SCount: 0,
Vg: 0,
Vat: 0,
Discount: 0,
CashierID: 0,
Points: 0,
OpDate: 0001-01-01,
RecStatus: 0,
UTypeH: False,
SupplieId: String,
IsService: 0,
Description: String,
PType: 0,
OpDtCh: 0001-01-01,
OpDtDel: 0001-01-01,
OrdNum: 0,
GiftStatus: 0,
ChangeLog:
[
{
RecId: 00000000000000000000000000000000,
SCount: 0,
CashierID: 0,
OpDtCh: 0001-01-01
}
]
}
],
Payments:
[
{
PaymentID: 00000000000000000000000000000000,
RecType: 0,
PaymentType: 0,
Amount: 0,
CashierID: 0,
OpDate: 0001-01-01,
RecStatus: 0,
PaymentSubType: String,
PaymentSubTypeId: String,
OpDtDel: 0001-01-01
}
],
InnerOpers:
[
{
RecID: 00000000000000000000000000000000,
RecType: 0,
CashierID: 0,
OpDate: 0001-01-01,
Amount: 0,
PriceG: 0,
SPriceG: 0,
GDiscount: 0,
PriceU: 0,
SPriceDefD: 0,
PriceDefG: 0,
SPriceDefG: 0,
GPoints: 0,
SGPoints: 0,
BPriceU: 0,
BPriceDefG: 0,
PaymentID: 00000000000000000000000000000000,
PaymentType: 0
}
],
ClientInfo:
[
{
rec_id: 00000000000000000000000000000000,
docs_id: String,
buer_n: String,
buer_in: String,
buer_addr: String,
cons_n: String,
consee_n: String,
tr_mark: String,
tr_n: String,
tr_sert: String,
payment_n: String,
payment_d: 0001-01-01,
acc: String,
opkind: 0,
trkind: 0,
tr_other: String,
drforeign: False,
drname: String,
trpay: 0,
trwhopay: 0,
bforeign: False,
notes: String,
delivery_d: 0001-01-01,
id: 0,
status: 0,
Chained: 0001-01-01,
Deleted: False,
taxdoc_id: 0,
car_model: String,
cashierid: 0
}
],
AltX: 0,
Offline: False,
ServiceCode: String,
ServicePrice: 0,
RecStatus: 0,
EditedStatus: 0,
ActionId: 00000000000000000000000000000000,
ActionPoints: 0,
ActionNote: String,
DiscountCardPointK: 0,
PointsSpent: 0,
Coupons:
[
{
RecId: 00000000000000000000000000000000,
CouponId: 0,
CashierId: 0,
OpDate: 0001-01-01,
Status: 0
}
],
PhInfo:
{
CompId: 0,
Acc: String,
AccNu: String,
ProviderServiceId: String,
MarketPartId: String,
MarketPartName: String,
InsurancePolice: String,
PrescriptionNum: String,
Pernum: String,
CardN: String,
Doctor: String,
FirstName: String,
LastName: String,
Limit1: 0,
Limit2: 0,
Ensurer: 0,
Ensured: 0,
Note: String,
ByService: False
},
TaxFreeInfo:
[
{
rec_id: 00000000000000000000000000000000,
first_name: String,
last_name: String,
pasport_num: String,
pasport_serie: String,
personal_number: String,
country_id: String,
address: String,
cashierid: 0,
opdatetime: 0001-01-01,
opkind: 0,
rec_status: 0
}
],
Consultant:
[
{
rec_id: 00000000000000000000000000000000,
consultant_id: 0,
note: String,
cashierid: 0,
opdatetime: 0001-01-01,
opkind: 0,
rec_status: 0
}
],
Lottery:
[
{
RecId: 00000000000000000000000000000000,
LinkRecId: 00000000000000000000000000000000,
LotteryCode: String,
InnerOperId: 00000000000000000000000000000000,
PaymentId: 00000000000000000000000000000000,
Idunique: 0,
Stage: 0,
Dtstamp: 0001-01-01,
Lotoptype: 0,
PersonalId: String,
FirstName: String,
LastName: String,
BirthDate: 0001-01-01,
MobilePh: String,
Address: String,
UniqueReqId: 0,
ConfigVersion: String,
CurrentTime: 0001-01-01,
Description: String,
DetailedReason: String,
DrawConfigVersion: String,
DrawPrizes: String,
GameId: String,
GameName: String,
HumanMessage: String,
Payout: 0,
Result: String,
Serial: String,
Taxes: String,
TotalPrize: 0,
TotalTax: 0
}
],
ManzanaCheques:
[
{
cardid: String,
soft_request: String,
soft_response: String,
soft_error_xml: String,
fiscal_request: String,
fiscal_response: String,
fiscal_error_xml: String,
back_request: String,
back_response: String,
back_error_xml: String,
back_time: 0001-01-01,
back_points: 0,
upload_status: 0
}
],
Prescriptions:
[
{
UNID: 0,
DS: String,
Is_Generic: 0,
Product_ID: 0,
Prescr_ID: String,
RecipeNo: String,
Oper_Date: 0001-01-01,
Duration: 0001-01-01,
Prod_Descr: String,
ProductGeneric: String,
Dosage_Priv: False,
Prod_Count: 0,
Prod_Left: 0,
Status: String,
PharmaTherapyGroup: String,
IssuanceMode: String,
IdNumber: String,
Birthday: 0001-01-01
}
],
PrescriptionProds:
[
{
good_id: 00000000000000000000000000000000,
receipt_id: 00000000000000000000000000000000,
UNID: 0,
ProdPharmCnt: 0,
ProdCnt: 0,
NewDS: String,
ReciverID: String,
Sale_UNID: 0,
SaleStatus: 0
}
],
ReceiptData:
[
{
id: 0,
receipt_id: 00000000000000000000000000000000,
card_id: String,
data_type: WsGetFinancialAdvice,
data: String,
rec_status: 0
}
]
}
],
POSData:
{
CurrentBatchId: 00000000000000000000000000000000,
CurrentBatchDate: 0001-01-01,
LastBatchDate: 0001-01-01,
IsBatchOpen: False,
CurrentBatchNumber: 0,
LastReceiptNumbers:
{
Sale: 0,
Return: 0,
SaleStorn: 0,
ReturnStorn: 0,
CashIn: 0,
CashOut: 0,
XReport: 0,
ZReport: 0,
BatchOpen: 0,
Print: 0,
Gift: 0,
ReturnGift: 0,
GiftStorn: 0,
ReturnGiftStorn: 0,
Movement: 0,
CashBackOut: 0
},
ReceiptTotals:
{
InCash: 0,
InNonCash: 0,
OutCash: 0,
OutNonCash: 0,
Current: 0,
SaleCash: 0,
SaleStornCash: 0,
ReturnCash: 0,
ReturnStornCash: 0,
Gift: 0,
GiftStorn: 0,
ReturnGift: 0,
ReturnGiftStorn: 0,
ReturnCashBack: 0,
ReturnStornCashBack: 0
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Result: False
}