Contracts
Subcategories: Account Contracts, Contract Messages, Attachments, Notes
The contracts resource is used to view, create, update, replace, and delete contract details.
|
Resource Plural Label |
Contracts |
|
Resource Name |
__ORACO__CGContract_c |
Get All Contracts
Request: GET
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a contract with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Contract
Request: POST
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Contract
Request: POST
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c
Request Path Parameters
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
This table summarizes the request path parameters:
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Contract
Request: GET
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Contract
Request: PATCH
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Contract
Request: DELETE
URI: /crmRestApi/resources/<version>/__ORACO__CGContract_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the contract. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
FK_LOVVA_For___ORACO__PrimaryAccount_c |
OrganizationProfileId |
__ORACO__PrimaryAccount_Id_c |
|
LOVVA_For___ORACO__PrimaryAccount_c |
OrganizationName |
__ORACO__PrimaryAccount_c |
|
LOVVA_For___ORACO__Renewable_c |
value |
__ORACO__Renewable_c |
|
LOVVA_For___ORACO__Status_c |
LookupCode |
__ORACO__Status_c |
|
LOVVA_For___ORACO__SettlementFrequency_c |
LookupCode |
__ORACO__SettlementFrequency_c |
|
FK_LOVVA_For___ORACO__OraZcxOwner_c |
ResourceProfileId |
__ORACO__OraZcxOwner_Id_c |
|
LOVVA_For___ORACO__OraZcxOwner_c |
PartyName |
__ORACO__OraZcxOwner_c |
|
FK_LOVVA_For___ORACO__ContractTemplate_c |
Id |
__ORACO__ContractTemplate_Id_c |
|
LOVVA_For___ORACO__ContractTemplate_c |
RecordName |
__ORACO__ContractTemplate_c |
|
LOVVA_For___ORACO__Initiative_c |
LookupCode |
__ORACO__Initiative_c |
|
LOVVA_For___ORACO__DefaultCompliance_c |
LookupCode |
__ORACO__DefaultCompliance_c |
|
FK_LOVVA_For___ORACO__PrintTemplate_c |
Id |
__ORACO__PrintTemplate_Id_c |
|
LOVVA_For___ORACO__PrintTemplate_c |
RecordName |
__ORACO__PrintTemplate_c |
|
LOVVA_For_Test_c |
value |
Test_c |
|
LOVVA_For_DownloadToMobile_c |
value |
DownloadToMobile_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
number |
The unique identifier of the contract. UI Label: Record ID |
|
RecordName |
string |
The name of the contract. Properties: The maximum length is 80. UI Label: Contract Name |
|
CreatedBy |
string |
The user who created the contract. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the contract was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the contract. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the contract was last updated. UI Label: Last Update Date |
|
RecordNumber |
string |
The alternate key identifier of the contract. Properties: The maximum length is 64. UI Label: Record Number |
|
LastUpdateLogin |
string |
The login of the user who last updated the contract. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time of the last user update made from a personal device. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (a different mobile database or the server). |
|
CurrencyCode |
string |
The currency code associated with the contract. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. UI Label: Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the contract. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
__ORACO__PrimaryAccount_Id_c |
number |
The unique identifier of the primary account against which the contract is created. UI Label: Primary Account |
|
__ORACO__PrimaryAccount_c |
string |
The name of the primary account against which the contract is created. Properties: The maximum length is 1500. UI Label: Primary Account |
|
__ORACO__StartDate_c |
date |
The date when the contract will become effective. UI Label: Start Date |
|
__ORACO__EndDate_c |
date |
The date when the contract will expire. UI Label: End Date |
|
__ORACO__Renewable_c |
boolean |
Indicates whether the contract is renewable or not. Properties: The maximum length is 10. UI Label: Renewable |
|
__ORACO__RenewableDate_c |
date |
The date when the contract can be renewed. UI Label: Renewable Date |
|
__ORACO__DateApproved_c |
date |
The date when the contract was approved. UI Label: Approved Date |
|
__ORACO__Description_c |
string |
A brief description of the contract. Properties: The maximum length is 1500. UI Label: Description |
|
__ORACO__Currency_c |
number |
The currency code used by the contract. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. UI Label: Currency(Obsolete) |
|
__ORACO__Status_c |
string |
The status of the contract. Properties: The maximum length is 1500. UI Label: Status |
|
__ORACO__SelectedRow |
string |
A field used for internal logic. UI Label: SelectedRow |
|
__ORACO__SettlementFrequency_c |
string |
The frequency at which the settlement records must get created for the contract. Properties: The maximum length is 1500. UI Label: Settlement Schedule Frequency |
|
__ORACO__SettlementStartDate_c |
date |
The date when the settlement creation begins. UI Label: Settlement Schedule Start Date |
|
__ORACO__SettlementEndDate_c |
date |
The date when the settlement creation ends. UI Label: Settlement Schedule End Date |
|
__ORACO__OraZcxOwner_Id_c |
number |
The unique identifier of the resource. UI Label: Owner |
|
__ORACO__OraZcxOwner_c |
string |
The name of the resource. Properties: The maximum length is 1500. UI Label: Owner |
|
__ORACO__ContractTemplate_Id_c |
number |
The unique identifier of the contract template. UI Label: Contract Template |
|
__ORACO__ContractTemplate_c |
string |
The name of the contract template. Properties: The maximum length is 1500. UI Label: Contract Template |
|
__ORACO__SettlementScheduleInterval_c |
integer |
The schedule interval for the settlement frequency. UI Label: Settlement Schedule Interval |
|
__ORACO__ContractValue_c |
number |
The calculated value of the contract based on benefits. UI Label: Contract Value |
|
__ORACO__ContractForecastValue_c |
number |
The calculated forecast value of the contract based on benefits. UI Label: Contract Forecast Value |
|
__ORACO__Source_c |
string |
The source from which the record is created. Properties: The maximum length is 80. UI Label: Source |
|
__ORACO__Initiative_c |
string |
The type of initiative, such as contract or promotion. Properties: The maximum length is 1500. UI Label: Initiative |
|
__ORACO__DefaultCompliance_c |
string |
The default compliance for a benefit Properties: The maximum length is 1500. UI Label: Default Compliance |
|
__ORACO__PrintTemplate_Id_c |
number |
The unique identifier of the print template. UI Label: Print Template |
|
__ORACO__PrintTemplate_c |
string |
The name of the print template. Properties: The maximum length is 1500. UI Label: Print Template |