Visma.net Financials API Data Model

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Schema: CustomerContract > Tables

CustomerContract_DetailsLines

Contents Previous Home Next More

Get a range of Customer Contracts, a filter needs to be specified - ScreenId=CT301000

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

Insert Visma.net Financials API URL: /controller/api/v1/customerContract

Update Visma.net Financials API URL: /controller/api/v1/customerContract

Delete Visma.net Financials API URL: /controller/api/v1/customerContract

Field Selection Method: NotRequired

Base Path: details.lines[*]

Select Visma.net Financials API Operation: get /controller/api/v1/customerContract

Table Function Parameters

The following parameters can be used to control the behaviour of the table function CustomerContract_DetailsLines. 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	Documentation
attributes	string	☐
COMPANY_CODE	string	☐	Partition to retrieve data from.
contractTemplate	string	☐
customer	string	☐
expandAttributes	boolean	☐
expandDetails	boolean	☐
expandSummary	boolean	☐
greaterThanValue	string	☐
lastModifiedDateTime	string	☐
lastModifiedDateTimeCondition	string	☐
numberToRead	int32	☐
orderBy	string	☐
skipRecords	int32	☐
status	string	☐	Values: Draft, InApproval, Active, Expired, Canceled, Completed, InUpgrade, PendingActivation.

Table Function Columns

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

Name	Data Type	Label	Required	Documentation
balance	double	Balance	☐	The top part > Balance > A read-only field that displays the sum of the balances of open invoices associated with the contract.
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
contractDetailId	int32		☐
contractId	string	Contract ID	☐	Mandatory field: The top part > Contract ID* > The unique identifier of a contract.
contractTemplate_description	string	Contract Template Description	☐	Click on the magnifier. > The description.
contractTemplate_id	string	Contract Template ID	☐	Click on the magnifier. > The identifier.
currentRecurring	double		☐
currentRenewal	double		☐
currentSetup	double		☐
customer_name	string	Customer Name	☐	Click the magnifier. > The name.
customer_number	string	Customer Number	☐
description_1	string		☐	Mandatory field: The top part > Description* > The description of the contract, which includes any related comments.
description	string	Description	☐
difference	double	Difference	☐
effectiveFrom	datetime	Effective from	☐
extraUsagePrice	double		☐
included	double	Included	☐
invoiceType	string		☐
itemCode	string	Item Code	☐
lastModifiedDateTime	datetime	Last Modified	☐	System generated information
location_description	string	Location Description	☐	Click on the magnifier. > The description.
location_id	string	Location ID	☐	Click on the magnifier. > The identifier.
pendingRecurring	double		☐
pendingRenewal	double		☐
pendingSetup	double		☐
promoCode_description	string		☐	Click on the magnifier. > The description.
promoCode_id	string		☐	Click on the magnifier. > The identifier.
recurringDiscount	double		☐
recurringPrice	double		☐
renewalDiscount	double		☐
renewalPrice	double		☐
setupDiscount	double		☐
setupPrice	double		☐
status	string	Status	☐	The top part > Status > The status of the contract, which is one of the following: Draft, Pending activation, Active, Expired, Cancelled, Pending update.
summary_activationDate	datetime	Activation Date	☐	Contract settings section > Activation date > The date to initiate the provision of the contract services.
summary_caseCountItem_description	string		☐	Name of item/description
summary_caseCountItem_number	string		☐	Number of item
summary_currency	string	Currency	☐	Mandatory field: Contract settings section > Currency* > The currency used in the contract.
summary_expirationDate	datetime	Expiration Date	☐	Contract settings section > Expiration date > The date when the contract expires.
summary_gracePeriod	int32	Grace Period	☐	Contract settings section > Grace period > The number of days after the expiration date where the contract can still be renewed.
summary_invoiceAccount_name	string		☐	Click the magnifier. > The name.
summary_invoiceAccount_number	string		☐
summary_invoiceLocation_description	string		☐	Click on the magnifier. > The description.
summary_invoiceLocation_id	string		☐	Click on the magnifier. > The identifier.
summary_invoiceTo	string		☐	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.
summary_invoicingPeriod	string		☐	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.
summary_invoicingScheduleStartsOn	datetime		☐	Invoicing schedule section > Invoice schedule starts on > A read-only field that displays the start date of the first invoicing period.
summary_lastInvoicingDate	datetime		☐	Invoicing schedule section > Last invoicing date > A read-only field that shows the date when the invoicing was performed most recently.
summary_massRenewal	boolean		☐	Contract settings section > Mass renewal > A check box indicating renewal of all contract at expiration date.
summary_nextInvoicingDate	datetime		☐	Invoicing schedule section > Next invoicing date > The date of the next invoicing invoice, according to the invoicing schedule.
summary_owner_internalId	string		☐
summary_owner_name	string		☐	The name of the particular destination of the selected type.
summary_owner_number	string		☐	The identifier of the particular destination of the selected type.
summary_renewalPoint	int32		☐	Contract settings section > Renewal point > The number of days before expiration where the renewal process are to begin.
summary_salesPerson_description	string		☐	Click on the magnifier. > The description.
summary_salesPerson_id	string		☐	Click on the magnifier. > The identifier.
summary_setupDate	datetime		☐	Mandatory field: Contract settings section > Setup date* > The date of contract setup.
summary_terminationDate	datetime		☐	Contract settings section > Termination date > The date when the contract will be cancelled; no services will be provided.
totalPending	double	Total Pending	☐

06-04-2021 14:55 Version 20.1.393-BETA+3152

Please enable JavaScript to view this site.

itgendoc001X

Visma.net Financials API Data Model

Table Function Parameters

Table Function Columns