CustomModuleFields

In Zoho Books, you can create a custom module to record other data when the predefined modules are not sufficient to manage all your business requirements.

Table Specific Information

Select

The provider uses the Zoho Books API to process WHERE clause conditions built with EntityName, which supports the '=' comparison. The rest of the filter is executed client-side in the provider.

NOTE: EntityName is required to query CustomModuleFields.

For example:

    SELECT * FROM CustomModuleFields WHERE EntityName = 'cm_tests_module'

    SELECT * FROM CustomModules WHERE EntityName IN ('cm_tests_module', 'cm_testingmodule')

Insert

You can execute INSERT by specifying EntityName, FieldName, IsMandatory, DataType, and ShowOnPdf columns. The columns that are not read-only can be inserted optionally. The following is an example of how to insert into this table:

INSERT INTO CustomModuleFields (EntityName, FieldName, IsMandatory, DataType, ShowOnPdf) VALUES ('cm_test1', 'fieldname23', 'fcan also be executed', 'string', 'fcan also be executed')

Insert a field of type dropdown or multiselect by specifying the Options column in addition to the above columns. The following is an example of how to insert a field of type dropdown or multiselect:

INSERT INTO CustomModuleFieldDropDownOptions#TEMP (OptionName, OptionOrder) VALUES ('option2', '2')

INSERT INTO CustomModuleFieldDropDownOptions#TEMP (OptionName, OptionOrder) VALUES ('option1', '1')

INSERT INTO CustomModuleFields (entityname, fieldname, datatype, ismandatory, showonpdf, options) VALUES ('cm_testupdate', 'field4', 'multiselect', 'fcan also be executed', 'fcan also be executed', CustomModuleFieldDropDownOptions#TEMP )

Insert a field of type autonumber by specifying AutoNumberStartingValue. The following is an example of how to insert a field of type autonumber:

INSERT INTO CustomModuleFields (entityname, fieldname, datatype, ismandatory, showonpdf, AutoNumberStartingValue) VALUES ('cm_testupdate', 'field6', 'autonumber', 'fcan also be executed', 'fcan also be executed', 3)

Update

You can execute UPDATE by specifying the FieldId in the WHERE Clause. The columns that are not read-only can be updated.

UPDATE CustomModuleFields SET FieldName = 'testingss' WHERE FieldId = 4044157000000087002

Delete

DELETE FROM CustomModuleFields WHERE FieldName = 'cf_label_1' AND entityname = 'cm_tets_module'

Columns


Name	Type	ReadOnly	References	SupportedOperators	Description
FieldId [KEY]	String	True			Id of the column created.
EntityName	String	False			Name of the custom module for which a column has to be added.
FieldName	String	False			Name of the column.
DataType	String	False			Data type of the column. The allowed values are string, email, url, phone, number, decimal, amount, percent, date, date_time, check_box, autonumber, dropdown, multiselect, lookup, multiline, formula.
AutoNumberStartingValue	Integer	False			The beginning value for auto-generation. This is mandatory when data_type is set to autonumber.
Options	String	False			Required if the datatype is multiselect or dropdown.
Description	String	False			Description of the custom field to help users understand the usecase.
IsMandatory	Boolean	False			Boolean value that evaluates whether the column is mandatory.
ShowOnPdf	Boolean	False			Boolean value that evalueate whether the value should be shown in pdf.