Batch Handling of salesinvoices enables the possibility to bring several invoices in one batch and retrieve the status details of the imported batch.
| Integration | HTTP-method | Resource | DTD | Schema | Example |
| Get Batch -list | GET | getbatchlist.nv | Download | ||
| Get Batch -status | GET | getbatchstatus.nv | |||
| Import Sales invoice Batch | POST | salesinvoicebatch.nv | Download | ||
| Import Purchase Invoice Batch | POST | purchaseinvoicebatch.nv |
Get Batch -list
Resource: getbatchlist.nv
Get status of all batches
Querystring parameters:
| Parameter name | Occurs | Description |
| status | 0...1 | Includes only invoices with given status: pending, processing or finished |
| batchtype | 0...1 | Returns salesinvoice or purchaseinvoice batches. If value is not given, will return salesinvoice batch. Accepted values: salesinvoice, purchaseinvoice |
Response:
| Level | Element name | Type | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | Batches | Aggr. | 1 | ||
| 2 | Batch | Aggr. | 1...n | ||
| 3 | ID | Numeric | 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 | Text | 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 | ImportTimestamp | Date | 1 |
Get batch -status
Resource: getbatchstatus.nv
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 |
Import sales invoice batch
Resource: salesinvoicebatch.nv
| Level | Element | Type | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | salesinvoicebatch | Aggr. | 1 | ||
| 2 | sharedattachments | Aggr. | 0...1 | ||
| 3 | attachment | Aggr. | 1...n | ||
| 4 | mimetype | Text max. 50 | 1 | MIME-type of the attachment | application/pdf |
| 4 | data | Text | 1 | Base64 encoded data of the attachment | |
| Attr. | type | Text | 1 | finvoice or pdf | finvoice |
| 4 | filename | Text. max.255 | 1 | Attachment file name | attachment.pdf |
| 4 | description | Text, max.100 | 1 | Attachment description | Description |
| 4 | printbydefault | Numeric | 0...1 | NOTE! Not given if the attachment type is finvoice (otherwise the request is rejected) 1 = true, 0 = false | 1 |
| 4 | itemlink | Aggr. | 1 | ||
| 5 | itemidentifier | Text, max. 50 | 1 | ||
| 2 | items | Aggr. | 1 | ||
| 3 | item | Aggr. | 1...n | ||
| 4 | identifier | Text, max. 50 | 1 | Identifier of one invoice in invoice batch. Defined by you. | |
| 4 | itemdata | XML | 1 | Valid SalesInvoice XML | See the resource description: Import Sales Invoice |
Import purchase invoice batch
Resource:purchaseinvoicebatch.nv
| Level | Element | Type | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | purchaseinvoicebatch | Aggr. | 1 | ||
| 2 | sharedattachments | Aggr. | 0...1 | ||
| 3 | attachment | Aggr. | 1...n | ||
| 4 | mimetype | Text, max 50 | 1 | MIME-type of the attachment | application/pdf |
| 4 | data | Text | 1 | Base64 encoded data of the attachment | |
| Attr. | documenttype | Text | 1 | otherattachment | otherattachment |
| 4 | filename | text, max 255 | 1 | ||
| 4 | description | Text, max 100 | 1 | ||
| 4 | itemlink | Aggr. | 1 | ||
| 5 | itemidentifier | Text, max 50 | 1...n | ||
| 2 | items | Aggr. | 1 | ||
| 3 | item | Aggr. | 1...n | ||
| 4 | identifier | Text, max 50 | 1 | Identifier of one invoice in invoice batch. Defined by you. | |
| 4 | itemdata | XML | 1 | Valid Purchase Invoice XML | See the resource description: Import purchase invoice |
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.