itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a range of General Ledger Budget Figures - ScreenId=GL302010
Catalog: VismaNet
Schema: Budget
Label: Budgets
The data in this table is partitioned per value of the COMPANY_CODE column.
Retrieve: true
Insert: true
Update: true
Delete: false
Select Visma.net Financials API URL: /controller/api/v1/budget
Insert Visma.net Financials API URL: /controller/api/v1/budget
Update Visma.net Financials API URL: /controller/api/v1/budget
Delete Visma.net Financials API URL: /controller/api/v1/budget
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/budget
Insert Visma.net Financials API Operation: post /controller/api/v1/budget
Update Visma.net Financials API Operation: put /controller/api/v1/budget
Table Function Parameters
The following parameters can be used to control the behaviour of the table function Budgets. 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 treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `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. |
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. |
Table Function Columns
The columns of the table function Budgets are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert or update.
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 |
double |
Amount |
☐ |
The budget area > The budget articles pane > Amount > The article 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. |
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. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
