Skip to main content

Get sales invoice or order list salesinvoicelist.nv

Resource: salesinvoicelist.nv

HTTP-method: GET

This resource can be used to retrieve a list of sales invoices and orders by changing the value of the ListType parameter.

Querystring parameters:

Parameter name

Occurs

Description

Example

listtype

0...1

Empty value if fetching sales invoice list
preinvoice if fetching order list

invoicesabovenetvisorkey

0...1

Includes only invoice after given id

165

begininvoicedate

0...1

Includes only invoice after given date

2021-01-01

endinvoicedate

0...1

Includes only invoices before given date

2021-12-31

invoicenumber

0...1

Includes only invoice with given invoice number

invoicestatus

0...1

Includes only invoice with specified status, see below what is included

open

lastmodifiedstart

0...1

Finds invoices that are modified after given date

2021-10-23

lastmodifiedend

0...1

Finds invoices that are modified before given date

2021-10-24

salesinvoicebatchid

0...1

Includes only invoices with given Batch ID. See the description of the Sales Invoice Batch Handling

customercode

0...1

Limist the list with customer code

1234567

customernetvisorkey

0...1

Limits the list with customer Netvisor ID

11

secondname

0...1

Includes only invoices with company's second name

Second Name Ltd

secondnamenetvisorkey

0...1

Includes only invoices with company's second name Netvisor ID

2

invoicingcustomercountrycode

0...1

Includes only invoices with specific invoicing customer country code

DE

replyoption

0...1

Value 1 returns the internal comment of the invoice. Value 2 returns currency amount and open currency amount of the sales invoice/order. Value 3 returns all previously mentioned. Value 16 returns Service baskets ID and name.

1

includemodifiedpayments

0...1

When using this parameter, the parameters lastmodifiedstart and lastmodifiedend must also be used. With value 1, the request returns sales invoices with modified (modified or new) sales payments in the period.

1

InvoiceStatus parameter can have the following values:

InvoiceStatus

Returns invoices with status

open

OPEN, OVERDUE, REMINDED, REQUESTED, COLLECTED

overdue

OVERDUE, REMINDED, REQUESTED, COLLECTED

paid

PAID

unsent

UNSENT

creditloss

CREDITLOSS

rejected

REJECTED

Response:

Level

Element name

Type and length

Occurs

Description

Example

root

Root

Aggr.

1

SalesInvoiceList

Aggr.

1

2

SalesInvoice

Aggr.

0...n

3

NetvisorKey

Numeric

1

Invoice identifier in Netvisor

123

3

InvoiceNumber

String

1

Invoice number

1234

3

Invoicedate

Date

1

Invoice date

2020-11-09

Attr.

format

String

1

Always ansi

ansi

3

InvoiceStatus

String

1

Status of the invoice or order. Returns sales invoice payment status.

See table below.

Attr.

substatus

String

0...1

Invoice sub status. Will return status of receivables on the invoice: open, overdue, reminded, requested or collected. This attribute is not used for orders.

open

Attr.

isincollection

Numeric

1

Is invoice in collection or not (Intrum/Duetto)

0 or 1

3

CustomerNetvisorKey

Numeric

1

Customer's Netvisorkey

1

3

CustomerCode

String

1

Billed customer's code

3

CustomerName

String

1

Customer's name

3

ReferenceNumber

String

1

Invoice reference number

3

InvoiceSum

Numeric

1

Invoice sum, two decimals

12,34

3

OpenSum

Numeric

1

Open sum, two decimals

12,34

3

Uri

String

1

Uri that can be used to get details of invoice or order

See below

3

AdditionalInformation

Aggr.

0...1

Added to the response if in the request have included replyoption parameter.


4

PrivateComment

String

1

Invoice's internal additional information

private comment

4

InvoiceCurrencySum

Numeric

0...1

Currency sum of invoice/order

1240

Attr.

currencycode

String

1

Currency code

USD

Attr.

type

String

1

Type, always ISO-4217

ISO-4217

4

OpenCurrencySum

Numeric

0...1

Open currency sum of invoice/order

0

Attr.

currencycode

String

1

Currency code

USD

Attr.

currencycode

String

1

Type, always ISO-4217

ISO-4217

4

ServiceCollection

String

1

Service basket name

Talvikausi

Attr.

Netvisorkey

Numeric

1

Service basket ID

2

Return value differences for orders and invoices:

InvoiceStatus

URI

Invoice

open, creditloss, paid, unsent, rejected

/getsalesinvoice.nv?netvisorkey=123

Order

archived, undelivered, delivered, billed

/getorder.nv?netvisorkey=123



Change Log

Päivämäärä

Muutos

Kuvaus

12.12.2024

New element CustomerNetvisorKey

Response message now returns the customer's Netvisor key

Did this answer your question?