Sales payments' handling functions are divided into the following resources:

IntegrationHTTP-methodResourceDTDSchemaExample
Get sales payment listGETsalespaymentlist.nv  Download
Import sales paymentPOSTsalespayment.nvsalespayment.dtd Download
Get purchase payment listGETpaymentlist.nv  Download
Get unprocessed outgoing paymentsGETunprocessedoutgoingpayments.nv  Download
Import bank transferPOSTpayment.nv payment.dtd Download

 

Get sales payment list

Recourse: salespaymentlist.nv

Querystring parameters:

Parameter nameOccursDescriptionExample
abovenetvisorkey0...1Return only sales payment above given id123
begindate0...1 Return only sales payments with date after defined value2015-10-23
enddate0...1 Return only sales payments with date before defined value2015-10-24
searchbyname0...1 Return only sales payments with given name 
limitlinkedpayments0...1 Limits based on linked invoices
0 - payment doesn't have invoice linked to it
1 - payment has invoice linked to it
1
limitbytype0...1Limits based on payment type
onlycreditloss - lists only credit loss
excludecreditloss - lists all but credit loss
excludecreditloss

 

Response:

LevelElement nameType and lengthOccursDescriptionExample
RootRootAggr.1  
1SalesPaymentListAggr.1  
2SalesPaymentAggr.0...n  
3NetvisorKeyNumeric1Sales payment identifier in Netvisor123
3NameText1Name of the payment 
3DateDate1Date of the payment 
3SumNumeric1Sum of the payment 
3ReferenceNumberText1Reference number of the payment 
3ForeignCurrencyAmountNumeric1  
3InvoiceNumberText1Invoice number 
3PaymentAccountNameText1Name of the bank/payment methodcash
3PaymentAccountNumberText1Account number if payment from bankFI12 3456 xxx
3BankStatusText1OK or FAILEDOK
3BankStatusErrorDescriptionText0...1Description of error 
Attr.codeText0...1Error code, see below  

 

Bank status error codes:

NO_ACCOUNT_FOUNDAccount was not found
NO_PAYMENT_SERVICE_ACCOUNTAccount is not for payments
ERROR_IN_DUE_DATEDuedate is incorrect
BALANCE_IS_EXCEEDEDBalance is not sufficient
PAYER_HAS_CANCELEDPayer cancelled payment
FORM_NOT_CORRECTFormal error
BANK_HAS_CANCELLEDBank cancelled operation
CANCELLATION_NOT_CLEARING 
AUTHORIZATION_IS_MISSINGAuthorization is missing

 

Import sales payment

Recourse: salespayment.nv

Importing a sales payment into Netvisor.

Sales invoice must exist before payment can be connected to it. If payment has been imported before invoice, payment will not be targeted to invoice automatically.

If the sales invoice, that the payment is targeted to, allows partial payments the payment is always added. If not, the payment must fit within the cash discount tolerance of the invoice.

If salespayment is imported to an unsent salesinvoice, the salesinvoice must accept partial payments in order for salespayment to connect to the right invoice. If sales invoice is imported using Web Service interface, the sales invoice message should have element "expectPartialPayments" and if the sales invoice is created in Netvisor, the setting can be done in Basic data of sales.

Request:

LevelElement nameType and lengthOccursDescriptionExample
RootrootAggr.1  
1salespaymentAggr.1  
2sumNumeric1Sale payment sum 10,00
Attr.currencyText1Currency code. If not found in the system, will return INVALID_DATA and defenition. Default EUREUR
2paymentdateDate1Date of the payment2018-10-12
2targetidentifierText1Identifier that is used to connect payment to invoice1070
Attr.typeText1Type of targetidentifier:
netvisor
when the identifier is invoice id in Netvisor
invoicenumber when identifier is number of invoice
reference when identifier is reference number of invoice
netvisor
Attr.targettypeText0...1Target of payment, invoice or orderorder
2sourcenameText1Name of the payment sourcePekka Pajanen
2paymentmethodText 1Payment method, must have the same name as on Netvisorpankkikortti
Attr.typeText 1Indicates paymentmethod type alternativealternative
Attr.overrideaccountingaccountnumberNumeric0...1Account number to override in voucher. If not found, system will return INVALID_DATA1900
Attr.overridesalesreceivableaccountnumberNumeric0...1Voucher payment account number override2100
2salespaymentvoucherlinesAggr.0...n  
3voucherlineAggr.1...n  
4linesumNumeric1Line sum10,00
Attr.
typeText1Line sum type: net (VAT is not included) or gross (VAT is included)gross
4descriptionText0...1Line descriptionSales event
4accountnumberNumeric 1Accounting account number for line1500
4vatpercentNumeric 1VAT percent24
Attr.vatcodeText 1VAT code *1KOMY
4dimensionAggr.0...n  
5dimensionnameText1Name of the dimensionKäteiskauppa
5dimensionitemText1Name of the dimension item.Myynti

*1) NONE, KOOS, EUOS, EUUO, EUPO, 100, KOMY, EUMY, EUUM, EUPM312, EUPM309, MUUL, EVTO, EVPO 

VAT-classVAT-codeVAT-percent
No VAT processingNONE0
Domestic salesKOMY0, 10, 14, 24
EU salesEUMY0
Sales outside the EUEUUM0
Domestic purchaseKOOS0, 10, 14, 24
EU purchaseEUOS0, 10, 14, 24
EU service purchase EUPO0, 10, 14, 24
Non - EU purchasesEUUO0, 10, 14, 24
100% deductible tax1000
312 EU service salesEUPM3120
309 EU service salesEUPM3090
Other turnover excluding VAT (310)MUUL0, 10, 14, 24
Purchases of goods from other EU countries, non-deductibleEVTO0, 10, 14, 24
Purchases of services from other EU countries, non-deductibleEVPO0, 10, 14, 24
Sale of construction servicesRAMY0
Purchase of construction serviceRAOS0, 10, 14, 24
Non-deductible purchase of construction serviceEVRO0, 10, 14, 24

 

Get purchase payment list

Resource: paymentlist.nv

Get payment list for purchase invoices. Also shows if purchase invoice is paid or unpaid.

Querystring parameters:

Parameter nameOccursDescriptionExample
limitabovenetvisorkey0...1Returns only payments above given id 
limitbegindate0...1Returns only payments with date after defined value2015-10-23
limitenddate0...1Returns only payments with date before defined value2015-10-24
limitreference0...1Limits payment based on reference 
limitinvoiceid0...1Returns only payments for given purchaseinvoice1

 

Response:

LevelElement nameType and lengthOccursDescriptionExample
rootRootAggr.1  
1PaymentListAggr.1  
2PaymentAggr.0...n  
3NetvisorKeyNumeric1Netvisor id for payment1
3PayerNameText1Payment name 
3DateDate1Payment date 
3HomeCurrencySumNumeric1Payment sum 
3ForeignCurrencySumNumeric1  
3ReferenceText1Payment reference 
3InvoiceKeyNumeric1Purchase invoice Netvisor id 
3InvoiceNumberNumeric1Purchase invoice number 
3InvoiceURIText1  
3VoucherKeyNumeric1Voucher Netvisor id 
3VoucherNumberNumeric1Voucher number 

 

Get unprocessed outgoing payments

Resource: unprocessedoutgoingpayments.nv

Get status of payments sent via API. If payment is being processed and bank has not sent status, resource will return nothing.

Parameter nameOccursDescriptionExample
idlist1Get status of sent payments. idlist = InsertedDataIdentifier from payment.nv 

Response:

LevelElement nameType and lengthOccursDescriptionExample
rootRootAggr.1  
1PaymentsAggr.1  
2PaymentAggr.0...n  
3identifierNumeric1Payment Netvisor id 
3statusText1Payment status
2 = OK
3 = error
 
3StatusDescriptionText1More specific error message 

 

Import bank transfer

Resource: payment.nv

Bank transfer can be imported via API but this bank transfer must be accepted manually in Netvisor. Bank account number must be Finnish IBAN account number, API will check if the bank account number is valid before bank transfer message is imported to Netvisor.

If payment has a past due date, Netvisor will change the due date to the current date when the payment it is paid in Netvisor. The payment cannot be edited in Netvisor after import.

Request:

LevelElement nameType and lengthOccursDescriptionExample
rootRootAggr.1  
1PaymentAggr.1  
2bankpaymentmessagetypeText1Message type:
FinnishReference = Reference
FreeText = Message
FinnishReference
2bankpaymentmessageText1Payment message:
reference or message
1071
2recipientAggr.1  
3organizationcodeText0...1Receivers business ID1234567-8
3nameText1Receivers nameVille Valta
3addressText0...1Receivers addressValtakatu 51
3postcodeText0...1Receivers postal code53100
3townText0...1Receivers townLappeenranta
2sourcebankaccountnumberNumeric1Payers bank account numberFI000998874123
2destinationbankaccountAggr.1
 
3banknameText1Receivers banks nameHandelsbanken
3bankbranchText1Receivers BICHANDFIHH
3destinationbankaccountnumberText1Receivers bank account numberFI000111234567
2duedateDate1Due date
Please note the information about due date at the beginning of the documentation
25.5.2016
2amountNumeric1Sum10,00

xml
(833 Bytes)
xml
(235 Bytes)
xml
xml
xml

Oliko tästä vastauksesta apua? Kyllä Ei

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