Resource: getbatchstatus.nv
HTTP-method: GET
Get one batch status and the status of invoices in the batch.
Querystring parameters:
| Parameter name | Occurs | Description |
| id | 1 | Batch identifier in Netvisor |
| addsalesinvoicelinkinformation | 0...1 | Adds the link information of the sales invoices created to Netvisor based on the imported Batch Element SalesInvoiceLinkInformation is added to the response message |
| batchtype | 0...1 | Returns salesinvoice or purchaseinvoice batches. If value is not given, will return salesinvoice batch. Accepted values: salesinvoice, purchaseinvoice |
| addpurchaseinvoicelinkinformation | 0...1 | Adds the link information of the purchase invoices created to Netvisor based on the imported Batch Element addpurchaseinvoicelinkinformation is added to the response message |
Response:
| Level | Element name | Type | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | Batch | Aggr. | 1 | ||
| 2 | Summary | Aggr. | 1 | ||
| 3 | Status | Text | 1 | A description of the batch status. Does not tell if e.g. sales invoice has been sent from Netvisor, tells only the status of the batch in Netvisor. Values: pending, processing, finished | pending |
| 3 | StatusCode | Numeric | 1 | Statuscode for the batch status, linked to the Status -information. Does not tell if e.g. sales invoice has been sent from Netvisor, tells only the status of the batch in Netvisor. 1 = pending, 2 = processing, 3 = finished | 1 |
| 3 | ProcessingEndTime | Date | 1 | ||
| 3 | BatchSize | Numeric | 1 | ||
| 3 | ItemsPendingCount | Numeric | 1 | ||
| 3 | ItemsSuccessCount | Numeric | 1 | ||
| 3 | ItemsErrorCount | Numeric | 1 | ||
| 2 | SalesInvoiceLinkInformation | Aggr. | 0...1 | If parameter addpurchaseinvoicelinkinformation is used, element name will be PurchaseInvoiceLinkInformation | |
| 3 | Link | Aggr. | 1...n | ||
| 4 | ItemIdentifier | Text | 1 | Given identification information for the sales invoice when the batch is imported | |
| 4 | NetvisorKey | Numeric | 1 | ||
| 2 | ItemErrorDescriptions | Aggr. | 0...1 | ||
| 3 | ItemError | Aggr. | 1...n | ||
| 4 | Identifier | Numeric | 1 | Given identification information for the sales invoice when the batch is imported | |
| 4 | Errors | Aggr. | 1 | ||
| 5 | Error | Text | 1...n | ||
| Attr. | Type | Text | The returned error type from Netvisor API, for example INVALID_DATA, PERIOD_LOCK, TECHNICAL_ERROR… Can be used to conclude why the error is returned | ||
| Attr. | Value | Text | Description of the error |
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.