Get Sales Export
Deprecated
POST
/api
Last modified:2024-08-21 09:23:46
POST call, passing a JSON body as specified below.| Field | Description | Type | Mandatory |
|---|---|---|---|
| languageId | Language for the article localized strings ( IT or EN, defaults to user languare or IT if omitted) | String | |
| completeExtraction | If set to T, extracts ALL the sales (even the ones before the last request) | Char(1) |
completeExtraction is not T the web service will retrieve all the modified sales since the last request (in this case, the parameter system must be set in the body request, representing the system the recalls will be retrieved from).| Field | Description | Type | Mandatory |
|---|---|---|---|
| start | Pagination offset parameter. (only if completeExtraction is T)The WS will retrieve the elements starting from the one with the index specified here. For example, if 'start' is set to 23, the sales from the 23rd to the 43rd will be returned. | Number |
| Field | Description | Type |
|---|---|---|
| entityCode | Code of the shop | Varchar(250) |
| entityCodeDescription | Description for the entityCode | Varchar(250) |
| documentDate | Sale date | Datetime |
| refDocument | Reference code for the sale | Varchar(250) |
| causal | Sale causal | Varchar(250) |
| causalDescription | Description for the causal | Varchar(250) |
| currency | Currency used in the sale values | Varchar(250) |
| currencyDescription | Description for the currency | Varchar(250) |
| totalAmount | Total amount | Decimal(15, 2) |
| taxFreeNumber | TaxFree number | Int(11) |
| cardBarcode | Card barcode | Varchar(50) |
| totalQuantity | Total quantity | Decimal(7, 2) |
| Field | Description | Type |
|---|---|---|
| rowNumber | The number row | Int(11) |
| itemCode | Code of the product | Varchar(50) |
| itemCodeDescription | Description of the productBar | Varchar(250) |
| barcode | Barcode for the SKU | Varchar(50) |
| quantity | Article quantity | Decimal(10, 2) |
| listPrice | It is the sale price in the main list | Decimal(7, 2) |
| salePrice | It is the sale price of the article | Decimal(15, 2) |
| discountValue | It is the discount value | Decimal(15, 2) |
| taxRate | Tax rate of the row | Decimal(6, 2) |
| Field | Description | Type |
|---|---|---|
| paymentType | Code of payment | Varchar(250) |
| paymentDescription | Description of payment | Varchar(250) |
| paymentValue | Barcode for the external package | Decimal(15,2) |
{
"success": true,
"valueObjectList": [{
"saleHeader": {
"entityCode": "1",
"entityDescription": "Negozio 1",
"documentDate": "2019-05-15",
"refDocument": "1-3",
"causal": "V",
"causalDescription": "Vendita",
"currency": "EUR",
"currencyDescription": "Euro",
"totalAmount": 465,
"taxFreeNumber": 10004,
"cardBarcode": "8999999999999",
"totalQuantity": 1
},
"saleDetails": [
{
"rowNumber": 222287,
"itemCode": "A68173E0033",
"itemDescription": "PORTAFOGLIO LIU",
"barcode": "1000014940599",
"quantity": 1,
"listPrice": 65,
"salePrice": 65,
"discountValue": 0,
"taxRate": 22
}
],
"salePayments": [
{
"paymentType": "24",
"paymentDescription": "Bancomat",
"paymentValue": 65
}
]
}]
}
Request
Query Params
Header Params
Body Params application/json
Request Code Samples
Responses
Modified at 2024-08-21 09:23:46