invantive documentation
Invantive Support ForumsLog In / Sign Up

CustomerContractSummaryByContractId3: 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
contractId `` Identifies the customer contract

Table Columns

The columns of the table CustomerContractSummaryByContractId3 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_CODE varchar2(30) Company Code writable Partition code, segmenting the data.
COMPANY_NAME varchar2(240) Company Name writable Name of the partition.
activationDate datetime Activation Date filters on the platform, writable, activationDate Contract settings section > Activation date > The date to initiate the provision of the contract services.
caseCountItem_description varchar2 Case Count Item Description filters on the platform, writable, caseCountItem.description Name of item/description
caseCountItem_number varchar2 Case Count Item Number filters on the platform, writable, caseCountItem.number Number of item
currency varchar2 Currency filters on the platform, writable, currency Mandatory field: Contract settings section > Currency* > The currency used in the contract.
expirationDate datetime Expiration Date filters on the platform, writable, expirationDate Contract settings section > Expiration date > The date when the contract expires.
gracePeriod int32 Grace Period filters on the platform, writable, gracePeriod Contract settings section > Grace period > The number of days after the expiration date where the contract can still be renewed.
invoiceAccount_name varchar2 itgen_vnet_invoiceaccount_name filters on the platform, writable, invoiceAccount.name Click the magnifier. > The name.
invoiceAccount_number varchar2 itgen_vnet_invoiceaccount_number filters on the platform, writable, invoiceAccount.number
invoiceLocation_description varchar2 itgen_vnet_invoicelocation_description filters on the platform, writable, invoiceLocation.description Click on the magnifier. > The description.
invoiceLocation_id varchar2 itgen_vnet_invoicelocation_id filters on the platform, writable, invoiceLocation.id Click on the magnifier. > The identifier.
invoiceTo varchar2 Invoice To filters on the platform, writable, invoiceTo 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 varchar2 Invoicing Period filters on the platform, writable, invoicingPeriod 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 itgen_vnet_invoicingschedulestartson filters on the platform, writable, invoicingScheduleStartsOn 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 filters on the platform, writable, lastInvoicingDate Invoicing schedule section > Last invoicing date > A read-only field that shows the date when the invoicing was performed most recently.
massRenewal char Mass Renewal filters on the platform, writable, massRenewal Contract settings section > Mass renewal > A check box indicating renewal of all contract at expiration date.
nextInvoicingDate datetime Next Invoicing Date filters on the platform, writable, nextInvoicingDate Invoicing schedule section > Next invoicing date > The date of the next invoicing invoice, according to the invoicing schedule.
owner_internalId varchar2 Owner Internal ID filters on the platform, writable, owner.internalId
owner_name varchar2 Owner Name filters on the platform, writable, owner.name The name of the particular destination of the selected type.
owner_number varchar2 Owner Number filters on the platform, writable, owner.number The identifier of the particular destination of the selected type.
renewalPoint int32 Renewal Point filters on the platform, writable, renewalPoint Contract settings section > Renewal point > The number of days before expiration where the renewal process are to begin.
salesPerson_description varchar2 Sales Person Description filters on the platform, writable, salesPerson.description Click on the magnifier. > The description.
salesPerson_id varchar2 Sales Person ID filters on the platform, writable, salesPerson.id Click on the magnifier. > The identifier.
setupDate datetime itgen_vnet_setupdate filters on the platform, writable, setupDate Mandatory field: Contract settings section > Setup date* > The date of contract setup.
terminationDate datetime Termination Date filters on the platform, writable, terminationDate 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: