Please enable JavaScript to view this site.

Made in EU
Visma.net Financials Forums

Visma.net Financials API Data Model

Navigation: Schema: Budget > Tables

BudgetPeriods: Visma.net Financials Budget Periods

Get a range of General Ledger Budget Figures - ScreenId=GL302010

Catalog: VismaNet

Schema: Budget

Label: Budget Periods

The data in this table is partitioned per value of the COMPANY_CODE column.

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive SQL driver for Visma.net Financials does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net Financials API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function BudgetPeriods. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

branch

string

☐

 

Mandatory. Filter by budgets Branch.

COMPANY_CODE

string

☐

 

Partition to retrieve data from.

erp-api-background

string

☐

 

If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.

financialYear

string

☐

 

The budgets financial year.

greaterThanValue

string

☐

 

Filter by from date.

lastModifiedDateTime

string

☐

 

System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present.

lastModifiedDateTimeCondition

string

☐

 

System retrieved information for state/condition.

ledger

string

☐

 

Mandatory. The budgets Ledger

numberToRead

int32

☐

 

This field has been deprecated and will be removed in future versions.

orderBy

string

☐

 

Order by Last modified date and time.

skipRecords

int32

☐

 

This field has been deprecated and will be removed in future versions.

subaccount

string

☐

 

The Subaccount of the budget article.

 

Columns of Table Function

The columns of the table function BudgetPeriods are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

account_description

string

Account Description

☐

Name of item/description

account_externalCode1

string

Account External Code 1

☐

Account class > The identifier of the account class.

account_externalCode2

string

Account External Code 2

☐

Account class > The name of the account class.

account_number

string

Account Number

☐

Number of item

account_type

string

Account Type

☐

Account > The account number.

amount_1

double

 

☐

The budget area > The budget articles pane > Amount > The article amount.

amount

double

Amount

☐

 

branchNumber_name

string

Branch Name

☐

Click the magnifier. > The name.

branchNumber_number

string

Branch Number

☐

Click the magnifier. > The identifier.

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

description

string

Description

☐

Mandatory field: The budget area > The budget articles pane > Description* > A description of the budget article.By default, this column displays the account description.

distributedAmount

double

Distributed Amount

☐

The budget area The budget articles pane > Distributed amount > The amount distributed over the periods.

financialYear

string

Financial Year

☐

Mandatory field: The top part > Financial year* > The financial year of the budget.

lastModifiedDateTime

datetime

Last Modified

☐

A system generated date/time not visible in the window.

periodId

string

Period ID

☐

 

released

boolean

Released

☐

The budget area > The budget articles pane > Released > A check box that indicates (if selected) that the budget article has been released.

releasedAmount

double

Released Amount

☐

The budget area > The budget articles pane > Released amount > The amount that has been released for this article.

subaccount_description

string

Subaccount Description

☐

Click on the magnifier. > The description.

subaccount_id

string

Subaccount ID

☐

Click on the magnifier. > The identifier.

 

22-12-2022 21:03 Version 22.1.101-BETA+3681

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer