Integration | HTTP-method | Resource | DTD | Schema | Example |
Get accounting data | GET | accountingledger.nv | Download | ||
Import accounting data | POST | accounting.nv | Download | Download | |
Edit accounting data | POST | accountingedit.nv | Download | ||
Invalidate accounting data | POST | invalidatevouchers.nv | Download | Download | |
Deleted vouchers | GET | deletedvouchers.nv | |||
Get whole account list | GET | accountlist.nv | Download | ||
Get accounting periods | GET | accountingperiodlist.nv | Download | ||
Get voucher type | GET | vouchertypelist.nv | Download |
Get accounting data
Resource: accountingledger.nv
Parameter name | Occurs | Description | Example |
startdate | 1 | Finds vouchers that are added after given date (inclusive) | 2012-10-23 |
enddate | 1 | Finds vouchers that are added before given date(inclusive) | 2013-10-24 |
accountnumberstart | 0...1 | Finds vouchers which account number is equal or greater than given value | 3000 |
accountnumberend | 0...1 | Finds vouchers which account number is equal or less than given value | 3500 |
changedsince | 0...1 | Finds vouchers that are modified or added after given date | 2013-01-01 |
lastmodifiedstart | 0...1 | Finds vouchers that are modified after given date | 2012-10-23 |
lastmodifiedend | 0...1 | Finds vouchers that are modified before given date | 2013-10-24 |
showgenerator | 0...1 | Returns the creator of the voucher (eg. user or system) | 1 |
voucherstatus | 0...1 | Finds all, only valid or invalidated and deleted vouchers. Status -attribute shows which status voucher is: "valid", "invalidated" or "deleted" | 1 = All 2 = Valid 3 = Invalidated and deleted |
Response:
Level | Element name | Type and length | Occurs | Description | Example |
root | root | Aggr. | 1 | ||
1 | vouchers | Aggr. | 1 | ||
2 | voucher | Aggr. | 0...n | ||
Attr. | status | Text | 0...1 | Status of the Voucher | valid, invalidated or deleted |
3 | netvisorkey | Numeric | 1 | Netvisor key of the Voucher | 15 |
3 | voucherdate | Date | 1 | Date of the Voucher | 31.12.2023 |
3 | vouchernumber | Numeric | 1 | Voucher's reference number | 515144 |
3 | voucherdescription | Text | 1 | Free description text | |
3 | voucherclass | Text | 1 | Class of voucher | Myyntilasku |
3 | linkedsourcenetvisorkey | Numeric | 1 | Netvisor key of the sales- or purchaseinvoice | 123 |
Attr. | type | Text | 1 | "purchaseinvoice" or "salesinvoice" | purchaseinvoice |
3 | vouchernetvisoruri | Text | 1 | URI to the voucher in Netvisor | |
3 | voucherline | Aggr. | 0...n | ||
4 | netvisorkey | Numeric | 1 | Voucher lines Netvisor key | 6 |
4 | linesum | Numeric | 1 | Sum of the voucher line | 150,22 |
4 | description | Text | 1 | Free description text | |
4 | accountnumber | Numeric | 1 | Account number | 1701 |
4 | vatpercent | Numeric | 1 | VAT percent | 24 |
4 | vatcode | Text | 1 | VAT code | |
4 | accountdimension | Text | 0...1 | Seurantakohde 1 | |
Attr. | type | Numeric | 1 | netvisorkey | |
4 | dimension | Aggr. | 0...1 | ||
5 | dimensionname | Text | 1 | Dimension name | |
5 | dimensionitem | Text | 1 | Dimension |
Import accounting data
Resource: accounting.nv
Note! A transaction payment for web invoice will be charged for each voucher attachment imported to Netvisor via interface.
Vouchers, voucher lines, the lines' dimensions and attachments can be imported into accounting materials. The request must be directed to Accounting.nv resource without parameters. One request can only carry one voucher. If voucher's id is not given, the system automatically assigns a new id for it.
Allowed types of vouchers are (Finnish names must be used in voucherclass field when importing data):
- Sales invoice (myyntilasku)
- Sales payment (myyntisuoritus)
- Bank (pankki)
- Treasury (kassa)
- Imported events (tuodut tapahtumat)
- Automatic financial statements (automaattiset tilinpäätöskirjaukset)
- Vouchers formed by the system (Järjestelmän muodostamat)
- Purchase invoice (ostolasku)
- Purchase payment (ostosuoritus)
- Others (muut)
- Accruals (jaksotukset)
- Salaries (Palkka, PA)
Voucher line's sum's type, net or gross, is chosen for each voucher. If the type is net, the system will not automatically calculate VAT lines and rounding difference lines, and the voucher will be exactly as the imported material. When type is gross, VAT and rounding difference lines will be automatically calculated by the system.
The account chosen for the voucher must be found from the system, otherwise an INVALID_DATA error with further information is returned. VAT code is retrieved from the chosen account if it has not been specified. If the user enters a VAT code that conflicts with the VAT rate entered for the line, an error is returned with further information.
There must be always debit and credit sides when importing a voucher. Positive sum is recorded as debit and negative sum as credit. If the debit and credit entries do not match, the difference is automatically recorded in rounding differences.
One voucher line can relate to several dimensions. If the "Dimension Name" or "Dimension Item" values are not found in the system, it will create new ones.
While importing a voucher, several attachments can be included. The attachments need to be base64 encoded and included in the XML message. API doesn't check the size of the attachments, but the maximum size of attachments is 2GB.
Request:
Level | Element name | Type and length | Occurs | Description | Example |
Root | root | Aggr. | 1 | ||
1 | voucher | Aggr. | 1 | ||
2 | calculationmode | Text | 1 | net (vat lines are not calculated automatically) or gross (vat lines are calculated automatically) | net |
2 | voucherdate | Date | 1 | Date of the voucher | 2013-10-20 |
Attr. | format | Text | 1 | Date format, always ansi | ansi |
2 | number | Numeric | 0...1 | Number of voucher. If not given, system automatically picks next number | 42 |
2 | description | Text, max. 255 | 0...1 | Description of the voucher | |
2 | voucherclass | Text | 1 | Myyntilasku, Myyntisuoritus, Pankki, Kassa, Tuodut tapahtumat, Automaattiset tilinpäätöskirjaukset, Järjestelmän muodostamat, Ostolasku, Ostosuoritus or Muut | Myyntilasku |
2 | checked | Text | 0...1 | Defines whether imported voucher rises to unchecked postings view. True or false. False by default. | false |
2 | voucherline | Aggr. | 0...n | ||
3 | linesum | Numeric | 1 | Negative value is recorded to credit side and positive value on debit side. Two decimal maximum. | -100,00 |
Attr. | type | Text | 0...1 | net or gross | net |
3 | description | Text, max. 255 | 0...1 | Description text | |
3 | accountnumber | Numeric | 1 | Accounting account number, must be found or an error is returned | 1701 |
3 | vatpercent | Numeric | 1 | Must not be in conflict with vatcode attribute | 24 |
Attr. | vatcode | Text | 0...1 | If not given, value behind account number is used. Check valid values from the table below. | KOMY |
3 | accountdimension | Text | 0...1 | Voucher's follow-up object. | Seurantakohde 1 |
Attr. | type | Text | 1 | name or netvisorkey (shown only in Netvisor) | name |
3 | dimension | Aggr. | 0...n | ||
4 | dimensionname | Text | 1 | Dimension name. If dimension is not found from system, it is created | Project 1 |
4 | dimensionitem | Text | 1 | Dimension. If item in dimension is not found from system, it is created | Payroll |
2 | voucherattachments | Aggr. | 0...1 | ||
3 | voucherattachment | Aggr. | 1...n | ||
4 | mimetype | Text | 1 | MIME-type of the attachment | application/pdf |
4 | attachmentdescription | Text, max 100 characters | 1 | Description text for the attachment | Example attachment |
4 | filename | Text, max 255 character | 1 | File name of the attachment | Attachment.pdf |
4 | documentdata | Base64 | 1 | Data of the attachment as base64 encoded string |
Allowed VAT-classes:
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 |
Non-deductible reverse tax-liability | EVKV | 0, 10, 14, 24 |
Reverse tax-liability | KAVE | 0 |
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 |
Outside EU import tax | MAAL | 0, 10, 14, 124 |
Outside EU import tax non-deductible | EVMA | 0, 10, 14, 24 |
KOMY 0% | KOMY0 | 0 |
Edit accounting data
Resource: accountingedit.nv
Accounting edit can be used for editing existing voucher, voucher lines, voucher line dimensions and voucher attachments. The request doesn't have parameters. One request can include only one voucher. Accounting edit can be used for editing voucher's basic info and voucher lines. Basic info is not compulsory if only voucher lines are being edited. Accounting edit invalidates existing voucher lines and imports requests voucher lines as new voucher lines. If voucher lines are not imported in the request, no changes are made to the existing vouher lines.
The data to be imported must be included in the request as an XML with the following structure:
Level | Element name | Type and length | Occurs | Description | Example |
Root | root | Aggr. | 1 | ||
1 | voucher | Aggr. | 1 | ||
2 | netvisorkey | Numeric | 1 | Netvisor key of the voucher being edited. Netvisor key can be retreived with the resource accountingledger.nv | 123 |
2 | calculationmode | String | 0...1 | Calculation mode for the voucher. Net (vat lines are not calculated automatically) or gross (vat lines are calculated automatically). | gross |
2 | voucherdate | Date | 0...1 | Voucher date | 2009-1-1 |
Attr. | format | String | 1 | Date format, always ansi | andi |
2 | number | Numeric, max. 9 | 0...1 | Voucher number. If not given, the system automatically picks next number from the chosen voucher class | 1 |
2 | description | String, max. 255 | 0...1 | Voucher description | Description |
2 | voucherclass | String | 0...1 | Voucher class. See possible voucher classes above. It is also possible to create own voucher classes. | Myyntilasku |
2 | voucherline | Aggr. | 0...n | ||
3 | linesum | Numeric | 1 | Line sum. Negative value is recorded to credit side and positive value on debet side. Two decimal maximum. | -100,00 |
Attr. | type | String | 0...1 | net or gross | net |
3 | description | String, max. 255 | 0...1 | Voucher line description | Description |
3 | accountnumber | Numeric | 1 | Accounting account number, must be found or an error is returned. | 3000 |
3 | vatpercent | Numeric | 1 | Vat percent. Must not be in conflict with vatcode attribute. | 24 |
Attr. | vatcode | String | 0...1 | VAT code. If not given, value behind account number is used. Valid values are: NONE, KOOS, EUOS, EUUO, EUPO, 100, KOMY, EUMY, EUUM, EUPM312, EUPM309, MUUL, EVTO, EVPO, RAMY, RAOS, EVRO, EVKV | KOMY |
3 | accountdimension | String | 0...1 | Voucher line's follow-up object. | Seurantakohde 1 |
Attr. | type | String | 1 | name or netvisorkey (shown only in Netvisor) | name |
3 | dimension | Aggr. | 0...1 | ||
4 | dimensionname | String, max. 50 | 1 | Dimension name. If dimension is not found from system, it is created. | Project |
4 | dimensionitem | String, max. 200 | 1 | Dimension item. If item in dimension is not found from system, it is created. | Project x |
2 | voucherattachments | Aggr. | 0...1 | ||
3 | voucherattachment | Aggr. | 1...n | ||
4 | mimetype | String | 1 | MIME-type of the attachment | application/pdf |
4 | attachmentdescription | String | 1 | Description text for the attachment | Example attachment |
4 | filename | String | 1 | File name of the attachment | Attachment.pdf |
4 | documentdata | String | 1 | Data of the attachment as base64 encoded string |
Invalidate accounting data
Resource: invalitadevouchers.nv
This resource is used to invalidate vouchers in Netvisor by utilizing Netvisorkey. The Netvisorkey of the voucher can be retrieved using resource accountingledger.nv. It is possible to add comment with the request, which is shown in processing history in Netvisor. Note that a maximum of 100 vouchers can be invalidated with a single request.
The data to be imported must be included in the request as an XML with the following structure:
Level | Element name | Type and length | Occurs | Description | Example |
1 | root | Aggr. | 1 | ||
2 | invalidatevouchers | Aggr. | 1 | ||
Attr. | identifier | String | 1 | Linkin data type, always 'netvisorkey' | netvisorkey |
3 | comment | String max 255 | 0...1 | Free text, comment is seen in voucher's processing history in Netvisor | The reason of the invalidation is... |
3 | invalidatevoucher | Numeric | 1...100 | Netvisorkey of the voucher to be invalidated | 123 |
Deleted vouchers
Resource: deletedvouchers.nv
Retrieves vouchers that have been deleted since the given date. Vouchers can be retrieved up to 7 days from the given date.
Querystring parameters:
Parameter | Occurs | Description | Example |
deletedsince | 1 | Mandatory parameter. Retrieves events that have been deleted since the given date. Events can be retrieved up to 7 days from the given date. | 2022-06-08 |
Response:
Level | Element | Type | Occurs | Description | Example |
root | root | Aggr. | 1 | ||
1 | DeletedVouchers | Aggr. | 1 | ||
2 | DeletedVoucher | Aggr. | 0...n | ||
3 | NetvisorKey | Numeric | 1 | Netvisor ID of voucher | 5 |
3 | DeleteDate | Date | 1 | Delete date | 2022-06-08 15:14 |
Attr. | format | String | 1 | Date format, always ansi | ansi |
Get whole account list
Resource: accountlist.nv
Used for fetching whole account list and default accounts used in default accounting.
Response:
Level | Element | Type | Occurs | Description | Example |
Root | Root | Aggr. | 1 | ||
1 | AccountList | Aggr. | 1 | ||
2 | CompanyDefaultAccounts | Aggr. | 1 | ||
3 | TradePayables | Numeric | 1 | ||
3 | PurchaseVATReceivable | Numeric | 1 | ||
3 | RoundingOffDifference | Numeric | 1 | ||
3 | VATpayable | Numeric | 1 | ||
3 | TaxAccount | Numeric | 1 | ||
3 | AdvancePayments | Numeric | 1 | ||
3 | SalesReceivables | Numeric | 1 | ||
3 | SalesVATdebt | Numeric | 1 | ||
3 | Inventory | Numeric | 1 | ||
3 | SalesDiscount | Numeric | 1 | ||
3 | SalesExchangeRateDiffereces | Numeric | 1 | ||
3 | Collection | Numeric | 1 | ||
3 | PurchaseDiscounts | Numeric | 1 | ||
3 | PurchasesExchangeRateDifferences | Numeric | 1 | ||
3 | PurchaseInvoiceAccrual | Numeric | 1 | ||
3 | SalesInvoiceAccrual | Numeric | 1 | ||
3 | PurchaseDomesticDefault | Numeric | 1 | ||
3 | PurchaseEUDefault | Numeric | 1 | ||
3 | PurchaseOutsideEuDefault | Numeric | 1 | ||
3 | SalesDomesticDefault | Numeric | 1 | ||
3 | SalesEUDefault | Numeric | 1 | ||
3 | SalesOutsideEUDefault | Numeric | 1 | ||
3 | Accounts | Aggr. | 1 | ||
4 | Account | Aggr. | 1...n | ||
5 | NetvisorKey | Numeric | 1 | Database ID | |
5 | Number | Numeric | 1 | Account number | |
5 | Name | Numeric | 1 | ||
5 | ForeignName | Text | 0...3 | Account in Swedish or in English | |
Attr. | ISO-3166 | Text | 1 | fi|en|se | |
5 | AccountType | Text | 1 | Type of the account, account or accountgroup | |
5 | FatherNetvisorKey | Numeric | 1 | Under which account, account belongs ie. account 3000 father is group 300 | |
5 | IsActive | Numeric | 1 | ||
5 | IsCumulative | Numeric | 1 | Is the calculation cumulative. Balance sheet | |
5 | Sort | Numeric | 1 | ||
5 | EndSort | Numeric | 1 | ||
5 | IsNaturalNegative | Numeric | 1 |
Get accounting periods
Resource: accountingperiodlist.nv
Used for getting accounting periods and possible lockdowns.
Doesn't return which period is active. Lists all possible periods in ascending order.
Querystring parameters:
(No parameters)
Response:
Level | Element name | Type and length | Occurs | Description | Example |
Root | Root | Aggr. | 1 | ||
1 | AccountingPeriodList | Aggr. | 1 | ||
2 | PeriodLockInformation | Aggr. | 1 | ||
3 | AccountingPeriodLockDate | Date | 1 | Lock period | 2014-12-31 |
Attr. | format | Text | 1 | Date format, always ansi | ansi |
3 | VatPeriodLockDate | Date | 1 | VAT-lock date | 2014-12-31 |
Attr. | format | Text | 1 | Date format, always ansi | ansi |
3 | PurchaseLockDate | Date | 1 | Accounts payable lock date | 2014-12-31 |
Attr. | format | Text | 1 | Date format, always ansi | ansi |
3 | Period | Aggr. | 1...n | ||
4 | NetvisorKey | Numeric | 1 | Period NetvisorID | 123 |
4 | Name | Text | 1 | Name | |
4 | BeginDate | Date | 1 | Period start date | |
Attr. | format | Text | 1 | Date format, always ansi | ansi |
4 | EndDate | Date | 1 | Period end date | |
Attr. | format | Text | 1 | Date format, always ansi | ansi |
Get voucher types
Resource: vouchertypelist.nv
The resource returns company's voucher types and default voucher types
Response:
Level | Element name | Type and length | Occurs | Description | Example |
Root | Root | Aggr. | 1 | ||
1 | VoucherTypeList | Aggr. | 1 | ||
2 | DefaultVoucherTypes | Aggr. | 1 | Default voucher type | |
3 | SalesInvoices | Aggr. | 1 | ||
4 | NetvisorKey | Numeric | 1 | Sales invoice -Netvisor key of the delauft voucher type | 123 |
3 | SalesInvoicePayments | Aggr. | 1 | ||
4 | NetvisorKey | Numeric | 1 | Sales invoice payment -Netvisor key of the default voucher type | 125 |
3 | PurchaseInvoices | Aggr. | 1 | ||
4 | Netvisorkey | Numeric | 1 | Purchase invoice -Netvisor key of the default voucher type | 128 |
3 | PurchaseInvoicePayments | Aggr. | 1 | ||
4 | NetvisorKey | Numeric | 1 | Purchase invoice payment -Netvisor key of the default voucher type | 126 |
3 | OtherSystemGeneratedVouchers | Aggr. | 1 | ||
4 | NetvisorKey | Numeric | 1 | Other vouchers generated by the system -Netvisor key of the default voucher type | 129 |
3 | BankStatementViewVouchers | Aggr. | 1 | ||
4 | Netvisorkey | Numeric | 1 | Vouchers generated from bank statement view -Netvisor key of the default voucher type | 122 |
3 | Accruals | Aggr. | 1 | ||
4 | NetvisorKey | Numeric | 1 | Accruals -Netvisor key of the default voucher type | 127 |
2 | VoucherTypes | Aggr. | 1 | Voucher types | |
3 | VoucherType | Aggr. | 1...n | ||
4 | NetvisorKey | Numeric | 1 | Netvisor key of the voucher type | 121 |
4 | Abbreviation | Text | 1 | Abbreviation of the voucher type | ML |
4 | Name | Text | 1 | Name of the voucher type | Myyntilasku |
4 | ForeignName | Text | 0...3 | Voucher type in Swedish or in English | |
Attr. | ISO-639-1 | Text | 1 | fi|en|sv |
Did you find it helpful? Yes No
Send feedback