invantive documentation
Invantive Support ForumsLog In / Sign Up

CustomerContactAttributesByContractId: Visma.net Financials Customer Contact Attributes by Contract ID

read only REST

  • Catalog: VismaNet
  • Schema: CustomerContract
  • Label: Customer Contact Attributes by Contract ID

Get a specific Customer Contract Data for the customer contract The response headers include an ETag after a successful GET operation.

Can only retrieve data.

Summary

Data for the customer contract

The response headers include an ETag after a successful GET operation.

API Source

  • Endpoint: /v1/customerContract/{contractId}
  • Operation: get /v1/customerContract/{contractId}

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 CustomerContactAttributesByContractId 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.
balance double Balance filters on the platform, writable, ::ancestor.balance The top part > Balance > A read-only field that displays the sum of the balances of open invoices associated with the contract.
contractId varchar2 Contract ID filters on the platform, writable, ::ancestor.contractId Mandatory field: The top part > Contract ID* > The unique identifier of a contract.
contractTemplate_description varchar2 Contract Template Description filters on the platform, writable, ::ancestor.contractTemplate.description Click on the magnifier. > The description.
contractTemplate_id varchar2 Contract Template ID filters on the platform, writable, ::ancestor.contractTemplate.id Click on the magnifier. > The identifier.
customer_name varchar2 Customer Name filters on the platform, writable, ::ancestor.customer.name Click the magnifier. > The name.
customer_number varchar2 Customer Number filters on the platform, writable, ::ancestor.customer.number
description varchar2 Description writable, description Attribute > The description of the attribute.
description_2 varchar2 Description 2 filters on the platform, writable, ::ancestor.description Mandatory field: The top part > Description* > The description of the contract, which includes any related comments.
details_currentRecurring double itgen_vnet_details_currentrecurring filters on the platform, writable, ::ancestor.details.currentRecurring
details_currentRenewal double itgen_vnet_details_currentrenewal filters on the platform, writable, ::ancestor.details.currentRenewal
details_currentSetup double itgen_vnet_details_currentsetup filters on the platform, writable, ::ancestor.details.currentSetup
details_effectiveFrom datetime itgen_vnet_details_effectivefrom filters on the platform, writable, ::ancestor.details.effectiveFrom
details_pendingRecurring double itgen_vnet_details_pendingrecurring filters on the platform, writable, ::ancestor.details.pendingRecurring
details_pendingRenewal double itgen_vnet_details_pendingrenewal filters on the platform, writable, ::ancestor.details.pendingRenewal
details_pendingSetup double itgen_vnet_details_pendingsetup filters on the platform, writable, ::ancestor.details.pendingSetup
details_promoCode_description varchar2 itgen_vnet_details_promocode_description filters on the platform, writable, ::ancestor.details.promoCode.description Click on the magnifier. > The description.
details_promoCode_id varchar2 itgen_vnet_details_promocode_id filters on the platform, writable, ::ancestor.details.promoCode.id Click on the magnifier. > The identifier.
details_totalPending double Total Pending filters on the platform, writable, ::ancestor.details.totalPending
id varchar2 ID writable, id
lastModifiedDateTime datetime Last Modified filters on the platform, writable, ::ancestor.lastModifiedDateTime System generated information
location_description varchar2 Location Description filters on the platform, writable, ::ancestor.location.description Click on the magnifier. > The description.
location_id varchar2 Location ID filters on the platform, writable, ::ancestor.location.id Click on the magnifier. > The identifier.
status varchar2 Status filters on the platform, writable, ::ancestor.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 filters on the platform, writable, ::ancestor.summary.activationDate Contract settings section > Activation date > The date to initiate the provision of the contract services.
summary_caseCountItem_description varchar2 itgen_vnet_summary_casecountitem_description filters on the platform, writable, ::ancestor.summary.caseCountItem.description Name of item/description
summary_caseCountItem_number varchar2 itgen_vnet_summary_casecountitem_number filters on the platform, writable, ::ancestor.summary.caseCountItem.number Number of item
summary_currency varchar2 Currency filters on the platform, writable, ::ancestor.summary.currency Mandatory field: Contract settings section > Currency* > The currency used in the contract.
summary_expirationDate datetime Expiration Date filters on the platform, writable, ::ancestor.summary.expirationDate Contract settings section > Expiration date > The date when the contract expires.
summary_gracePeriod int32 Grace Period filters on the platform, writable, ::ancestor.summary.gracePeriod Contract settings section > Grace period > The number of days after the expiration date where the contract can still be renewed.
summary_invoiceAccount_name varchar2 itgen_vnet_summary_invoiceaccount_name filters on the platform, writable, ::ancestor.summary.invoiceAccount.name Click the magnifier. > The name.
summary_invoiceAccount_number varchar2 itgen_vnet_summary_invoiceaccount_number filters on the platform, writable, ::ancestor.summary.invoiceAccount.number
summary_invoiceLocation_description varchar2 itgen_vnet_summary_invoicelocation_description filters on the platform, writable, ::ancestor.summary.invoiceLocation.description Click on the magnifier. > The description.
summary_invoiceLocation_id varchar2 itgen_vnet_summary_invoicelocation_id filters on the platform, writable, ::ancestor.summary.invoiceLocation.id Click on the magnifier. > The identifier.
summary_invoiceTo varchar2 itgen_vnet_summary_invoiceto filters on the platform, writable, ::ancestor.summary.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.
summary_invoicingPeriod varchar2 itgen_vnet_summary_invoicingperiod filters on the platform, writable, ::ancestor.summary.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.
summary_invoicingScheduleStartsOn datetime itgen_vnet_summary_invoicingschedulestartson filters on the platform, writable, ::ancestor.summary.invoicingScheduleStartsOn Invoicing schedule section > Invoice schedule starts on > A read-only field that displays the start date of the first invoicing period.
summary_lastInvoicingDate datetime itgen_vnet_summary_lastinvoicingdate filters on the platform, writable, ::ancestor.summary.lastInvoicingDate Invoicing schedule section > Last invoicing date > A read-only field that shows the date when the invoicing was performed most recently.
summary_massRenewal char itgen_vnet_summary_massrenewal filters on the platform, writable, ::ancestor.summary.massRenewal Contract settings section > Mass renewal > A check box indicating renewal of all contract at expiration date.
summary_nextInvoicingDate datetime itgen_vnet_summary_nextinvoicingdate filters on the platform, writable, ::ancestor.summary.nextInvoicingDate Invoicing schedule section > Next invoicing date > The date of the next invoicing invoice, according to the invoicing schedule.
summary_owner_internalId varchar2 itgen_vnet_summary_owner_internalid filters on the platform, writable, ::ancestor.summary.owner.internalId
summary_owner_name varchar2 itgen_vnet_summary_owner_name filters on the platform, writable, ::ancestor.summary.owner.name The name of the particular destination of the selected type.
summary_owner_number varchar2 itgen_vnet_summary_owner_number filters on the platform, writable, ::ancestor.summary.owner.number The identifier of the particular destination of the selected type.
summary_renewalPoint int32 itgen_vnet_summary_renewalpoint filters on the platform, writable, ::ancestor.summary.renewalPoint Contract settings section > Renewal point > The number of days before expiration where the renewal process are to begin.
summary_salesPerson_description varchar2 itgen_vnet_summary_salesperson_description filters on the platform, writable, ::ancestor.summary.salesPerson.description Click on the magnifier. > The description.
summary_salesPerson_id varchar2 itgen_vnet_summary_salesperson_id filters on the platform, writable, ::ancestor.summary.salesPerson.id Click on the magnifier. > The identifier.
summary_setupDate datetime itgen_vnet_summary_setupdate filters on the platform, writable, ::ancestor.summary.setupDate Mandatory field: Contract settings section > Setup date* > The date of contract setup.
summary_terminationDate datetime itgen_vnet_summary_terminationdate filters on the platform, writable, ::ancestor.summary.terminationDate Contract settings section > Termination date > The date when the contract will be cancelled; no services will be provided.
timeStamp blob Timestamp filters on the platform, writable, ::ancestor.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)
value varchar2 Value writable, value Value > The value of the attribute.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: