itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a specific Customer Contract Summary
Catalog: VismaNet
Schema: CustomerContract
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.
Select Visma.net Financials API URL: /controller/api/v1/customerContract/{contractId}/summary
Insert Visma.net Financials API URL: /controller/api/v1/customerContract/{contractId}/summary
Update Visma.net Financials API URL: /controller/api/v1/customerContract/{contractId}/summary
Delete Visma.net Financials API URL: /controller/api/v1/customerContract/{contractId}/summary
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/customerContract/{contractId}/summary
Table Function Parameters
The following parameters can be used to control the behaviour of the table function CustomerContractSummaryByContractId. 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 |
|---|---|---|---|---|
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
contractId |
string |
☑ |
|
Identifies the customer contract |
Table Function Columns
The columns of the table function CustomerContractSummaryByContractId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
activationDate |
datetime |
Activation Date |
☐ |
Contract settings section > Activation date > The date to initiate the provision of the contract services. |
caseCountItem_description |
string |
|
☐ |
Name of item/description |
caseCountItem_number |
string |
|
☐ |
Number of item |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
currency |
string |
Currency |
☐ |
Mandatory field: Contract settings section > Currency* > The currency used in the contract. |
expirationDate |
datetime |
Expiration Date |
☐ |
Contract settings section > Expiration date > The date when the contract expires. |
gracePeriod |
int32 |
Grace Period |
☐ |
Contract settings section > Grace period > The number of days after the expiration date where the contract can still be renewed. |
invoiceAccount_name |
string |
|
☐ |
Click the magnifier. > The name. |
invoiceAccount_number |
string |
|
☐ |
|
invoiceLocation_description |
string |
|
☐ |
Click on the magnifier. > The description. |
invoiceLocation_id |
string |
|
☐ |
Click on the magnifier. > The identifier. |
invoiceTo |
string |
Invoice To |
☐ |
Invoice information section > Invoice to > The setting that defines the customer account to be invoiced for a contract. The following options are available: Parent account, Customer account, Specific account. |
invoicingPeriod |
string |
Invoicing Period |
☐ |
Mandatory field: Invoicing schedule section > Invoicing period* > The type of invoicing schedule, which can be one of the following options: Weekly, Monthly; Quarterly, Half a year, Yearly, On demand, Statement based. |
invoicingScheduleStartsOn |
datetime |
|
☐ |
Invoicing schedule section > Invoice schedule starts on > A read-only field that displays the start date of the first invoicing period. |
lastInvoicingDate |
datetime |
Last Invoicing Date |
☐ |
Invoicing schedule section > Last invoicing date > A read-only field that shows the date when the invoicing was performed most recently. |
massRenewal |
boolean |
Mass Renewal |
☐ |
Contract settings section > Mass renewal > A check box indicating renewal of all contract at expiration date. |
nextInvoicingDate |
datetime |
Next Invoicing Date |
☐ |
Invoicing schedule section > Next invoicing date > The date of the next invoicing invoice, according to the invoicing schedule. |
owner_internalId |
string |
Owner Internal ID |
☐ |
|
owner_name |
string |
Owner Name |
☐ |
The name of the particular destination of the selected type. |
owner_number |
string |
Owner Number |
☐ |
The identifier of the particular destination of the selected type. |
renewalPoint |
int32 |
Renewal Point |
☐ |
Contract settings section > Renewal point > The number of days before expiration where the renewal process are to begin. |
salesPerson_description |
string |
Sales Person Description |
☐ |
Click on the magnifier. > The description. |
salesPerson_id |
string |
Sales Person ID |
☐ |
Click on the magnifier. > The identifier. |
setupDate |
datetime |
|
☐ |
Mandatory field: Contract settings section > Setup date* > The date of contract setup. |
terminationDate |
datetime |
Termination Date |
☐ |
Contract settings section > Termination date > The date when the contract will be cancelled; no services will be provided. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
