A Batch Handling of salesinvoices enables possibility to bring several invoices in one batch and retrieve the status details of the imported batch.

IntegrationHTTP-methodResourceDTDSchemaExample
Get Batch -listGETgetbatchlist.nv  Download
Get Batch -statusGETgetbatchstatus.nv   
Import Sales invoice BatchPOSTsalesinvoicebatch.nvDownload  
Import Purchase Invoice BatchPOSTpurchaseinvoicebatch.nv   

 

Get Batch -list

Resource: getbatchlist.nv

Get status of all batches

Querystring parameters:

Parameter nameOccursDescription
status0...1Includes only invoices with given status: pending, processing or finished
batchtype0...1Returns salesinvoice or purchaseinvoice batches. If value is not given, will return salesinvoice batch. Accepted values: salesinvoicepurchaseinvoice

Response:

LevelElement nameTypeOccursDescriptionExample
RootrootAggr.1  
1BatchesAggr.1  
2BatchAggr.1...n  
3IDNumeric1  
3StatusText1A 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
3StatuscodeText1Statuscode 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
3ImportTimestampDate1  

 

Get batch -status

Resource: getbatchstatus.nv

Get one batch status and the status of invoices in the batch.

Querystring parameters:

Parameter nameOccursDescription
id1Batch identifier in Netvisor
addsalesinvoicelinkinformation0...1Adds the link information of the sales invoices created to Netvisor based on the imported Batch
Element SalesInvoiceLinkInformation is added to the response message
batchtype0...1Returns salesinvoice or purchaseinvoice batches. If value is not given, will return salesinvoice batch. Accepted values: salesinvoicepurchaseinvoice
addpurchaseinvoicelinkinformation0...1Adds the link information of the purchase invoices created to Netvisor based on the imported Batch
Element addpurchaseinvoicelinkinformation is added to the response message

Response:

LevelElement nameTypeOccursDescriptionExample
RootrootAggr.1  
1BatchAggr.1  
2SummaryAggr.1  
3StatusText1 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
3StatusCodeNumeric1Statuscode 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
3ProcessingEndTimeDate1  
3BatchSizeNumeric1  
3ItemsPendingCountNumeric1  
3ItemsSuccessCountNumeric1  
3ItemsErrorCountNumeric1  
2SalesInvoiceLinkInformationAggr.0...1 If parameter addpurchaseinvoicelinkinformation is used, element name will be PurchaseInvoiceLinkInformation 
3LinkAggr.1...n  
4ItemIdentifierText1Given identification information for the sales invoice when the batch is imported 
4NetvisorKeyNumeric1  
2ItemErrorDescriptionsAggr.0...1  
3ItemError Aggr.1...n  
4IdentifierNumericGiven identification information for the sales invoice when the batch is imported 
ErrorsAggr.1  
ErrorText1...n  
Attr.TypeText 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.ValueText Description of the error 

 

Import sales invoice batch

Resource: salesinvoicebatch.nv

LevelElementTypeOccursDescriptionExample
RootrootAggr.1  
1salesinvoicebatchAggr.1  
2sharedattachmentsAggr.0...1  
3attachmentAggr.1...n  
4mimetypeText max. 501MIME-type of the attachmentapplication/pdf
4dataText
1Base64 encoded data of the attachment 
Attr.typeText1
finvoice or pdffinvoice
4filenameText. max.2551Attachment file nameattachment.pdf
4descriptionText, max.1001Attachment descriptionDescription
4printbydefaultNumeric0...1NOTE! Not given if the attachment type is finvoice
(otherwise the request is rejected)
1 = true, 0 = false
1
4itemlink Aggr.1  
5itemidentifierText, max. 501
  
2itemsAggr.1  
3itemAggr.1...n  
4identifierText, max. 501Identifier of one invoice in invoice batch. Defined by you. 
4itemdataXML1Valid SalesInvoice XMLSee the resource description: Import Sales Invoice

 

Import purchase invoice batch

Resource: purchaseinvoicebatch.nv

LevelElementTypeOccursDescriptionExample
RootrootAggr.1  
1purchaseinvoicebatchAggr.1  
2sharedattachmentsAggr.0...1  
3attachmentAggr.1...n  
4mimetypeText, max 501MIME-type of the attachmentapplication/pdf
4dataText1Base64 encoded data of the attachment 
Attr.documenttypeText1otherattachmentotherattachment
4filenametext, max 2551  
4descriptionText, max 1001  
4itemlinkAggr.1  
5itemidentifierText, max 501...n
  
2itemsAggr.1  
3itemAggr.1...n  
4identifierText, max 501Identifier of one invoice in invoice batch. Defined by you. 
4itemdataXML1Valid Purchase Invoice XMLSee the resource description: Import purchase invoice

 


xml
(638 Bytes)

Oliko tästä vastauksesta apua? Kyllä Ei

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.