TDV Adapter for Zoho CRM

Build 21.0.8137

Invoices

Create, update, delete, and query information regarding invoices. Not available in free and standard ZohoCRM accounts.

Table-Specific Information

Select

The adapter will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the adapter.

  • InvoiceNumber supports the '=, LIKE' operators.
  • Subject supports the '=, LIKE' operators.
  • InvoiceDate supports the '=' operator.
  • PurchaseOrder supports the '=, LIKE' operators.
  • DueDate supports the '=' operator.
  • CreatedTime supports the '=' operator.
  • ModifiedTime supports the '=' operator.
  • BillingStreet supports the '=, LIKE' operators.
  • ShippingStreet supports the '=, LIKE' operators.
  • BillingCity supports the '=, LIKE' operators.
  • ShippingCity supports the '=, LIKE' operators.
  • BillingState supports the '=, LIKE' operators.
  • ShippingState supports the '=, LIKE' operators.
  • BillingCode supports the '=, LIKE' operators.
  • ShippingCode supports the '=, LIKE' operators.
  • BillingCountry supports the '=, LIKE' operators.
  • ShippingCountry supports the '=, LIKE' operators.
  • TermsandConditions supports the '=, LIKE' operators.
  • Description supports the '=, LIKE' operators.

For example, the following queries are processed server side:

SELECT * FROM Invoices WHERE Id = '3152079000000153079'

SELECT * FROM Invoices WHERE BillingCity = 'Sioux Falls'

Insert


INSERT INTO Invoices (Status, DueDate, Subject) VALUES ('Created', '2018/06/06', 'An invoice for the purchase of products XYZ.')

INSERT INTO Invoices (Status, DueDate, Subject, ProductDetails) VALUES ('Created', '2018/06/06', 'An invoice for the purchase of products XYZ.', '[
            { 
              "product": { 
                "Product_Code": "12342321", 
                "name": "Egg", 
                "id": "3276571000000184076" 
              }, 
              "quantity": 1024, 
              "Discount": 0, 
              "total_after_discount": 1239.04, 
              "net_total": 1239.04, 
              "book": null, 
              "Tax": 0, 
              "list_price": 1.21, 
              "unit_price": 1.21, 
              "quantity_in_stock": -1024, 
              "total": 1239.04, 
              "id": "3276571000000184104", 
              "product_description": null, 
              "line_tax": [] 
            } 
          ]')

Required fields: None.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Invoices WHERE Id = '3152079000000153079'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Invoices SET Description = 'Updated from API' WHERE Id = '3152079000000153079'

Required fields: Id.

Any field which is not read-only (ReadOnly = false in the table below) can be updated.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier for this record.

InvoiceOwner_Id String False

The Id of the owner of this invoice.

InvoiceOwner_Name String True

The name of the owner of this invoice.

InvoiceNumber String False

The number of this invoice.

Subject String False

The subject of this invoice.

SalesOrder_Id String False

The Id of the sales order linked to this invoice.

SalesOrder_Name String True

The name of the sales order linked to this invoice.

InvoiceDate Date False

The date listed in the invoice.

PurchaseOrder String False

The purchase order linked with this invoice.

DueDate Date False

The date when this invoice is due at.

ExciseDuty Double False

The amount of excise duty for this invoice.

SalesCommission Double False

The amount of sales commission for this invoice.

Status String False

The status of the invoice.

AccountName_Id String False

The Id of the account linked with this invoice.

AccountName_Name String True

The name of the account linked with this invoice.

CreatedBy_Id String False

The Id of the User who created the record.

CreatedBy_Name String True

The name of the user who created the record.

ContactName_Id String False

The Id of the contact linked with this invoice.

ContactName_Name String True

The name of the contact linked with this invoice.

ModifiedBy_Id String False

The Id of the User who modified the record.

ModifiedBy_Name String True

The name of the User who modified the record.

CreatedTime Datetime False

The time when the record was created.

ModifiedTime Datetime False

The time when the record was modified.

Tag String False

A list of tags related to this invoice.

BillingStreet String False

The billing street of the invoice.

ShippingStreet String False

The shipping street of the invoice.

BillingCity String False

The billing city of the invoice.

ShippingCity String False

The shipping city of the invoice.

BillingState String False

The billing state of the invoice.

ShippingState String False

The shipping state of the invoice.

BillingCode String False

The billing code of the invoice.

ShippingCode String False

The shipping code of the invoice.

BillingCountry String False

The billing country of the invoice.

ShippingCountry String False

The shippingcountry of the invoice.

ProductDetails String False

A json aggregate of the product details for this invoice.

SubTotal Double True

The subtotal of this invoice.

Discount Double False

The discount applied to this invoice.

Tax Double True

The tax applied to this invoice.

Adjustment Double False

The adjustment applied to this invoice.

GrandTotal Double True

The grand total of this invoice.

TermsandConditions String False

The terms and conditions of this invoice.

Description String False

The description of this invoice.

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
Word String

Used to search for a specific word in records.

DuplicateCheckFields String

The field/s to be used for checking in an upsert.

Converted Boolean

Set to true to return only converted records.

Approved Boolean

Set to true to return only approved records.

CustomViewId String

The custom view Id to be used for filtering this record.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137