Get a specific Contract Usage
Catalog: VismaNet
Schema: ContractUsage
The data in this table is partitioned per value of the COMPANY_CODE column.
This is a read-only table function. The Visma.net API may not support changing the data or the Invantive SQL driver for Visma.net does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net API.
Select Visma.net API URL: /controller/api/v1/contractUsage/{contractId}
Insert Visma.net API URL: /controller/api/v1/contractUsage/{contractId}
Update Visma.net API URL: /controller/api/v1/contractUsage/{contractId}
Delete Visma.net API URL: /controller/api/v1/contractUsage/{contractId}
Field Selection Method: NotRequired
Base Path: transaction[*]
Select Visma.net API Operation: get /controller/api/v1/contractUsage/{contractId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function ContractUsageSpecificTransactionByContractId. 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 treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `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 |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
contractId |
string |
☑ |
|
Identify the Contract Usage |
Table Function Columns
The columns of the table function ContractUsageSpecificTransactionByContractId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
billed |
boolean |
Billed |
☐ |
Information indicating that the contract is collected from the Transaction history tab and the contract is invoiced. Not indicated on screen CT303000. |
billingDate |
datetime |
Billing Date |
☐ |
Transaction history tab > Invoicing date > The date when the invoice was issued. |
branch_name |
string |
Branch Name |
☐ |
Click the magnifier. > The name. |
branch_number |
string |
Branch Number |
☐ |
Click the magnifier. > The identifier. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
contract |
string |
Contract |
☐ |
|
date |
datetime |
Date |
☐ |
Mandatory field: Both tabs > Date* > The date of the activity, case, applied labour, or other usage (for the item). |
description |
string |
Description |
☐ |
Both tabs > Description > A description of the non-stock item. |
item_description |
string |
|
☐ |
Name of item/description |
item_number |
string |
|
☐ |
Number of item |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
A system generated date/time that indicates the last change for the document. |
lastModifiedDateTime_1 |
datetime |
|
☐ |
|
quantity |
double |
Quantity |
☐ |
Both tabs > Quantity > A number of units used for the item. |
referenceNbr |
string |
Reference Number |
☐ |
Transaction history tab > Ref. no. > The reference number of the document/invoice. |
transactionNumber |
int32 |
|
☐ |
|
type |
string |
Type |
☐ |
Transaction history tab > Type > The type of the customer ledger document. |
uom |
string |
Unit of Measure |
☐ |
Both tabs > UoM > The unit of measure used for the item. |
12-12-2020 18:42 Version 20.1.301-BETA+3023
