Resources - Accounting materials
| Integration | HTTP-method | Resource | DTD | Schema | Example |
| Get accounting data | GET | accountingledger.nv | Download | ||
| Import accounting data | POST | accounting.nv | Download | Download | |
| Import budget | POST | accountingbudget.nv | Download | Download | |
| Import dimension budget | POST | accountingbudgetdimensionbudget.nv | Download | Download | |
| Import accounting budget | POST | accountingbudgetaccountbudget.nv | Download | ||
| Get budget by account group | GET | accountingbudgetyearbudget.nv |
|
Download | |
| Get budget by year, account group and dimension name | GET | accountingbudgetdimensionyearbudget.nv |
|
Download | |
| Get budget's accounts and account groups | GET | accountingbudgetaccountlist.nv | Download | ||
| Get whole account list | GET | accountlist.nv | Download | ||
| Get accounting periods | GET | accountingperiodlist.nv | Download |
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" or "invalidated" | 1 = All 2 = Valid 3 = Invalidated and deleted |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| root | Root | Aggr | |||
| 1 | Vouchers | Aggr | 1 | ||
| 2 | Voucher | Aggr | 0...n | ||
| Attribute | Status | Text | 0...1 | Status of the Voucher |
valid or invalidated |
| 3 | NetvisorKey | Numeric | 1 | Netvisor key of the Voucher |
15 |
| 3 | VoucherDate | Date | 1 | Date of the Voucher |
2013-12-05 |
| 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 |
| Attribute | type | Text | 1 | "purchaseinvoice" or "salesinvoice" | purchaseinvoice |
| 3 | VoucherNetvisorURI | Text | 1 | URI to the voucher in Netvisor | |
| 3 | VoucherLine | Aggr | 0...n | ||
| 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 |
22 |
| 4 | VatCode | Text | 1 | VAT code | |
| 4 | Dimension | Aggr | 0...1 | ||
| 5 | DimensionName | Text | 1 | Dimension name | |
| 5 | DimensionItem | Text | 1 | Dimension |
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)
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.
Negative sum is recorded as credit and positive sum as debit.
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.
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 |
| Attribute | 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 | 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 |
| Attribute | 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 | 1 | Must not be in conflict with vatcode attribute |
24 | |
| Attribute | vatcode | Text | 0...1 | 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 | 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 | 1 | Description text for the attachment |
Example attachment |
| 4 | filename | Text | 1 | File name of the attachment |
Attachment.pdf |
| 4 | documentdata | Base64 | 1 | Data of the attachments as base64 encoded string |
Resource: accountingbudgetdimensionbudget.nv
Importing a a dimension budget into Netvisor. 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 | Example | Description |
| Root | root | Aggr. | 1 | ||
| 1 | accountingbudgetdimensionbudget | Aggr | 1 | ||
| 2 | method | Text | 1 | change | Type of import, change or replace |
| 2 | lockeddimension | Aggr. | 0...n | ||
| 3 | dimensionname | Text | 1 | Dimension name | |
| 3 | dimensionitemname | Text | 1 | Dimension | |
| 2 | accountidentifier | Aggr. | 1 | ||
| 3 | accountnumber | Numeric | 1 | Accounting account | |
| 3 | accountname | Text | 1 | Account name | |
| 3 | accountgroup | Numeric | 1 | Account group number | |
| 2 | budgetdimension | Aggr. | 1...n | ||
| 3 | dimensionname | Text | 1 | Dimension name | |
| 3 | dimensionitemname | Text | 1 | Dimension | |
| 3 | budgetmonth | Aggr. | 1...n | ||
| 4 | sum | Numeric | 1 | Sum of the budget | |
| 4 | vat | Numeric | 1 | VAT | |
| 4 | month | Numeric | 1 | Budget month | |
| 4 | year | Numeric | 1 | Budget year |
Resource: accountingbudgetaccountbudget.nv
Importing an accounting budget into Netvisor. 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 | Example | Description |
| Root | root | Aggr. | 1 | ||
| 1 | accountingbudgetaccountbudget | Aggr. | 1 | ||
| 2 | method | Text | 1 | change | change or replace |
| 2 | lockeddimension | Aggr. | 0...n | ||
| 3 | dimensionname | Text | 1 | Dimension name | |
| 3 | dimensionitem | Text | 1 | Dimension | |
| 2 | budgetaccount | Aggr. | 1...n | ||
| 3 | accountidentifier | Aggr. | 1 | ||
| 4 | accountnumber | Numeric | 1 | Account number | |
| 4 | accountname | Text | 1 | Account name | |
| 4 | accountgroup | Numeric | 1 | Account group number | |
| 3 | budgetmonth | Aggr. | 1...n | ||
| 4 | sum | Numeric | 1 | Sum of the budget | |
| 4 | vat | Numeric | 1 | VAT | |
| 4 | month | Numeric | 1 | Month of the budget | |
| 4 | year | Numeric | 1 | Year of the budget |
Resource: accountingbudgetyearbudget.nv
Returns budget from chosen year by account group.
| Parameter | Occurs | Description | Example |
| year | 1 | Year of the budget | 2018 |
| lockeddimensionitemid | 0...1 |
Limits the the information that it contains the dimension items given in the parameter. Separated by comma (,). |
accountingbudgetyearbudget.nv?year=2018&lockeddimensionitemid=1 |
You can get DimensionItemID by using resource dimensionlist.nv
From that response:
<DimensionDetails>
<DimensionDetail>
<Netvisorkey>xxx</Netvisorkey> is the DimensionItemID
Response:
| Level | Element name | Type | Occurs | Description | Example |
| 1 | Root | Aggr. | 1 | ||
| 2 | AccountingBudgetAccountBudget | Aggr. |
1 |
||
| 3 | BudgetAccount | Text | 1 | ||
| 4 | AccountName | Text | 1 | Name of account group | |
| 4 | AccountNumber | Text | 1 | Account number | |
| 4 | AccountGroup | Aggr. | 1 | Number of account group | |
| 4 | BudgetMonth | Text | 12 | ||
| 5 | Sum | Text | 1 |
Budgeted amount |
|
| 5 | Vat | Text | 1 | VAT % | |
| 5 | Year | Text | 1 | Yeat | |
| 5 | Month | Text | 1 | Month |
Get budget by year, account group and dimension name
Resourse: accountingbudgetdimensionyearbudget.nv
Returns company's default budget by desired year, account group and dimension name.
| Parameter | Occurs | Description | Example |
| Year | 1 | Budgeted year | 2018 |
| AccountID | 1 | ID of the budgeted account group | 549 |
| DimensionHeaderId | 1 | ID of the budgeted dimension name | 1 |
| LockedDimensionItemId | 0...1 |
Limits the the information that it contains the dimension items given in the parameter. Separated by comma (,). |
accountingbudgetyearbudget.nv?year=2018&lockeddimensionitemid=1 |
You can get AccountID by using resource accountlist.nv
From that response:
<Account>
<NetvisorKey>xxx</NetvisorKey> is the AccountID.
You can get DimensionHeaderID and DimensionItemID by using resource dimensionlist.nv
From that response:
<DimensionName>
<Netvisorkey>xxx</Netvisorkey> is the DimensionHeaderId
<DimensionDetails>
<DimensionDetail>
<Netvisorkey>xxx</Netvisorkey> is the DimensionItemID
Response:
| Level | Element name | Type | Occurs | Description | Example |
| 1 | Root | Aggr. | 1 | ||
| 2 | AccountingBudgetDimensionBudget | Aggr. |
1 |
||
| 3 | AccountNumber | Text | 1 | ||
| 3 | AccountName | Text | 1 | Name of account group | |
| 4 | AccountGroup | Text | 1 | Account group number | |
| 4 | BudgetDimension | Aggr. | 1 | ||
| 5 | DimensionItemName | Text | 1 | Dimension item name | |
| 5 | DimensionName | Text | 1 | Dimension header name | |
| 5 | BudgetMonth | Aggr. | 12 | ||
| 6 | Sum | Text | 1 | Budgeted amount | |
| 6 | Vat | Text | 1 | VAT % | |
| 6 | Year | Text | 1 | Year | |
| 6 | Month | Text | 1 | Month |
Get budget's accounts and account groups
Resource: accountingbudgetaccountlist.nv
Returns current budget's account groups and accounts for making the budget.
| Parameters | Occurs | Description | Example |
| year | 1 | Year has to be between 1950-2050 | 2018 |
Response:
| Level | Element name | Type | Occurs | Description | Example |
| Root | Root | Aggr. | 1 | ||
| 1 | AccountingBudgetAccountList | Aggr. |
1 |
||
| 2 | Account | Aggr. | 0...n | ||
| 4 | NetvisorKey | Numeric | 1 | ID of account | 123 |
| 4 | Name | Text | 1 | Name of account | Myynti |
| 4 | Number | Aggr. | 1 | Account number | 3003 |
| 4 | Group | Text | 12 | ID of account group | 300 |
| 5 | Type | Text | 1 | ID of account type | 6 |
Resource: accountlist.nv
Used for fetching whole account list and default accounts used in default accounting.
Querystring parameters:
(No parameters)
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 | |
| Attribuutti | 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 |
Resource: accountingbudget.nv
Importing a budget into Netvisor. 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 | Example | Description |
| Root | root | Aggr. | 1 | ||
| 1 | accountingbudget | Aggr. | 1 | ||
| 2 | ratio | Text | 1 | 5000 | Account or account group number where budgeting is targeted |
| Attr. | type | Text | 0...1 | account | Type of the element in ratio field. account for account, ratio for group. For now, only account is supported |
| 2 | sum | Numeric | 1 | 50000 | Budget for the given month and year |
| 2 | year | Numeric | 1 | 2013 | Year of budget |
| 2 | month | Numeric | 1 | 12 | Month of budget |
| 2 | version | Text | 1 | Budget 2009, version 1 | Version of the budget. If given version is not found, it is created. If budget version for the month determined in the imported material already exists, it is deleted and replaced with the imported data |
| 2 | vatclass | Numeric | 0...1 | 22 | VAT-percent |
| 2 | combinations | Aggr. | 1 | ||
| 3 | combination | Aggr. | 1...n | ||
| 4 | combinationsum | Numeric | 1 | Dimension or dimension combination sum | |
| 4 | dimension | Aggr. | 1...n | ||
| 5 | dimensionName | Text | 1 | Project 1 | If dimension does not exists on system, it is created |
| 5 | dimensionItem | Text | 1 | Payroll | if item is not found from dimension, it is created |
| Attr. | fatherid | Numeric | 0...1 | 15 | Netvisor id of the dimension that the budget is to be added. If the dimension is not found for the id, an INVALID_DATA error is returned with further information |
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 | Perido 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 |