CustomerContractDetailsLines: Visma.net Financials Customer Contract Details Lines
read only REST
- Catalog:
VismaNet - Schema:
CustomerContract - Label: Customer Contract Details Lines
Get a range of Customer Contracts, a filter needs to be specified - ScreenId=CT301000
Can only retrieve data.
API Source
- Endpoint:
/v1/customerContract - Operation:
get /v1/customerContract
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 155 |
| Full scan rows per minute | 29,100 |
| Point query rows per minute | 387 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
attributes |
`` | Attributes (additional information) connected to the entity. Examples: {{base}}/customerContract?attributes={"AttributeID":"ValueID","AttributeID":"ValueID"} {{base}}/customerContract?attributes={"AttributeID":"ValueID1,ValueID2"} | ||
contract |
`` | |||
customer |
`` | |||
expand |
`` | |||
expand |
`` | |||
expand |
`` | |||
greater |
`` | |||
last |
`` | |||
last |
`` | |||
status |
`` | Values: Draft, InApproval, Active, Expired, Canceled, Completed, InUpgrade, PendingActivation. |
Table Columns
The columns of the table CustomerContractDetailsLines 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 and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
COMPANY_ |
varchar2 |
Company Code | writable | Partition code, segmenting the data. | |
COMPANY_ |
varchar2 |
Company Name | writable | Name of the partition. | |
balance |
double |
Balance | filters on the platform, writable, ::ancestor. |
The top part > Balance > A read-only field that displays the sum of the balances of open invoices associated with the contract. | |
contract |
int32 |
itgen_vnet_contractdetailid | writable, contract |
||
contract |
varchar2 |
Contract ID | filters on the platform, writable, ::ancestor. |
Mandatory field: The top part > Contract ID* > The unique identifier of a contract. | |
contract |
varchar2 |
Contract Template Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
contract |
varchar2 |
Contract Template ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
current |
double |
itgen_vnet_currentrecurring | writable, ::ancestor. |
||
current |
double |
itgen_vnet_currentrenewal | writable, ::ancestor. |
||
current |
double |
itgen_vnet_currentsetup | writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Name | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The name. | |
customer_ |
varchar2 |
Customer Number | filters on the platform, writable, ::ancestor. |
||
description |
varchar2 |
Description | writable, description |
||
description_ |
varchar2 |
Description 2 | filters on the platform, writable, ::ancestor. |
Mandatory field: The top part > Description* > The description of the contract, which includes any related comments. | |
difference |
double |
Difference | writable, difference |
||
effective |
datetime |
Effective from | writable, ::ancestor. |
||
extra |
double |
itgen_vnet_extrausageprice | writable, extra |
||
included |
double |
Included | writable, included |
||
invoice |
varchar2 |
itgen_vnet_invoicetype | writable, invoice |
||
item |
varchar2 |
Item Code | writable, item |
||
last |
datetime |
Last Modified | filters on the platform, writable, ::ancestor. |
System generated information | |
location_ |
varchar2 |
Location Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
location_ |
varchar2 |
Location ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
pending |
double |
itgen_vnet_pendingrecurring | writable, ::ancestor. |
||
pending |
double |
itgen_vnet_pendingrenewal | writable, ::ancestor. |
||
pending |
double |
itgen_vnet_pendingsetup | writable, ::ancestor. |
||
promo |
varchar2 |
itgen_vnet_promocode_description | writable, ::ancestor. |
Click on the magnifier. > The description. | |
promo |
varchar2 |
itgen_vnet_promocode_id | writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
recurring |
double |
itgen_vnet_recurringdiscount | writable, recurring |
||
recurring |
double |
itgen_vnet_recurringprice | writable, recurring |
||
renewal |
double |
itgen_vnet_renewaldiscount | writable, renewal |
||
renewal |
double |
itgen_vnet_renewalprice | writable, renewal |
||
setup |
double |
itgen_vnet_setupdiscount | writable, setup |
||
setup |
double |
itgen_vnet_setupprice | writable, setup |
||
status |
varchar2 |
Status | filters on the platform, writable, ::ancestor. |
The top part > Status > The status of the contract, which is one of the following: Draft, Pending activation, Active, Expired, Cancelled, Pending update. | |
summary_ |
datetime |
Activation Date | filters on the platform, writable, ::ancestor. |
Contract settings section > Activation date > The date to initiate the provision of the contract services. | |
summary_ |
varchar2 |
itgen_vnet_summary_casecountitem_description | filters on the platform, writable, ::ancestor. |
Name of item/description | |
summary_ |
varchar2 |
itgen_vnet_summary_casecountitem_number | filters on the platform, writable, ::ancestor. |
Number of item | |
summary_ |
varchar2 |
Currency | filters on the platform, writable, ::ancestor. |
Mandatory field: Contract settings section > Currency* > The currency used in the contract. | |
summary_ |
datetime |
Expiration Date | filters on the platform, writable, ::ancestor. |
Contract settings section > Expiration date > The date when the contract expires. | |
summary_ |
int32 |
Grace Period | filters on the platform, writable, ::ancestor. |
Contract settings section > Grace period > The number of days after the expiration date where the contract can still be renewed. | |
summary_ |
varchar2 |
itgen_vnet_summary_invoiceaccount_name | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The name. | |
summary_ |
varchar2 |
itgen_vnet_summary_invoiceaccount_number | filters on the platform, writable, ::ancestor. |
||
summary_ |
varchar2 |
itgen_vnet_summary_invoicelocation_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
summary_ |
varchar2 |
itgen_vnet_summary_invoicelocation_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
summary_ |
varchar2 |
itgen_vnet_summary_invoiceto | filters on the platform, writable, ::ancestor. |
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_ |
varchar2 |
itgen_vnet_summary_invoicingperiod | filters on the platform, writable, ::ancestor. |
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_ |
datetime |
itgen_vnet_summary_invoicingschedulestartson | filters on the platform, writable, ::ancestor. |
Invoicing schedule section > Invoice schedule starts on > A read-only field that displays the start date of the first invoicing period. | |
summary_ |
datetime |
itgen_vnet_summary_lastinvoicingdate | filters on the platform, writable, ::ancestor. |
Invoicing schedule section > Last invoicing date > A read-only field that shows the date when the invoicing was performed most recently. | |
summary_ |
char |
itgen_vnet_summary_massrenewal | filters on the platform, writable, ::ancestor. |
Contract settings section > Mass renewal > A check box indicating renewal of all contract at expiration date. | |
summary_ |
datetime |
itgen_vnet_summary_nextinvoicingdate | filters on the platform, writable, ::ancestor. |
Invoicing schedule section > Next invoicing date > The date of the next invoicing invoice, according to the invoicing schedule. | |
summary_ |
varchar2 |
itgen_vnet_summary_owner_internalid | filters on the platform, writable, ::ancestor. |
||
summary_ |
varchar2 |
itgen_vnet_summary_owner_name | filters on the platform, writable, ::ancestor. |
The name of the particular destination of the selected type. | |
summary_ |
varchar2 |
itgen_vnet_summary_owner_number | filters on the platform, writable, ::ancestor. |
The identifier of the particular destination of the selected type. | |
summary_ |
int32 |
itgen_vnet_summary_renewalpoint | filters on the platform, writable, ::ancestor. |
Contract settings section > Renewal point > The number of days before expiration where the renewal process are to begin. | |
summary_ |
varchar2 |
itgen_vnet_summary_salesperson_description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
summary_ |
varchar2 |
itgen_vnet_summary_salesperson_id | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
summary_ |
datetime |
itgen_vnet_summary_setupdate | filters on the platform, writable, ::ancestor. |
Mandatory field: Contract settings section > Setup date* > The date of contract setup. | |
summary_ |
datetime |
itgen_vnet_summary_terminationdate | filters on the platform, writable, ::ancestor. |
Contract settings section > Termination date > The date when the contract will be cancelled; no services will be provided. | |
time |
blob |
Timestamp | filters on the platform, writable, ::ancestor. |
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) | |
total |
double |
Total Pending | writable, ::ancestor. |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Customer |
customer_ |
Customers. |
Key |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: