JDBC Driver for SuiteCRM

Build 22.0.8462

Invoices

Create, update, delete, and query the invoices saved in the SuiteCRM

Table Specific Information

Select

You can query the Invoices table using any criteria in the WHERE clause. The driver will use the SuiteCRM API to filter the results.

SELECT * FROM Invoices WHERE [Grand Total] < 3200

Insert

Create an Invoice by specifying any writable column.

INSERT INTO Invoices (Title,Account,Tax,[Due Date]) VALUES ('Major purchase','BillingAccount Of Employee',20,'2017-04-07')

Update

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

UPDATE Invoices SET Shipping = 140 WHERE Id = 'Test123' 

Delete

Delete an Invoice by specifying the Id.

DELETE FROM Invoices WHERE Id = '10003'

Columns

Name Type ReadOnly Description
ID [KEY] String False

The unique identifier of the invoice.

Account String True

Billing account for the invoice

Assignedto String True

The user name of the user assigned to the record.

AssignedUserId String False

The Id of the user assigned to the record.

BillingCity String False

City where the billing account is recorded in

BillingCountry String False

Country where the billing account is recorded in

BillingPostalCode String False

Postal code of the billing account

BillingState String False

State where the billing account is recorded in

BillingStreet String False

Street where the billing account is recorded in

billing_account_id String False

Id of the billing account

billing_contact_id String False

Id of the billing contact

Contact String True

Name of the billing contact

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 for currency values

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 provided for the

Discount Double False

Discount amount of the invoice

LBL_DISCOUNT__AMOUNT_USDOLLAR Double False

Discount amount of the invoice in the system's default currency

DueDate Date False

Due date of the invoice

GrandTotal Double True

The invoice's grand total

GrandTotal(DefaultCurrency) Double True

The invoice's grand total in the system's default currency

InvoiceDate Date False

Date the invoice was issued

InvoiceNumber Int False

Number of the invoice

InvoiceTemplates String False

Template applying to the invoice

LineItems String True

The invoice's list of line items

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.

QuoteDate Date False

Date of the invoice quote

QuoteNumber Int False

Number of the invoice quote

Shipping Double False

Shipping costs

Shipping(DefaultCurrency) Double False

Shipping costs in the system's default currency

ShippingCity String False

City of the shipping destination

ShippingCountry String False

Country of the shipping destination

ShippingPostalCode String False

Postal Code of the shipping destination

ShippingState String False

State of the shipping destination

ShippingStreet String False

Address of the shipping destination

ShippingTax String False

Shipping tax costs

ShippingTax(DefaultCurrency) Double False

Shipping tax costs in the system's default currency

ShippingTaxAmount Double False

Amount of te shipping tax

Status String False

Status of the invoice

Subtotal Double True

Subtotal amount in the invoice

Subtotal(DefaultCurrency) Double True

Subtotal amount in the invoice in the system's default currency

Subtotal+Tax Double True

Subtotal and tax amount in the invoice

SubtotalTaxAmount Double True

Subtotal and tax amount in the invoice in the system's default currency

Tax Double False

Tax costs in the invoice

Tax(DefaultCurrency) Double False

Tax costs in the invoice in the system's default currency

Title String False

Title assigned to the invoice

Total Double True

Total amount in the invoice

Total(DefaultCurrency) Double True

Total amount in the invoice 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