ShGetReceivingReports

Purpose	Getting a list of Receiving Reports for a period
Request type	Asynchronous/synchronous
Supported agent version, SH	v2 — SH5
PluggetSystemType	StoreHouse

Request format

JSON

{
   "taskType":"ShGetReceivingReports",
   "params":{
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
      "startDate": "YYYY-MM-DD",
      "endDate": "YYYY-MM-DD"
   }
}

Parameter	Type	Mandatory	Description
taskType	string	yes	Task type
async			Asynchronous method call: either synchronous or asynchronous
sync			Synchronous method call: either synchronous or asynchronous
timeout	int	no	Agent response time in seconds. Default is 120 seconds
objectId	int	yes	Restaurant code in the licensing system
startDate	date	yes	First day of the requested period
endDate	date	yes	Last day of the requested period

Response format

{
   "responseCommon":{
      "taskGuid": "guid",
      "taskType": "ShGetReceivingReports",
      "objectId": number
   },
   "error":{
      "wsError":{
         "code": "string",
         "desc": "string"
      }
   }
}

Parameter	Type	Description
taskGuid	guid	The unique code of this task is used when receiving the task through the queue.
taskType	string enum	Task type
objectId	int	Restaurant code in the licensing system
error		Error container

Asynchronous response format

// Successful response
{
    "taskResponse": {
        "reports": [
            {
                "rid": "rid",
                "date": "YYYY-MM-DD",
                "corr": "rid",
                "store": "rid",
                "active": "0,1",
                "items": [
                    {
                        "rid": "rid",
                        "quantity": "number",
                        "mu": "rid",
                        "sum": "number",
                        "vatSum": "number",
                        "vatrate": "number"
                    }
                ]
            }
        ]
    },
    "responseCommon": {
        "taskGuid": "string",
        "taskType": "ShGetReceivingReports",
        "objectId": "number"
    }
}


// Error response from server
{
    "responseCommon": {
        "taskGuid": "string",
        "taskType": "ShGetReceivingReports",
        "objectId": "number"
    },
    "error": {
        "wsError": {
            "code": "string",
            "desc": "string"
        }
    }
}

// Error response from agent
{
    "responseCommon": {
        "taskGuid": "string",
        "taskType": "ShGetReceivingReports",
        "objectId": "number"
    },
    "error": {
        "agentError": {
            "code": "string",
            "desc": "string"
        }
    }
}

Parameter	Type	Mandatory	Description
reports		yes	Receiving Reports
rid	int	yes	rid of the report
date	string	yes	Date of the report
corr	int	yes	rid of supplier
store	int	yes	rid of warehouse
active	int		If the report is active: 0 — no, 1 — yes
items	array
rid	int		rid of the item
quantity	decimal		Quantity, fractional values supported
mu	int		rid of the unit
sum	int		Amount without VAT * 100
vatSum	int	no	VAT amount * 100
vatRate	int	no	VAT rate * 100 SH5 should already have this rate set as standard