Contracts
Create, update, delete, and query contracts in SuiteCRM
Table Specific Information
Select
You can query the Contracts table using any criteria in the WHERE clause. The driver will use the SuiteCRM API to filter the results.
SELECT * FROM Contracts WHERE Name = 'test'
Insert
Create a Contract by specifying any writable column.
INSERT INTO Contracts (Id, Name) VALUES ('id', 'Energy')
Update
You can update any Contract column that is writable, by specifying the Id.
UPDATE Contracts SET Name = 'new name', Description = 'Desc' WHERE Id = 'Test123'
Delete
Delete a Contract by specifying the Id.
DELETE FROM Contracts WHERE Id = 10003
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier of the contract. |
Name | String | False |
|
DateEntered | Datetime | False |
The date the record was created. |
DateModified | Datetime | False |
The date the record was last modified. |
ModifiedUserId | String | False |
The Id of the user who last modified the record. |
ModifiedByName | String | True |
The name of the user who last modified the record. |
CreatedBy | String | False |
The Id of the user who created the record. |
CreatedByName | String | True |
The name of the user who created the record. |
Description | String | False |
Description for the contract |
Deleted | Bool | False |
The record deletion indicator. |
CreatedByLink | String | True |
Link to the record who created it |
ModifiedUserLink | String | True |
Link to the record who modified it. |
AssignedUserId | String | False |
The Id of the contract manager. |
AssignedUserName | String | True |
|
AssignedUserLink | String | True |
Link to the user which the record has been assigned to |
SecurityGroups | String | True |
The security group associated with the record. |
ReferenceCode | String | False |
Reference code of the contract |
StartDate | String | False |
Date the contract is valid from |
EndDate | String | False |
Date until the contract expires |
TotalContractValue | String | False |
|
TotalContractValueUsdollar | String | False |
|
CurrencyId | String | False |
|
Status | String | False |
The status of the record. |
CustomerSignedDate | String | False |
Date the customer signed the contract |
CompanySignedDate | String | False |
Date the company signed the contract |
RenewalReminderDate | Datetime | False |
Date to remind for the contract renewal |
ContractType | String | False |
Type of the contract |
ContractAccountId | String | False |
Id of the Account linked to the contract |
ContractAccount | String | True |
|
OpportunityId | String | False |
Id of the opportunity linked to the contract |
Opportunity | String | True |
Name of the opportunity linked to the contract |
ContactId | String | False |
Id of the contact linked to the account |
Contact | String | True |
Name of the contact linked to the account |
CallId | String | False |
Id of the call linked to the contract |
LineItems | String | False |
Line items of the contract |
TotalAmt | String | False |
|
TotalAmtUsdollar | String | False |
|
SubtotalAmount | String | False |
|
SubtotalAmountUsdollar | String | False |
|
DiscountAmount | String | False |
|
DiscountAmountUsdollar | String | False |
|
TaxAmount | String | False |
|
TaxAmountUsdollar | String | False |
|
ShippingAmount | String | False |
|
ShippingAmountUsdollar | String | False |
|
ShippingTax | String | False |
Shipping tax costs |
ShippingTaxAmt | String | False |
|
ShippingTaxAmtUsdollar | String | False |
|
TotalAmount | String | False |
|
TotalAmountUsdollar | String | False |
|
Accounts | String | True |
The accounts associated with the record |
Contacts | String | True |
The contacts associated with the record |
Tasks | String | True |
The tasks associated with the record. |
Notes | String | True |
The notes associated with the record. |
Meetings | String | True |
The meetings associated with the record. |
Calls | String | True |
The calls associated with the record |
Emails | String | True |
The emails associated with the record |
AosQuotesAosContracts | String | True |
|
Documents | String | True |
The documents associated with the record. |
AosProductsQuotes | String | True |
|
AosLineItemGroups | String | True |
|