Kaizen #41 - System-defined fields and their default values in the Inventory Modules #API

Kaizen #41 - System-defined fields and their default values in the Inventory Modules #API

Hello everyone!

Welcome back to another post in the Kaizen series!
This week, we will discuss the system-defined fields and their default values in the inventory modules in Zoho CRM.

To know what are system-defined fields in a module, and how to identify system-defined fields, refer to Kaizen #40 System-defined fields and their default values in Leads #API.

The inventory modules in Zoho CRM include Quotes, Invoices, Sales Orders, and Purchase Orders.

We will cover the following in this post:
  • System-defined non-mandatory fields and their default values in the inventory modules
  • System-defined mandatory fields
System-defined non-mandatory fields and their default values for the inventory modules

The following table gives the list of all the system-defined non-mandatory fields in the Standard Layout of the inventory modules.
Module API Name
Field API Name
JSON Type
CRM Field Type
Default Values
Quotes, Invoices, Sales_Orders, Purchase_Orders
Owner
JSON object
Lookup
The name and ID of the current user.
Quotes
Quote_Stage
string
Picklist
Draft
Quotes, Invoices, Sales_Orders
Account_Name
JSON object
Lookup
None
Quotes, Sales_Orders
Deal_Name
JSON object
Lookup
None
Quotes
Valid_Till
string
Date
Null
Quotes, Sales_Orders, Purchase_Orders
Carrier
string
Picklist
FedEx
Quotes
Team
string
Single Line
Null
Quotes, Invoices, Sales_Orders, Purchase_Orders
Contact_Name
JSON object
Lookup
None
Quotes, Invoices, Sales_Orders, Purchase_Orders
Billing_Street, Shipping_Street, Billing_City, Shipping_City, Billing_State, Shipping_State, Billing_Code, Shipping_Code, Billing_Country, Shipping_Country
string
Single Line
Null
Quotes, Invoices, Sales_Orders, Purchase_Orders
Sub_Total (read-only)
double
--
Null
Quotes, Invoices, Sales_Orders, Purchase_Orders
Discount
double
--
Loads the tax configured for the product if you have enabled "Auto populate the associated taxes of the products in the inventory line items." option. If not, the default value is 0. 
Quotes, Invoices, Sales_Orders, Purchase_Orders
Adjustment
double
Number
0
Quotes, Invoices, Sales_Orders, Purchase_Orders
Grand_Total (read-only)
double
--
The calculated grand total of all the line items added.
Quotes, Invoices, Sales_Orders, Purchase_Orders
Terms_and_Conditions
string
Multi-Line
Null
Quotes, Invoices, Sales_Orders, Purchase_Orders
Description
string
Multi-Line
Null
Quotes, Invoices, Sales_Orders, Purchase_Orders
Created_By
(read-only)
JSON object
--
The name and ID of the user who created the record.
Quotes, Invoices, Sales_Orders, Purchase_Orders
Modified_By
(read-only)
JSON object
--
The name and ID of the user who last modified the record.
Quotes, Invoices, Sales_Orders, Purchase_Orders
Created_Time
(read-only)
string
--
The date and time at which the record was created
Quotes, Invoices, Sales_Orders, Purchase_Orders
Modified_Time
(read-only)
string
--
The date and time at which the record was last modified.
Quotes, Invoices, Sales_Orders, Purchase_Orders
Tag
JSON array
--
Null
Invoices, Sales_Orders, Purchase_Orders
Status
string
Picklist
Created
Invoices, Sales_Orders, Purchase_Orders
Currency
string
--
The currency of the organization.
Invoices, Sales_Orders, Purchase_Orders
Exchange_Rate
double
--
The exchange rate set for the organization.
Invoices
Invoice_Date
string
Date
Current Date
Invoices
Sales_Order
JSON object
Lookup
Null
Invoices, Sales_Orders, Purchase_Orders
Due_Date
string
Date
Null
Invoices, Sales_Orders
Purchase_Order
JSON object
Lookup
None
Invoices, Sales_Orders, Purchase_Orders
Excise_Duty
double
Currency
Null
Invoices, Sales_Orders, Purchase_Orders
Sales_Commission
double
Currency
Null
Sales_Orders
Customer_No
string
--
None
Sales_Orders
Pending
string
Single Line
Null
Sales_Orders
Quote_Name
JSON object
Lookup
None
Purchase_Orders
Vendor_Name
JSON object
Lookup
None
Purchase_Orders
PO_Date
string
Date
Current Date
Purchase_Orders
Requisition_No
string
Single Line
Null
Purchase_Orders
Tracking_Number
string
Single Line
Null

Note:
  • You can choose to set different default values for fields with picklist, multi-select picklist, and checkbox CRM field types.
  • You can refer to the Sample Attributes section of our Insert Records API for an example on adding values to the above fields (except the ones that are marked read-only).

System-defined mandatory field for the Inventory modules:
Module Name
Field API Name
JSON Type
CRM Field Type
Default Values
Quotes, Invoices, Sales_Orders,Purchase_Orders
Subject
string
Single Line
Null
Quotes, Invoices, Sales_Orders, Purchase_Orders
Product_Details
JSON array
Lookup
None
Purchase_Orders
Vendor_Name
JSON object
Lookup
None

Note:
  • You can choose to alter the properties of the system-defined/custom fields in standard/custom layouts. The details of all the fields in all the layouts will be retrieved in the fields metadata API response.
  • You can also choose to set default values for a few field types like picklist, multi-select picklist, and checkbox.
  • To know more about handling product line items in the inventory modules via API, refer to our post, Kaizen #9 - Handling Product Line Items in the Inventory Modules #API.

We hope you found this post useful. Write to us at support@zohocrm.com if you have any questions, or let us know in the comment section.

Cheers!

    Access your files securely from anywhere

        Zoho Developer Community




                                  Zoho Desk Resources

                                  • Desk Community Learning Series


                                  • Digest


                                  • Functions


                                  • Meetups


                                  • Kbase


                                  • Resources


                                  • Glossary


                                  • Desk Marketplace


                                  • MVP Corner


                                  • Word of the Day



                                      Zoho Marketing Automation


                                              Manage your brands on social media



                                                    Zoho TeamInbox Resources

                                                      Zoho DataPrep Resources



                                                        Zoho CRM Plus Resources

                                                          Zoho Books Resources


                                                            Zoho Subscriptions Resources

                                                              Zoho Projects Resources


                                                                Zoho Sprints Resources


                                                                  Qntrl Resources


                                                                    Zoho Creator Resources



                                                                        Zoho Campaigns Resources


                                                                          Zoho CRM Resources

                                                                          • CRM Community Learning Series

                                                                            CRM Community Learning Series


                                                                          • Kaizen

                                                                            Kaizen

                                                                          • Functions

                                                                            Functions

                                                                          • Meetups

                                                                            Meetups

                                                                          • Kbase

                                                                            Kbase

                                                                          • Resources

                                                                            Resources

                                                                          • Digest

                                                                            Digest

                                                                          • CRM Marketplace

                                                                            CRM Marketplace

                                                                          • MVP Corner

                                                                            MVP Corner





                                                                              Design. Discuss. Deliver.

                                                                              Create visually engaging stories with Zoho Show.

                                                                              Get Started Now