Resource: getbatchstatus.nv
HTTP-method: GET
Retrieve the status of a single batch and the status of invoices within the batch.
Parameters used in the call:
| Parameter | Occurs | Description |
| id | 1 | Batch identifier in Netvisor |
| addsalesinvoicelinkinformation | 0...1 | Adds the link information of the sales invoices created from the imported batch. Adds the SalesInvoiceLinkInformation element to the response message |
| batchtype | 0...1 | Accepted values: salesinvoice, purchaseinvoice Returns either sales invoice batches or purchase invoice batches. If not given, returns sales invoice batches |
| addpurchaseinvoicelinkinformation | 0...1 | Adds the link information of the purchase invoices created from the imported batch. Adds the PurchaseInvoiceLinkInformation element to the response message |
Response:
| Level | Element | Type | Occurs | Description | Example |
| Root | root | Aggregate | 1 | ||
| 1 | Batch | Aggregate | 1 | ||
| 2 | Summary | Aggregate | 1 | ||
| 3 | Status | String | 1 | Description of the batch status. Does not indicate whether sales invoices have been sent from Netvisor, only the processing status of the batch in Netvisor. Values: pending, processing, finished |
pending |
| 3 | StatusCode | Integer | 1 | Status code for the batch status, linked to the Status information. Does not indicate whether sales invoices have been sent from Netvisor, only the processing status of the batch in Netvisor. 1 = pending, 2 = processing, 3 = finished |
1 |
| 3 | ProcessingEndTime | Date | 1 | ||
| 3 | BatchSize | Integer | 1 | ||
| 3 | ItemsPendingCount | Integer | 1 | ||
| 3 | ItemsSuccessCount | Integer | 1 | ||
| 3 | ItemsErrorCount | Integer | 1 | ||
| 2 | SalesInvoiceLinkInformation | Aggregate | 0...1 | If parameter addpurchaseinvoicelinkinformation is used, element name will be PurchaseInvoiceLinkInformation | |
| 3 | Link | Aggregate | 1...n | ||
| 4 | ItemIdentifier | String | 1 | Given identification information for the sales invoice when the batch is imported | |
| 4 | NetvisorKey | Integer | 1 | ||
| 2 | ItemErrorDescriptions | Aggregate | 0...1 | ||
| 3 | ItemError | Aggregate | 1...n | ||
| 4 | Identifier | String | 1 | Given identification information for the sales invoice when the batch is imported | |
| 4 | Errors | Aggregate | 1 | ||
| 5 | Error | String | 1...n | ||
| Attr. | Type | String | 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 | String | Description of the error |
This article has been translated using an AI-based translation tool. The contents or wording of these instructions may differ from those in other instructions or in the software.
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.