CustomerContractSummaryByContractId2: Visma.net Financials Customer Contract Summaries by Contract ID
read only REST
- Catalog:
VismaNet - Schema:
CustomerContract - Label: Customer Contract Summaries by Contract ID
Get a specific Customer Contract Summary
Can only retrieve data.
API Source
- Endpoint:
/v1/customerContract/{contractId}/summary - Operation:
get /v1/customerContract/{contractId}/summary
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 |
|---|---|---|---|---|
contract |
`` | Identifies the customer contract |
Table Columns
The columns of the table CustomerContractSummaryByContractId2 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. | |
activation |
datetime |
Activation Date | filters on the platform, writable, activation |
Contract settings section > Activation date > The date to initiate the provision of the contract services. | |
case |
varchar2 |
Case Count Item Description | filters on the platform, writable, case |
Name of item/description | |
case |
varchar2 |
Case Count Item Number | filters on the platform, writable, case |
Number of item | |
currency |
varchar2 |
Currency | filters on the platform, writable, currency |
Mandatory field: Contract settings section > Currency* > The currency used in the contract. | |
expiration |
datetime |
Expiration Date | filters on the platform, writable, expiration |
Contract settings section > Expiration date > The date when the contract expires. | |
grace |
int32 |
Grace Period | filters on the platform, writable, grace |
Contract settings section > Grace period > The number of days after the expiration date where the contract can still be renewed. | |
invoice |
varchar2 |
itgen_vnet_invoiceaccount_name | filters on the platform, writable, invoice |
Click the magnifier. > The name. | |
invoice |
varchar2 |
itgen_vnet_invoiceaccount_number | filters on the platform, writable, invoice |
||
invoice |
varchar2 |
itgen_vnet_invoicelocation_description | filters on the platform, writable, invoice |
Click on the magnifier. > The description. | |
invoice |
varchar2 |
itgen_vnet_invoicelocation_id | filters on the platform, writable, invoice |
Click on the magnifier. > The identifier. | |
invoice |
varchar2 |
Invoice To | filters on the platform, writable, invoice |
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. | |
invoicing |
varchar2 |
Invoicing Period | filters on the platform, writable, invoicing |
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. | |
invoicing |
datetime |
itgen_vnet_invoicingschedulestartson | filters on the platform, writable, invoicing |
Invoicing schedule section > Invoice schedule starts on > A read-only field that displays the start date of the first invoicing period. | |
last |
datetime |
Last Invoicing Date | filters on the platform, writable, last |
Invoicing schedule section > Last invoicing date > A read-only field that shows the date when the invoicing was performed most recently. | |
mass |
char |
Mass Renewal | filters on the platform, writable, mass |
Contract settings section > Mass renewal > A check box indicating renewal of all contract at expiration date. | |
next |
datetime |
Next Invoicing Date | filters on the platform, writable, next |
Invoicing schedule section > Next invoicing date > The date of the next invoicing invoice, according to the invoicing schedule. | |
owner_ |
varchar2 |
Owner Internal ID | filters on the platform, writable, owner. |
||
owner_ |
varchar2 |
Owner Name | filters on the platform, writable, owner. |
The name of the particular destination of the selected type. | |
owner_ |
varchar2 |
Owner Number | filters on the platform, writable, owner. |
The identifier of the particular destination of the selected type. | |
renewal |
int32 |
Renewal Point | filters on the platform, writable, renewal |
Contract settings section > Renewal point > The number of days before expiration where the renewal process are to begin. | |
sales |
varchar2 |
Sales Person Description | filters on the platform, writable, sales |
Click on the magnifier. > The description. | |
sales |
varchar2 |
Sales Person ID | filters on the platform, writable, sales |
Click on the magnifier. > The identifier. | |
setup |
datetime |
itgen_vnet_setupdate | filters on the platform, writable, setup |
Mandatory field: Contract settings section > Setup date* > The date of contract setup. | |
termination |
datetime |
Termination Date | filters on the platform, writable, termination |
Contract settings section > Termination date > The date when the contract will be cancelled; no services will be provided. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: