ShDocDashingReport

Purpose	Creating an Expenditure Invoice
Request type	Asynchronous
Supported agent version, sh	v1 — SH4, SH5 v2 — SH5

In SH4, the type of accounting in which a document is created is obtained from the rights of the user through whom authorization occurs — it is specified in the configurator on the Store House tab.Если у пользователя есть права и на учет и спец. учет, то будет выведена ошибка 210.

In SH5:

The document code consists of only one part, which is filled in the textcode field.
It is not possible to add a note to the invoice being created.
If a VAT percentage rate is specified, it should already be entered into Store House as standard.
You can specify both the VAT amount and the percentage rate at the same time.
The document activity is determined by the attribute activated by the recipient. It is transmitted via the API.

Request format

{
   "taskType":"ShDocDashingReport",
   "params":{
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
      "doc":{
         "items":[
            {
               "rid": number,
               "quantity": number,
               "mu": number,
               "sum": number,
               "vatSum": number,
               "vatrate": number
            }
         ],
         "date":"YYYY-MM-DD",
         "corr": number,
         "store": number,
         "active": number,
         "dueDate": number,
         "note":"string",
         "textCode":"string",
         "numCode":"string"
      }
   }
}

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
doc		yes
date	string	yes	The date for which the invoice will be created
corr	int	yes	rid of the correspondent
store	int	yes	rid of the warehouse/division
active	int		Activate the invoice: 0 — no, 1 — yes
dueDate	int		Place the invoice first by date: 0 — no, 1 — yes
note	string		Comment Not used in SH5
textCode	string		Text part of the document code In SH5, you need to specify the full document code in the field
numCode	string		Digital part of the document number In SH5 the field is not used
items	array
rid	int		item rid
quantity	decimal		Quantity, fractional values supported
mu	int		unit rid
sum	int		Amount without VAT * 100
vatSum	int		VAT amount * 100 If the field is not filled in, the amount will be calculated based on the VAT percentage
vatRate	int		VAT rate * 100 SH5 should already have this rate set as standard.

Response format

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"ShDocDashingReport",
      "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":{
      "doc":{
         "rid": number,
         "textCode": "string",
         "numCode": "string"
      }
   },
   "responseCommon":{
      "taskGuid": "string",
      "taskType": "ShDocDashingReport",
      "objectId": number
   }
}

// Answer with error
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ShDocDashingReport",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

Parameter	Parameter type	Mandatory	Description
doc		yes
rid	int		rid of the created document
textCode	string		Text part of the created document number In SH5 this field contains the entire document number.
numCode	string		The digital part of the created document number In SH5 it is not filled
error	string enum		Error container