Sales Orders

Response Structure

{
    "data": [
        {
           
            "Owner": { //Name, ID, and email of the owner of the Sales Order
               
                "name": "Patricia Boyle",
                
                "id": "4150868000000225013",
                
                "email": "patricia.b@zohocorp.com"
            },
            
            "$currency_symbol": "DA", //The currency in which the revenue is generated
            
            "Customer_No": null, //Represents the customer ID, if any
            
            "Tax": 19950, //The tax amount which is the sum of sales tax and VAT
            
            "$converted": false, //Represents whether the sales order is converted to an Invoice
            
            "$process_flow": false, //Represents if the record is a blueprint data
            
              "Deal_Name": { //Name and ID of the deal for which the sales order needs to be created

                 "name": "Deal1",

                "id": "3652397000000186017"

            },
            
            "Exchange_Rate": 3, //Exchange rate of the currency
            
            "Currency": "DZD", //The currency in which the revenue is generated
            
            "Billing_Country": "United States", //Address details of the sales order
            
            "id": "4150868000002575450", //Unique ID of the record
            
            "Carrier": "FedEX", //Name of the carrier
            
            "$approved": true, //Represents whether the record is approved
            
           "Quote_Name": { //Name and ID of the reference quote

                "name": "Subject",

                "id": "3652397000000415008"

            },
            
            "Status": "Created", //Represents the status of the sales order
            
            "Grand_Total": 114950, //Represents the total amount for the product after deducting tax and discounts
            
            "$approval": { //Represents if the current user can approve, delegate, reject, or resubmit the operations performed on this record
               
                "delegate": false,
                
                "approve": false,
                
                "reject": false,
                
                "resubmit": false
            },
            
            "Billing_Street": "639 Main St", //Address details of the sales order
            
            "Adjustment": 0, //Represents the adjustment in the grand total, if any
            
            "Created_Time": "2020-07-06T19:11:01+05:30", //Date and time at which the record was created. This is a system-generated field. You cannot modify it.
            
            "$editable": true, //Represents if the user can edit the sales order
            
            "Billing_Code": "99501", //Address details of the sales order
            
            "Product_Details": [ //Details of the product for which the sales order is created
               
                {
                   
                    "product": { //The details of the product for which the sales order is created
                       
                        "Product_Code": null,
                        
                        "Currency": "DZD",
                        
                        "name": "sample",
                        
                        "id": "4150868000001263054"
                    },
                    
                    "quantity": 1,
                    
                    "Discount": 0,
                    
                    "total_after_discount": 0,
                    
                    "net_total": 0,
                    
                    "book": null,
                    
                    "Tax": 0,
                    
                    "list_price": 0,
                    
                    "unit_price": null,
                    
                    "quantity_in_stock": -1,
                    
                    "total": 0,
                    
                    "id": "4150868000002575449",
                    
                    "product_description": null,
                    
                    "line_tax": []
                }
            ],
            "Excise_Duty": null, //The excise duty of the product
            
            "Shipping_City": null, //Address details of the sales order
            
            "Shipping_Country": null, //Address details of the sales order
            
            "Shipping_Code": null, //Address details of the sales order
            
            "Billing_City": "Anchorage", //Address details of the sales order
            
            "Purchase_Order": null, //Address details of the sales order
            
            "Created_By": { //Name and ID of the user who created the record. This is a system-generated field. You cannot modify it.
               
                "name": "Patricia Boyle",
                
                "id": "4150868000000225013",
                
                "email": "patricia.b@zohocorp.com"
                
            },
            "Shipping_Street": null, //Address details of the sales order
            
            "Discount": 0, //Discount details of the sales order
            
            "Description": null, //Description about the sales order, if any
            
            "Shipping_State": null, //Address details of the sales order
            
            "$review_process": { //Review process details of the sales order
               
                "approve": false,
                
                "reject": false,
                
                "resubmit": false
            },
            
            "Modified_By": {   //The name, ID, and email of the user who last modified the sales order
                "name": "Patricia Boyle",
                
                "id": "4150868000000225013",
                
                "email": "patricia.b@zohocorp.com"
            },
            
            "$review": null, //Review process details of the sales order
            
            "Account_Name": { //Name and ID of the account name to which the sales order has to be created. This field is mandatory
               
                "name": "Grayson",
                
                "id": "4150868000002492050"
            },
            
            "Sales_Commission": null, //Represents the commission to the sales person upon closing the deal
            
            "Modified_Time": "2020-07-06T19:11:01+05:30", //Date and time at which the record was last modified. This is a system-generated field. You cannot modify it.
            
            "Due_Date": null, //Date on which the sales order is due
            
            "Terms_and_Conditions": null, //Represents the terms and conditions that are associated with the purchase order
            
            "Sub_Total": 100000, //Represents the total amount for the product excluding tax
            
            "Subject": "SO1", //Name of the sales order record
            
            "$orchestration": false, //Represents if the record is a part of orchestration process
            
             "Contact_Name": { //Name and ID of the contact for whom the sales order is created

                 "name": "Patricia Boyle",

                "id": "3652397000000186017"

            },
            
            "$in_merge": false,
            
            "SO_Number": "4150868000002575452", //The sales order ID after creating a case
            
            "Billing_State": "AK", //Address details of the sales order
            
           "$line_tax": [ //The percentage of sales tax and VAT for the product

                {

                    "percentage": 12.5,

                    "name": "Sales Tax",

                    "value": -18.458750000000002

                },

                {

                    "percentage": 8.5,

                    "name": "Common Tax",

                    "value": -12.551950000000001

                }

            ],
            
            "Tag": [], //List of tags associated with the record
            
            "$approval_state": "approved",  //Represents if the record is approved
            
            "Pending": null
        }
    ]
}

Note:

  • The fields beginning with "$" indicate that they do not appear on the Zoho CRM UI, but contain important data. They are read-only fields.
  • For more information about sample attributes, refer Get List of Records.