Navigation: Catalog: VismaNet > Schemas > Schema: CustomerContract > Tables

CustomerContractDetailsLines: Visma.net Financials Customer Contract Details Lines

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

Catalog: VismaNet

Schema: CustomerContract

Label: Customer Contract Details Lines

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 CustomerContractDetailsLines. 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	Required	Documentation
attributes	☐	Attributes (additional information) connected to the entity.Examples:{{base}}/customerContract?attributes={"AttributeID":"ValueID","AttributeID":"ValueID"}{{base}}/customerContract?attributes={"AttributeID":"ValueID1,ValueID2"}
contractTemplate	☐
customer	☐
expandAttributes	☐
expandDetails	☐
expandSummary	☐
greaterThanValue	☐
lastModifiedDateTime	☐
lastModifiedDateTimeCondition	☐
orderBy	☐
status	☐	Values: Draft, InApproval, Active, Expired, Canceled, Completed, InUpgrade, PendingActivation.

Columns of Table Function

The columns of the table function CustomerContractDetailsLines 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	varchar2(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	varchar2(240)	Company Name	☑	Name of the partition.
contractDetailId	int32		☐
contractId	varchar2	Contract ID	☐	Mandatory field: The top part > Contract ID* > The unique identifier of a contract.
contractTemplate_description	varchar2	Contract Template Description	☐	Click on the magnifier. > The description.
contractTemplate_id	varchar2	Contract Template ID	☐	Click on the magnifier. > The identifier.
currentRecurring	double		☐
currentRenewal	double		☐
currentSetup	double		☐
customer_name	varchar2	Customer Name	☐	Click the magnifier. > The name.
customer_number	varchar2	Customer Number	☐
description_2	varchar2	Description 2	☐	Mandatory field: The top part > Description* > The description of the contract, which includes any related comments.
description	varchar2	Description	☐
difference	double	Difference	☐
effectiveFrom	datetime	Effective from	☐
extraUsagePrice	double		☐
included	double	Included	☐
invoiceType	varchar2		☐
itemCode	varchar2	Item Code	☐
lastModifiedDateTime	datetime	Last Modified	☐	System generated information
location_description	varchar2	Location Description	☐	Click on the magnifier. > The description.
location_id	varchar2	Location ID	☐	Click on the magnifier. > The identifier.
pendingRecurring	double		☐
pendingRenewal	double		☐
pendingSetup	double		☐
promoCode_description	varchar2		☐	Click on the magnifier. > The description.
promoCode_id	varchar2		☐	Click on the magnifier. > The identifier.
recurringDiscount	double		☐
recurringPrice	double		☐
renewalDiscount	double		☐
renewalPrice	double		☐
setupDiscount	double		☐
setupPrice	double		☐
status	varchar2	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	varchar2		☐	Name of item/description
summary_caseCountItem_number	varchar2		☐	Number of item
summary_currency	varchar2	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	varchar2		☐	Click the magnifier. > The name.
summary_invoiceAccount_number	varchar2		☐
summary_invoiceLocation_description	varchar2		☐	Click on the magnifier. > The description.
summary_invoiceLocation_id	varchar2		☐	Click on the magnifier. > The identifier.
summary_invoiceTo	varchar2		☐	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	varchar2		☐	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	char		☐	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	varchar2		☐
summary_owner_name	varchar2		☐	The name of the particular destination of the selected type.
summary_owner_number	varchar2		☐	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	varchar2		☐	Click on the magnifier. > The description.
summary_salesPerson_id	varchar2		☐	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.
timeStamp	blob	Timestamp	☐	Identifier that represents a specific version of the resource.It helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)
totalPending	double	Total Pending	☐

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.

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

CustomerContractDetailsLines: Visma.net Financials Customer Contract Details Lines

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information