JDBC Driver for SuiteCRM

Build 22.0.8462

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 [Contract Value] < 20000 

Insert

Create a Contract by specifying any writable column.

INSERT INTO Contracts ([Contract Title],[Contract Value],Discount) VALUES ('Sokovia Contract',45000,3)

Update

You can update any Contract column that is writable, by specifying the Id.

UPDATE Contracts SET Currency = 'GBP' 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.

Account String False

Account opened for the contract

AssignedUserId String True

The Id of the contract manager.

ContractManager String False

Name of the account manager

Call_ID String False

Id of the call linked to the contract

CompanySignedDate Date False

Date the company signed the contract

Contact String True

Name of the contact linked to the account

Contact_Id String False

Id of the contact linked to the account

ContractTitle String False

Title given to the contract

ContractType String False

Type of the contract

ContractValue Double False

Value of the contract

ContractValue(DefaultCurrency) Double False

Value of the contract calculated in the system's default currency

Contract_Account_Id String True

Id of the Account linked to the contract

CreatedById String True

The Id of the user who created the record.

CreatedByName String True

The name of the user who created the record.

Currency String False

Id of the currency used in the contract

CustomerSignedDate Date False

Date the customer signed the contract

DateCreated Datetime True

The date the record was created.

DateModified Datetime True

The date the record was last modified.

Deleted Bool False

The record deletion indicator.

Description String False

Description for the contract

Discount Double False

Discount value for the account

Discount(DefaultCurrency) Double False

Discount value for the account in the system's default currency

EndDate Date False

Date until the contract expires

GrandTotal Double False

Grand total of the account

GrandTotal(DefaultCurrency) Double False

Grand total of the account in the system's currency

LineItems String True

Line items of the contract

ModifiedById String True

The Id of the user who last modified the record.

ModifiedByName String True

The name of the user who last modified the record.

Opportunity String True

Name of the opportunity linked to the contract

Opportunity_Id String False

Id of the opportunity linked to the contract

ReferenceCode String False

Reference code of the contract

RenewalReminderDate Datetime False

Date to remind for the contract renewal

Shipping Double False

Shipping costs of the contract

Shipping(DefaultCurrency) Double False

Shipping costs of the contract in the system's default currency

ShippingTax String False

Shipping tax costs

ShippingTax(DefaultCurrency) Double False

Shipping tax costs in the system's default currency

ShippingTaxAmount Double False

Amount of the shipping tax

StartDate Date False

Date the contract is valid from

Status String False

Status of the contract

Subtotal Double False

Subtotal amount

Subtotal(DefaultCurrency) Double False

Subtotal amount in the system's default currency

Tax Double False

Tax costs

Tax(DefaultCurrency) Double False

Tax costs in the system's default currency

Total Double False

Total value of the contract

Total(DefaultCurrency) Double False

Total value of the contract in the system's default currency

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462