Used for monitoring the status of a company’s financial management obligations for a given period:
Includes VAT returns, VAT summary and reconciliations.
Resource: financialobligationstatus.nv
HTTP method: GET
Parameters used in the request
Parameter | Occurrences | Description | Example |
StartMonth | 0...1 | Start month of the search. Year 2000–2100. Default: previous month. | 2024-11 |
EndMonth | 0...1 | End month of the search (inclusive). Maximum range 24 months. | 2024-11 |
Response:
Level | Element | Format | Occurrences | Description | Example |
root | Root | Aggregate | 1 | ||
1 | ResponseStatus | Aggregate | 1 | ||
1 | FinancialObligationStatus | Aggregate | 1 | Actual response data (payload). |
|
2 | StartMonth | String | 1 | Start month of the search in the format YYYY-MM. | 2024-11 |
2 | EndMonth | String | 1 | End month of the search in the format YYYY-MM. | 2024-11 |
2 | Months | Aggregate | 1 | month-specific data |
|
3 | Month | Aggregate | 1...n | Summary of a single month. |
|
Attr. | Period | String | 1 | Period (YYYY-MM). | 2024-11 |
4 | VATReport | Aggregate | 1 | VAT return details. Self-closing if there is no record. |
|
5 | FilingDate | Date | 0...1 | The day when the VAT return was filed (yyyy-MM-dd). | 2024-12-10 |
5 | Status | String | 0...1 | Notification status | See statuses in separate table VATReport Status values |
5 | TaxPeriod | String | 0...1 | VAT filing period | Month, Quarter, Year |
5 | PayableAmount | Numeric | 0...1 | Amount of tax payable (0.00). | 1250.00 |
4 | Reconciliations | Aggregate | 1 | Subledger reconciliation data. Always included. |
|
5 | PurchaseLedger / SalesLedger | Aggregate | 1 | Subledger reconciliation block. |
|
6 | DeviatingVouchers | Numeric | 1 | Number of deviating vouchers. | 2 |
6 | DeviatingPayments | Numeric | 1 | Number of deviating payments | 2 |
6 | SourceEndBalance | Numeric | 1 | Subledger closing balance at the end of the month. | 4800.00 |
6 | BookkeepingEndBalance | Numeric | 1 | Bookkeeping closing balance | 1500.00 |
2 | Years | Aggregate | 1 | Wrapper for year-specific data. |
|
3 | Year | Aggregate | 1...n | Calendar year summary |
|
Attr. | Value | String | 1 | Calendar year (YYYY). | 2024 |
4 | VATSummaryReport | Aggregate | 1 | Summary notification details. |
|
5 | Period | String | 0...1 | Most recently sent summary | 2024-10 |
5 | Status | String | 0...1 | Dispatch status | Sent, MarkedAsSent |
5 | TotalAmount | Numeric | 0...1 | Total row sum; if there are no rows, 0.00 is returned | 1200.00 |
4 | IncomeTaxReport | Aggregate | 1 | Income tax return status | Sent/Unsent |
5 | FiscalYear | Aggregate | 1 | Financial period status (e.g. Open, Locked). |
|
5 | Status | 1 | 1 | Status is 'Sent' if there is an approved income tax return for the year in question; otherwise 'Unsent' | Sent, unsent |
4 | FiscalYearStatus | Aggregate | 1 | see table FiscalYearStatus Status values | |
5 | Year | String | 1 | Calendar year | 2024 |
5 | Status | Status | 1 | status. | Open |
VATReport Status values:
Value | Description |
Errorneous | An error occurred in the VAT return during submission. Requires corrective actions. |
Sent | The VAT return has been successfully submitted electronically. |
MonthsFirst | The first return created for the month. |
Replacing | A replacement return that replaces a previously submitted return. |
MarkAsSent | Manually marked as sent — the notification has been handled outside Netvisor (e.g. reported directly in OmaVero). |
FiscalYearStatus values:
Value | Meaning (description) |
Open | The financial period is open for postings. |
Locked | The period is locked — changes are not allowed without unlocking. |
Sealed | The period is closed (finalised). A stronger status than locked. |
Validated | The Accountant has reviewed and validated the period. |
Audited | The financial period has been audited. Final status. |
SealedUnderGeneration | Intermediate status — the period is currently being closed (financial statements generation in progress). |
Change history
Date | Change | Description |
29.4.2026 | New resource | FinancialObligationStatus.nv published |
This article has been translated using an AI-based translation tool. The contents or wording of these instructions may differ from those in other instructions or in the software.