CustomerV2CustomerBalance |
Get the balance for one or multiple customers
Catalog: VismaNet
Schema: CustomerV2
This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL 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 CustomerV2CustomerBalance. 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 |
|---|---|---|---|---|
branchNumber |
|
☐ |
|
Filter by Branch |
customer |
|
☐ |
|
Filter by Customer |
fromFinPeriod |
|
☑ |
|
Filter from financial period, format YYYYPPThe filte is inclusive, the records for the specified period will be included in the results.This filter is required. |
toFinPeriod |
|
☑ |
|
Filter to financial period, format YYYYPPThe filte is inclusive, the records for the specified period will be included in the results.This filter is required. |
Columns of Table Function
The columns of the table function CustomerV2CustomerBalance are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
adjustmentsAndDiscounts |
double |
|
☐ |
Adjustments and discounts |
beginBalance |
double |
|
☐ |
Begin balance |
branchNumber_name |
varchar2 |
Branch Name |
☐ |
Click the magnifier. > The name. |
branchNumber_number |
varchar2 |
Branch Number |
☐ |
Click the magnifier. > The identifier. |
COMPANY_CODE |
varchar2(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
varchar2(240) |
Company Name |
☑ |
Name of the partition. |
customer_internalId |
int32 |
Customer Internal ID |
☐ |
|
customer_name |
varchar2 |
Customer Name |
☐ |
The name of the particular destination of the selected type. |
customer_number |
varchar2 |
Customer Number |
☐ |
The identifier of the particular destination of the selected type. |
overdueCharges |
double |
|
☐ |
Overdue charges |
paymentsAndPrepayments |
double |
|
☐ |
Payments and prepayments |
sales |
double |
|
☐ |
Purchases |
yearToDateBalance |
double |
|
☐ |
Year to date balance |
Visma.net Financials API Data Model