Sales payments' handling functions are divided into the following resources:
| Integration | HTTP-method | Resource | DTD | Schema | Example |
| Get sales payment list | GET | salespaymentlist.nv | Download | ||
| Import sales payment | POST | salespayment.nv | salespayment.dtd | Download | |
| Get purchase payment list | GET | paymentlist.nv | Download | ||
| Get unprocessed outgoing payments | GET | unprocessedoutgoingpayments.nv | Download | ||
| Import bank transfer | POST | payment.nv | payment.dtd | Download |
Recourse: salespaymentlist.nv
Querystring parameters:
| Parameter name | Occurs | Description | Example |
| abovenetvisorkey | 0...1 | Return only sales payment above given id | 123 |
| begindate | 0...1 | Return only sales payments with date after defined value | 2015-10-23 |
| enddate | 0...1 | Return only sales payments with date before defined value | 2015-10-24 |
| searchbyname | 0...1 | Return only sales payments with given name | |
| limitlinkedpayments | 0...1 | Limits based on linked invoices | 1 |
| limitbytype | 0...1 | Limits based on payment type | excludecreditloss |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | Root | Aggr. | 1 | ||
| 1 | SalesPaymentList | Aggr. | 1 | ||
| 2 | SalesPayment | Aggr. | 0...n | ||
| 3 | NetvisorKey | Numeric | 1 | Sales payment identifier in Netvisor | 123 |
| 3 | Name | Text | 1 | Name of the payment | |
| 3 | Date | Date | 1 | Date of the payment | |
| 3 | Sum | Numeric | 1 | Sum of the payment | |
| 3 | ReferenceNumber | Text | 1 | Reference number of the payment | |
| 3 | ForeignCurrencyAmount | Numeric | 1 | ||
| 3 | InvoiceNumber | Text | 1 | Invoice number | |
| 3 | PaymentAccountName | Text | 1 | Name of the bank/payment method | cash |
| 3 | PaymentAccountNumber | Text | 1 | Account number if payment from bank | FI12 3456 xxx |
| 3 | BankStatus | Text | 1 | OK or FAILED | OK |
| 3 | BankStatusErrorDescription | Text | 0...1 | Description of error | |
| Attr. | code | Text | 0...1 | Error code, see below |
Bank status error codes:
| NO_ACCOUNT_FOUND | Account was not found |
| NO_PAYMENT_SERVICE_ACCOUNT | Account is not for payments |
| ERROR_IN_DUE_DATE | Duedate is incorrect |
| BALANCE_IS_EXCEEDED | Balance is not sufficient |
| PAYER_HAS_CANCELED | Payer cancelled payment |
| FORM_NOT_CORRECT | Formal error |
| BANK_HAS_CANCELLED | Bank cancelled operation |
| CANCELLATION_NOT_CLEARING | |
| AUTHORIZATION_IS_MISSING | Authorization is missing |
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:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | salespayment | Aggr | 1 | ||
| 2 | sum | Numeric | 1 | Sale payment sum | 10,00 |
| Attr. | currency | Text | 1 | Currency code. If not found in the system, will return INVALID_DATA and defenition. Default EUR | EUR |
| 2 | paymentdate | Date | 1 | Date of the payment | 2018-10-12 |
| 2 | targetidentifier | Text | 1 | Identifier that is used to connect payment to invoice | 1070 |
| Attr. | type | Text | 1 | Type 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. | targettype | Text | 0...1 | Target of payment, invoice or order | order |
| 2 | sourcename | Text | 1 | Name of the payment source | Pekka Pajanen |
| 2 | paymentmethod | Text | 1 | Payment method, must have the same as on Netvisor | pankkikortti |
| Attr. | type | Text | 1 | Indicates paymentmethod type alternative | alternative |
| Attr. | overrideaccountingaccountnumber | Numeric | 0...1 | Account number to override in voucher. If not found, system will return INVALID_DATA | 1900 |
| Attr. | overridesalesreceivableaccountnumber | Numeric | 0...1 | Voucher payment account number override | 2100 |
| 2 | salespaymentvoucherlines | Aggr. | 0...n | ||
| 3 | voucherline | Aggr. | 1...n | ||
| 4 | linesum | Numeric | 1 | Line sum | 10,00 |
| type | Text | 1 | Line sum type: net (VAT is not included) or gross (VAT is included) | gross | |
| 4 | description | Text | 0...1 | Line description | Sales event |
| 4 | accountnumber | Numeric | 1 | Accounting account number for line | 1500 |
| 4 | vatpercent | Numeric | 1 | VAT percent | 22 |
| Attr. | vatcode | Text | 1 | VAT code *1 | KOMY |
| 4 | dimension | Aggr. | 0...n | ||
| 5 | dimensionname | Text | 1 | Name of the dimension | Käteiskauppa |
| 5 | dimensionitem | Text | 1 | Name of the dimension item. | Myynti |
*1) NONE, KOOS, EUOS, EUUO, EUPO, 100, KOMY, EUMY, EUUM, EUPM312, EUPM309, MUUL, EVTO, EVPO
| VAT-class | VAT-code | VAT-percent |
| No VAT processing | NONE | 0 |
| Domestic sales | KOMY | 0, 10, 14, 24 |
| EU sales | EUMY | 0 |
| Sales outside the EU | EUUM | 0 |
| Domestic purchase | KOOS | 0, 10, 14, 24 |
| EU purchase | EUOS | 0, 10, 14, 24 |
| EU service purchase | EUPO | 0, 10, 14, 24 |
| Non - EU purchases | EUUO | 0, 10, 14, 24 |
| 100% deductible tax | 100 | 0 |
| 312 EU service sales | EUPM312 | 0 |
| 309 EU service sales | EUPM309 | 0 |
| Other turnover excluding VAT (310) | MUUL | 0, 10, 14, 24 |
| Purchases of goods from other EU countries, non-deductible | EVTO | 0, 10, 14, 24 |
| Purchases of services from other EU countries, non-deductible | EVPO | 0, 10, 14, 24 |
| Sale of construction services | RAMY | 0 |
| Purchase of construction service | RAOS | 0, 10, 14, 24 |
| Non-deductible purchase of construction service | EVRO | 0, 10, 14, 24 |
Resource: paymentlist.nv
Get payment list for purchase invoices. Also shows if purchase invoice is paid or unpaid.
Querystring parameters:
| Parameter name | Occurs | Description | Example |
| limitabovenetvisorkey | 0...1 | Returns only payments above given id | |
| limitbegindate | 0...1 | Returns only payments with date after defined value | 2015-10-23 |
| limitenddate | 0...1 | Returns only payments with date before defined value | 2015-10-24 |
| limitreference | 0...1 | Limits payment based on reference | |
| limitinvoiceid | 0...1 | Returns only payments for given purchaseinvoice | 1 |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| root | Root | Aggr. | 1 | ||
| 1 | PaymentList | Aggr. | 1 | ||
| 2 | Payment | Aggr. | 0...n | ||
| 3 | NetvisorKey | Numeric | 1 | Netvisor id for payment | 1 |
| 3 | PayerName | Text | 1 | Payment name | |
| 3 | Date | Date | 1 | Payment date | |
| 3 | HomeCurrencySum | Numeric | 1 | Payment sum | |
| 3 | ForeignCurrencySum | Numeric | 1 | ||
| 3 | Reference | Text | 1 | Payment reference | |
| 3 | InvoiceKey | Numeric | 1 | Purchase invoice Netvisor id | |
| 3 | InvoiceNumber | Numeric | 1 | Purchase invoice number | |
| 3 | InvoiceURI | Text | 1 | ||
| 3 | VoucherKey | Numeric | 1 | Voucher Netvisor id | |
| 3 | VoucherNumber | Numeric | 1 | Voucher 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 name | Occurs | Description | Example |
| idlist | 1 | Get status of sent payments. idlist = InsertedDataIdentifier from payment.nv |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| root | Root | Aggr. | 1 | ||
| 1 | Payments | Aggr. | 1 | ||
| 2 | Payment | Aggr. | 0...n | ||
| 3 | identifier | Numeric | 1 | Payment Netvisor id | |
| 3 | status | Text | 1 | Payment status | |
| 3 | StatusDescription | Text | 1 | More specific error message |
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:
| Level | Element name | Type and length | Occurs | Description | Example |
| root | Root | Aggr. | 1 | ||
| 1 | Payment | Aggr. | 1 | ||
| 2 | bankpaymentmessagetype | Text | 1 | Message type: FinnishReference = Reference FreeText = Message | FinnishReference |
| 2 | bankpaymentmessage | Text | 1 | Payment message: reference or message | 1071 |
| 2 | recipient | Aggr. | 1 | ||
| 3 | organizationcode | Text | 0...1 | Receivers business ID | 1234567-8 |
| 3 | name | Text | 1 | Receivers name | Ville Valta |
| 3 | address | Text | 0...1 | Receivers address | Valtakatu 51 |
| 3 | postcode | Text | 0...1 | Receivers postal code | 53100 |
| 3 | town | Text | 0...1 | Receivers town | Lappeenranta |
| 2 | sourcebankaccountnumber | Numeric | 1 | Payers bank account number | FI000998874123 |
| 2 | destinationbankaccount | Aggr. | 1 | ||
| 3 | bankname | Text | 1 | Receivers banks name | Handelsbanken |
| 3 | bankbranch | Text | 1 | Receivers BIC | HANDFIHH |
| 3 | destinationbankaccountnumber | Text | 1 | Receivers bank account number | FI000111234567 |
| 2 | duedate | Date | 1 | Due date Please note the information about due date at the beginning of the documentation | 25.5.2016 |
| 2 | amount | Numeric | 1 | Sum | 10,00 |
Did you find it helpful? Yes No
Send feedback