Invoices

Stores invoice records (such as billing address, totals, payment status, and line items) available only in paid Zoho CRM editions.

Table-Specific Information

Select

This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.

Insert

INSERT INTO Invoices (Subject, AccountName_Id, InvoicedItems) VALUES ('bulk2', '1021046000000427106', '[
  {
    "Product_Name": {
      "id": "1021046000000414457"
    },
    "Quantity": 1024,
    "Discount": 12,
    "Price_Book_Name": {
      "id": "1"
    },
    "Tax": 0,
    "List_Price": 1.21,
    "Description": "test desc"
  }
]');

Required fields for REST API: Subject, InvoicedItems.

Required fields for BULK API: Subject, InvoicedItems, AccountName_Id.

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

Please note that the REST API honors only the 'id' field of the 'Product_Name' aggregate in the InvoicedItems column. The BULK API does not accept any other field in this aggregate.

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	True	The unique identifier for the invoice.
InvoiceOwner_Id	String	False	The unique identifier of the user who owns the invoice.
InvoiceOwner_FirstName	String	True	The first name of the invoice owner.
InvoiceOwner_LastName	String	True	The last name of the invoice owner.
InvoiceOwner_Email	String	True	The email address of the invoice owner.
InvoiceOwner_Name	String	True	The full name of the invoice owner.
InvoiceNumber	String	True	The reference number assigned to the invoice.
Subject	String	False	The subject or title of the invoice.
SalesOrder_Id	String	False	The unique identifier of the related sales order.
SalesOrder_Name	String	True	The name of the related sales order.
InvoiceDate	Date	False	The date when the invoice was issued.
PurchaseOrder	String	False	The associated purchase order reference.
DueDate	Date	False	The date by which the invoice payment is due.
ExciseDuty	Decimal	False	The excise duty amount applicable to the invoice.
SalesCommission	Decimal	False	The sales commission amount related to the invoice.
Status	String	False	The current status of the invoice.
AccountName_Id	String	False	The unique identifier of the associated account.
AccountName_Name	String	True	The name of the associated account.
ContactName_Id	String	False	The unique identifier of the contact associated with the invoice.
ContactName_Name	String	True	The name of the contact associated with the invoice.
CreatedBy_Id	String	False	The unique identifier of the user who created the invoice.
CreatedBy_FirstName	String	True	The first name of the user who created the invoice.
CreatedBy_LastName	String	True	The last name of the user who created the invoice.
CreatedBy_Email	String	True	The email address of the user who created the invoice.
CreatedBy_Name	String	True	The full name of the user who created the invoice.
ModifiedBy_Id	String	False	The unique identifier of the user who last modified the invoice.
ModifiedBy_FirstName	String	True	The first name of the user who last modified the invoice.
ModifiedBy_LastName	String	True	The last name of the user who last modified the invoice.
ModifiedBy_Email	String	True	The email address of the user who last modified the invoice.
ModifiedBy_Name	String	True	The full name of the user who last modified the invoice.
CreatedTime	Datetime	False	The date and time when the invoice was created.
ModifiedTime	Datetime	False	The date and time when the invoice was last modified.
Tag	String	False	Any tags associated with the invoice.
BillingStreet	String	False	The billing street address for the invoice.
ShippingStreet	String	False	The shipping street address for the invoice.
BillingCity	String	False	The billing city for the invoice.
ShippingCity	String	False	The shipping city for the invoice.
BillingState	String	False	The billing state for the invoice.
ShippingState	String	False	The shipping state for the invoice.
BillingCode	String	False	The billing postal code for the invoice.
ShippingCode	String	False	The shipping postal code for the invoice.
BillingCountry	String	False	The billing country for the invoice.
ShippingCountry	String	False	The shipping country for the invoice.
SubTotal	String	True	The subtotal amount before discount and tax.
Discount	Decimal	False	The discount amount applied to the invoice.
Tax	Decimal	False	The tax amount applied to the invoice.
Adjustment	Decimal	False	Any manual adjustment to the total invoice amount.
GrandTotal	String	True	The final amount after applying discount, tax, and adjustments.
TermsandConditions	String	False	The terms and conditions applicable to the invoice.
Description	String	False	Additional details or description for the invoice.
InvoicedItems	String	False	The list of items included in the invoice.
RecordId	Long	True	The record identifier used internally.
DealName_Id	String	False	The unique identifier of the related deal.
DealName_Name	String	True	The name of the related deal.
Locked	Bool	True	Indicates whether the invoice is locked for editing.
LastActivityTime	Datetime	False	The date and time of the last activity related to the 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
DuplicateCheckFields	String	The field or fields used to identify duplicate records during upsert operations. The REST API allows multiple fields, but the BULK API only supports one field.
Trigger	String	Triggers workflow rules or automation while inserting the record into the CRM account.
CustomViewId	Long	The custom view identifier used to filter this record. Applies only when the useCOQL parameter is set to false.

CData Python Connector for Zoho CRM