ContractsById |
Catalog: Autotask
Schema: Contracts
This is a read-only table function. The Autotask API may not support changing the data or the Invantive UniversalSQL driver for Autotask does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Autotask API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function ContractsById. 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 evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `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 |
---|---|---|---|---|
id |
int64 |
☑ |
|
|
Columns of Table Function
The columns of the table function ContractsById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
billingPreference |
int32 |
Billing Preference |
☐ |
|
billToCompanyContactID |
int32 |
Bill-to Company Contact ID |
☐ |
|
billToCompanyID |
int32 |
Bill-to Company ID |
☐ |
|
companyID |
int32 |
Company ID |
☐ |
|
contactID |
int32 |
Contact ID |
☐ |
|
contactName |
string |
Contact Name |
☐ |
|
contractCategory |
int32 |
Contract Category |
☐ |
|
contractExclusionSetID |
int32 |
Contract Exclusion Set ID |
☐ |
|
contractName |
string |
Contract Name |
☐ |
|
contractNumber |
string |
Contract Number |
☐ |
|
contractPeriodType |
int32 |
Contract Period Type |
☐ |
|
contractType |
int32 |
Contract Type |
☐ |
|
description |
string |
Description |
☐ |
|
endDate |
datetime |
End Date |
☐ |
|
estimatedCost |
double |
Estimated Cost |
☐ |
|
estimatedHours |
double |
Estimated Hours |
☐ |
|
estimatedRevenue |
double |
Estimated Revenue |
☐ |
|
exclusionContractID |
int64 |
Exclusion Contract ID |
☐ |
|
id |
int64 |
ID |
☐ |
|
internalCurrencyOverageBillingRate |
double |
Internal Currency Overage Billing Rate |
☐ |
|
internalCurrencySetupFee |
double |
Internal Currency Setup Fee |
☐ |
|
isCompliant |
boolean |
Is Compliant |
☐ |
|
isDefaultContract |
boolean |
Is Default Contract |
☐ |
|
opportunityID |
int32 |
Opportunity ID |
☐ |
|
organizationalLevelAssociationID |
int32 |
Organizational Level Association ID |
☐ |
|
overageBillingRate |
double |
Overage Billing Rate |
☐ |
|
purchaseOrderNumber |
string |
Purchase Order Number |
☐ |
|
renewedContractID |
int64 |
Renewed Contract ID |
☐ |
|
serviceLevelAgreementID |
int32 |
Service Level Agreement ID |
☐ |
|
setupFee |
double |
Setup Fee |
☐ |
|
setupFeeBillingCodeID |
int64 |
Setup Fee Billing Code ID |
☐ |
|
startDate |
datetime |
Start Date |
☐ |
|
status |
int32 |
Status |
☐ |
|
timeReportingRequiresStartAndStopTimes |
int32 |
Time Reporting Requires Start and Stop Times |
☐ |
|
10-06-2024 18:39 Version 24.1.3-BETA+4689