"module": "ProductBundles",
                        "field": "deal_tot",
                        "reason": "related_fields"
                    },
                    "new_sub": {
                        "module": "ProductBundles",
                        "field": "new_sub",
                        "reason": "related_fields"
                    }
                }
            },
            "base_rate": {
                "related": {
                    "subtotal": {
                        "module": "ProductBundles",
                        "field": "subtotal",
                        "reason": "related_fields"
                    },
                    "deal_tot": {
                        "module": "ProductBundles",
                        "field": "deal_tot",
                        "reason": "related_fields"
                    },
                    "new_sub": {
                        "module": "ProductBundles",
                        "field": "new_sub",
                        "reason": "related_fields"
                    }
                }
            },
            "new_sub": {
                "locked": {
                    "new_sub": {
                        "module": "Quotes",
                        "field": "new_sub",
                        "reason": "rollup"
                    },
                    "total": {
                        "module": "Quotes",
                        "field": "total",
                        "reason": "rollup"
                    }
                }
            },
            "deal_tot": {
                "locked": {
                    "new_sub": {
                        "module": "ProductBundles",
                        "field": "new_sub",
                        "reason": "formula"
                    }
                }
            },
            "taxable_subtotal": {
                "locked": {
                    "taxable_subtotal": {
                        "module": "Quotes",
                        "field": "taxable_subtotal",


"module": "Quotes",
                        "field": "taxable_subtotal",
                        "reason": "rollup"
                    }
                }
            }
        },
        "Products": {
            "subtotal": {
                "locked": {
                    "subtotal": {
                        "module": "ProductBundles",
                        "field": "subtotal",
                        "reason": "rollup"
                    }
                }
            },
            "quantity": {
                "locked": {
                    "total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "formula"
                    }
                },
                "related": {
                    "total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    }
                }
            },
            "discount_price": {
                "locked": {
                    "total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "formula"
                    }
                },
                "related": {
                    "total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    }
                }
            },
            "currency_id": {
                "related": {
                    "discount_price": {
                        "module": "Products",
                        "field": "discount_price",
                        "reason": "related_fields"
                    },
                    "discount_amount": {
                        "module": "Products",
                        "field": "discount_amount",
                        "reason": "related_fields"
                    },
                    "total_amount": {
                        "module": "Products",


},
                    "total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    }
                }
            },
            "base_rate": {
                "related": {
                    "discount_price": {
                        "module": "Products",
                        "field": "discount_price",
                        "reason": "related_fields"
                    },
                    "discount_amount": {
                        "module": "Products",
                        "field": "discount_amount",
                        "reason": "related_fields"
                    },
                    "total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    }
                }
            },
            "deal_calc": {
                "locked": {
                    "deal_tot": {
                        "module": "ProductBundles",
                        "field": "deal_tot",
                        "reason": "rollup"
                    }
                }
            },
            "discount_select": {
                "related": {
                    "discount_amount": {
                        "module": "Products",
                        "field": "discount_amount",
                        "reason": "related_fields"
                    },
                    "total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    }
                },
                "locked": {
                    "total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "formula"
                    }
                }
            },
            "discount_amount": {
                "locked": {
                    "total_amount": {
                        "module": "Products",


"total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "formula"
                    }
                },
                "related": {
                    "total_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    }
                }
            },
            "total_amount": {
                "locked": {
                    "taxable_subtotal": {
                        "module": "ProductBundles",
                        "field": "taxable_subtotal",
                        "reason": "rollup"
                    }
                }
            },
            "tax_class": {
                "locked": {
                    "taxable_subtotal": {
                        "module": "ProductBundles",
                        "field": "taxable_subtotal",
                        "reason": "rollup"
                    }
                }
            }
        }
    },
    "relatedFields": {
        "Products": {
            "name": {
                "locked": {
                    "product_template_name": {
                        "module": "Products",
                        "field": "name",
                        "reason": "formula"
                    }
                }
            },
            "subtotal": {
                "locked": {
                    "quantity": {
                        "module": "Products",
                        "field": "subtotal",
                        "reason": "formula"
                    },
                    "discount_price": {
                        "module": "Products",
                        "field": "subtotal",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "subtotal",
                        "reason": "related_fields"


"field": "subtotal",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "subtotal",
                        "reason": "related_fields"
                    },
                    "discount_price": {
                        "module": "Products",
                        "field": "subtotal",
                        "reason": "related_fields"
                    },
                    "quantity": {
                        "module": "Products",
                        "field": "subtotal",
                        "reason": "related_fields"
                    }
                }
            },
            "total_amount": {
                "locked": {
                    "quantity": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "formula"
                    },
                    "discount_price": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "formula"
                    },
                    "discount_select": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "formula"
                    },
                    "discount_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    },
                    "quantity": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    },


"reason": "related_fields"
                    },
                    "discount_price": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    },
                    "discount_select": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    },
                    "discount_amount": {
                        "module": "Products",
                        "field": "total_amount",
                        "reason": "related_fields"
                    }
                }
            },
            "manufacturer_name": {
                "related": {
                    "manufacturer_id": {
                        "module": "Products",
                        "field": "manufacturer_name",
                        "reason": "related_fields"
                    }
                }
            },
            "cost_price": {
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "cost_price",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "cost_price",
                        "reason": "related_fields"
                    }
                }
            },
            "discount_price": {
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "discount_price",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "discount_price",
                        "reason": "related_fields"
                    }
                }
            },
            "discount_amount": {
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "discount_amount",


"module": "Products",
                        "field": "discount_amount",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "discount_amount",
                        "reason": "related_fields"
                    },
                    "discount_select": {
                        "module": "Products",
                        "field": "discount_amount",
                        "reason": "related_fields"
                    }
                }
            },
            "discount_rate_percent": {
                "locked": {
                    "discount_price": {
                        "module": "Products",
                        "field": "discount_rate_percent",
                        "reason": "formula"
                    },
                    "discount_amount": {
                        "module": "Products",
                        "field": "discount_rate_percent",
                        "reason": "formula"
                    }
                }
            },
            "discount_amount_usdollar": {
                "locked": {
                    "discount_amount": {
                        "module": "Products",
                        "field": "discount_amount_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "discount_amount_usdollar",
                        "reason": "formula"
                    }
                }
            },
            "deal_calc": {
                "locked": {
                    "discount_select": {
                        "module": "Products",
                        "field": "deal_calc",
                        "reason": "formula"
                    },
                    "discount_price": {
                        "module": "Products",
                        "field": "deal_calc",
                        "reason": "formula"
                    },
                    "quantity": {
                        "module": "Products",


},
                    "quantity": {
                        "module": "Products",
                        "field": "deal_calc",
                        "reason": "formula"
                    },
                    "discount_amount": {
                        "module": "Products",
                        "field": "deal_calc",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "deal_calc",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "deal_calc",
                        "reason": "related_fields"
                    },
                    "discount_price": {
                        "module": "Products",
                        "field": "deal_calc",
                        "reason": "related_fields"
                    },
                    "quantity": {
                        "module": "Products",
                        "field": "deal_calc",
                        "reason": "related_fields"
                    },
                    "discount_amount": {
                        "module": "Products",
                        "field": "deal_calc",
                        "reason": "related_fields"
                    }
                }
            },
            "deal_calc_usdollar": {
                "locked": {
                    "deal_calc": {
                        "module": "Products",
                        "field": "deal_calc_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "deal_calc_usdollar",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "deal_calc_usdollar",


"module": "Products",
                        "field": "deal_calc_usdollar",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "deal_calc_usdollar",
                        "reason": "related_fields"
                    }
                }
            },
            "list_price": {
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "list_price",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "list_price",
                        "reason": "related_fields"
                    }
                }
            },
            "cost_usdollar": {
                "locked": {
                    "cost_price": {
                        "module": "Products",
                        "field": "cost_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "cost_usdollar",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "cost_usdollar",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "cost_usdollar",
                        "reason": "related_fields"
                    }
                }
            },
            "discount_usdollar": {
                "locked": {
                    "discount_price": {
                        "module": "Products",
                        "field": "discount_usdollar",
                        "reason": "formula"
                    },


"reason": "formula"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "discount_usdollar",
                        "reason": "formula"
                    }
                }
            },
            "list_usdollar": {
                "locked": {
                    "list_price": {
                        "module": "Products",
                        "field": "list_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "list_usdollar",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "list_usdollar",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "list_usdollar",
                        "reason": "related_fields"
                    }
                }
            },
            "book_value": {
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "book_value",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "book_value",
                        "reason": "related_fields"
                    }
                }
            },
            "book_value_usdollar": {
                "locked": {
                    "book_value": {
                        "module": "Products",
                        "field": "book_value_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Products",


},
                    "base_rate": {
                        "module": "Products",
                        "field": "book_value_usdollar",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Products",
                        "field": "book_value_usdollar",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Products",
                        "field": "book_value_usdollar",
                        "reason": "related_fields"
                    }
                }
            },
            "date_closed_timestamp": {
                "locked": {
                    "date_closed": {
                        "module": "Products",
                        "field": "date_closed_timestamp",
                        "reason": "formula"
                    }
                }
            }
        },
        "Quotes": {
            "subtotal": {
                "locked": {
                    "product_bundles": {
                        "module": "Quotes",
                        "field": "subtotal",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "subtotal",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "subtotal",
                        "reason": "related_fields"
                    }
                }
            },
            "subtotal_usdollar": {
                "locked": {
                    "subtotal": {
                        "module": "Quotes",
                        "field": "subtotal_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Quotes",


},
                    "base_rate": {
                        "module": "Quotes",
                        "field": "subtotal_usdollar",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "subtotal_usdollar",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "subtotal_usdollar",
                        "reason": "related_fields"
                    }
                }
            },
            "shipping": {
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "shipping",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "shipping",
                        "reason": "related_fields"
                    }
                }
            },
            "shipping_usdollar": {
                "locked": {
                    "shipping": {
                        "module": "Quotes",
                        "field": "shipping_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "shipping_usdollar",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "shipping_usdollar",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "shipping_usdollar",
                        "reason": "related_fields"
                    }
                }
            },


"reason": "related_fields"
                    }
                }
            },
            "discount": {
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "discount",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "discount",
                        "reason": "related_fields"
                    }
                }
            },
            "deal_tot": {
                "locked": {
                    "product_bundles": {
                        "module": "Quotes",
                        "field": "deal_tot",
                        "reason": "formula"
                    }
                }
            },
            "deal_tot_discount_percentage": {
                "locked": {
                    "subtotal_usdollar": {
                        "module": "Quotes",
                        "field": "deal_tot_discount_percentage",
                        "reason": "formula"
                    },
                    "deal_tot_usdollar": {
                        "module": "Quotes",
                        "field": "deal_tot_discount_percentage",
                        "reason": "formula"
                    }
                }
            },
            "deal_tot_usdollar": {
                "locked": {
                    "deal_tot": {
                        "module": "Quotes",
                        "field": "deal_tot_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "deal_tot_usdollar",
                        "reason": "formula"
                    }
                }
            },
            "new_sub": {
                "locked": {
                    "product_bundles": {
                        "module": "Quotes",
                        "field": "new_sub",


"module": "Quotes",
                        "field": "new_sub",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "new_sub",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "new_sub",
                        "reason": "related_fields"
                    }
                }
            },
            "new_sub_usdollar": {
                "locked": {
                    "new_sub": {
                        "module": "Quotes",
                        "field": "new_sub_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "new_sub_usdollar",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "new_sub_usdollar",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "new_sub_usdollar",
                        "reason": "related_fields"
                    }
                }
            },
            "taxable_subtotal": {
                "locked": {
                    "product_bundles": {
                        "module": "Quotes",
                        "field": "taxable_subtotal",
                        "reason": "formula"
                    }
                }
            },
            "tax": {
                "locked": {
                    "taxable_subtotal": {
                        "module": "Quotes",
                        "field": "tax",


"module": "Quotes",
                        "field": "tax",
                        "reason": "formula"
                    },
                    "taxrate_value": {
                        "module": "Quotes",
                        "field": "tax",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "tax",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "tax",
                        "reason": "related_fields"
                    },
                    "taxrate_value": {
                        "module": "Quotes",
                        "field": "tax",
                        "reason": "related_fields"
                    },
                    "taxable_subtotal": {
                        "module": "Quotes",
                        "field": "tax",
                        "reason": "related_fields"
                    }
                }
            },
            "tax_usdollar": {
                "locked": {
                    "tax": {
                        "module": "Quotes",
                        "field": "tax_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "tax_usdollar",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "tax_usdollar",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "tax_usdollar",
                        "reason": "related_fields"
                    }
                }
            },


"reason": "related_fields"
                    }
                }
            },
            "total": {
                "locked": {
                    "product_bundles": {
                        "module": "Quotes",
                        "field": "total",
                        "reason": "formula"
                    },
                    "tax": {
                        "module": "Quotes",
                        "field": "total",
                        "reason": "formula"
                    },
                    "shipping": {
                        "module": "Quotes",
                        "field": "total",
                        "reason": "formula"
                    }
                }
            },
            "total_usdollar": {
                "locked": {
                    "total": {
                        "module": "Quotes",
                        "field": "total_usdollar",
                        "reason": "formula"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "total_usdollar",
                        "reason": "formula"
                    }
                },
                "related": {
                    "currency_id": {
                        "module": "Quotes",
                        "field": "total_usdollar",
                        "reason": "related_fields"
                    },
                    "base_rate": {
                        "module": "Quotes",
                        "field": "total_usdollar",
                        "reason": "related_fields"
                    }
                }
            }
        }
    },
    "productsFields": {
        "date_entered": {
            "type": "datetime",
            "studio": {
                "portaleditview": false
            },
            "readonly": true,
            "label": "LBL_DATE_ENTERED"
        },
        "date_modified": {
            "type": "datetime",


},
        "date_modified": {
            "type": "datetime",
            "studio": {
                "portaleditview": false
            },
            "readonly": true,
            "label": "LBL_DATE_MODIFIED"
        },
        "modified_by_name": {
            "type": "relate",
            "link": "modified_user_link",
            "readonly": true,
            "label": "LBL_MODIFIED"
        },
        "created_by_name": {
            "type": "relate",
            "link": "created_by_link",
            "readonly": true,
            "label": "LBL_CREATED"
        },
        "description": {
            "type": "text",
            "label": "LBL_DESCRIPTION"
        },
        "revenuelineitem_name": {
            "type": "relate",
            "link": "revenuelineitems",
            "studio": "visible",
            "label": "LBL_REVENUELINEITEM_NAME"
        },
        "product_template_name": {
            "type": "relate",
            "link": "product_templates_link",
            "studio": {
                "editview": false,
                "detailview": false,
                "quickcreate": false
            },
            "label": "LBL_PRODUCT_TEMPLATE"
        },
        "subtotal": {
            "type": "currency",
            "default": "0",
            "related_fields": [
                "currency_id",
                "base_rate",
                "discount_price",
                "quantity"
            ],
            "label": "LBL_SUBTOTAL"
        },
        "total_amount": {
            "default": "0.00",
            "type": "currency",


"default": "0.00",
            "type": "currency",
            "related_fields": [
                "currency_id",
                "base_rate",
                "quantity",
                "discount_price",
                "discount_select",
                "discount_amount"
            ],
            "label": "LBL_CALCULATED_LINE_ITEM_AMOUNT"
        },
        "contact_name": {
            "type": "relate",
            "link": "contact_link",
            "label": "LBL_CONTACT_NAME"
        },
        "manufacturer_name": {
            "type": "relate",
            "link": "manufacturers",
            "related_fields": [
                "manufacturer_id"
            ],
            "label": "LBL_MANUFACTURER_NAME"
        },
        "category_name": {
            "type": "relate",
            "link": "product_categories_link",
            "studio": {
                "editview": false,
                "detailview": false,
                "quickcreate": false
            },
            "label": "LBL_CATEGORY_NAME"
        },
        "mft_part_num": {
            "type": "varchar",
            "label": "LBL_MFT_PART_NUM"
        },
        "vendor_part_num": {
            "type": "varchar",
            "label": "LBL_VENDOR_PART_NUM"
        },
        "date_purchased": {
            "type": "date",
            "label": "LBL_DATE_PURCHASED"
        },
        "discount_rate_percent": {
            "type": "decimal",
            "label": "LBL_DISCOUNT_RATE"
        },
        "discount_amount_usdollar": {
            "type": "currency",
            "studio": {


"type": "currency",
            "studio": {
                "editview": false,
                "mobile": false
            },
            "label": "LBL_DISCOUNT_RATE_USDOLLAR"
        },
        "discount_select": {
            "type": "bool",
            "default": true,
            "label": "LBL_DISCOUNT_AS_PERCENT"
        },
        "deal_calc": {
            "type": "currency",
            "related_fields": [
                "currency_id",
                "base_rate",
                "discount_price",
                "quantity",
                "discount_amount"
            ],
            "label": "LBL_DISCOUNT_TOTAL"
        },
        "deal_calc_usdollar": {
            "type": "currency",
            "studio": {
                "editview": false,
                "mobile": false
            },
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_DISCOUNT_TOTAL_USDOLLAR"
        },
        "list_price": {
            "type": "currency",
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_LIST_PRICE"
        },
        "cost_usdollar": {
            "type": "currency",
            "studio": {
                "editview": false,
                "mobile": false
            },
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_COST_USDOLLAR"
        },
        "discount_usdollar": {
            "type": "currency",
            "studio": {
                "editview": false,
                "mobile": false


"studio": {
                "editview": false,
                "mobile": false
            },
            "label": "LBL_DISCOUNT_USDOLLAR"
        },
        "list_usdollar": {
            "type": "currency",
            "studio": {
                "editview": false,
                "mobile": false
            },
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_LIST_USDOLLAR"
        },
        "tax_class": {
            "type": "enum",
            "default": "Taxable",
            "label": "LBL_TAX_CLASS"
        },
        "website": {
            "type": "varchar",
            "label": "LBL_URL"
        },
        "weight": {
            "type": "decimal",
            "label": "LBL_WEIGHT"
        },
        "quantity": {
            "type": "decimal",
            "default": true,
            "label": "LBL_QUANTITY"
        },
        "support_name": {
            "type": "varchar",
            "label": "LBL_SUPPORT_NAME"
        },
        "support_description": {
            "type": "varchar",
            "label": "LBL_SUPPORT_DESCRIPTION"
        },
        "support_contact": {
            "type": "varchar",
            "label": "LBL_SUPPORT_CONTACT"
        },
        "support_term": {
            "type": "varchar",
            "label": "LBL_SUPPORT_TERM"
        },
        "date_support_expires": {
            "type": "date",
            "label": "LBL_DATE_SUPPORT_EXPIRES"
        },
        "date_support_starts": {


},
        "date_support_starts": {
            "type": "date",
            "label": "LBL_DATE_SUPPORT_STARTS"
        },
        "pricing_formula": {
            "type": "varchar",
            "label": "LBL_PRICING_FORMULA"
        },
        "pricing_factor": {
            "type": "int",
            "label": "LBL_PRICING_FACTOR"
        },
        "serial_number": {
            "type": "varchar",
            "label": "LBL_SERIAL_NUMBER"
        },
        "asset_number": {
            "type": "varchar",
            "label": "LBL_ASSET_NUMBER"
        },
        "book_value": {
            "type": "currency",
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_BOOK_VALUE"
        },
        "book_value_usdollar": {
            "type": "currency",
            "studio": {
                "editview": false,
                "mobile": false
            },
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_BOOK_VALUE_USDOLLAR"
        },
        "book_value_date": {
            "type": "date",
            "label": "LBL_BOOK_VALUE_DATE"
        },
        "date_closed": {
            "type": "date",
            "label": "LBL_DATE_CLOSED"
        },
        "next_step": {
            "type": "varchar",
            "label": "LBL_NEXT_STEP"
        },
        "campaign_name": {
            "type": "relate",
            "link": "campaign_products",


"type": "relate",
            "link": "campaign_products",
            "label": "LBL_CAMPAIGN"
        },
        "opportunity_name": {
            "type": "relate",
            "link": "opportunities",
            "label": "LBL_OPPORTUNITY_NAME"
        },
        "type_name": {
            "type": "relate",
            "link": "product_types_link",
            "label": "LBL_TYPE"
        },
        "tag": {
            "type": "tag",
            "link": "tag_link",
            "studio": {
                "portal": false,
                "base": {
                    "popuplist": false
                },
                "mobile": {
                    "wirelesseditview": true,
                    "wirelessdetailview": true
                }
            },
            "sortable": false,
            "label": "LBL_TAGS"
        },
        "team_name": {
            "type": "relate",
            "link": "team_link",
            "studio": {
                "portallistview": false,
                "portalrecordview": false
            },
            "label": "LBL_TEAMS"
        },
        "base_rate": {
            "type": "text",
            "label": "LBL_CURRENCY_RATE"
        },
        "name": {
            "type": "name",
            "link": true,
            "label": "LBL_NAME",
            "default": true
        },
        "account_name": {
            "type": "relate",
            "link": "account_link",
            "label": "LBL_ACCOUNT_NAME",
            "related_fields": [
                "account_id"
            ]


"related_fields": [
                "account_id"
            ]
        },
        "status": {
            "type": "enum",
            "default": "",
            "label": "LBL_STATUS"
        },
        "quote_name": {
            "type": "relate",
            "link": true,
            "label": "LBL_ASSOCIATED_QUOTE",
            "related_fields": [
                "quote_id"
            ],
            "default": true
        },
        "discount_price": {
            "type": "currency",
            "default": "0",
            "related_fields": [
                "discount_price",
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_DISCOUNT_PRICE"
        },
        "cost_price": {
            "type": "currency",
            "related_fields": [
                "cost_price",
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_COST_PRICE"
        },
        "discount_amount": {
            "type": "discount",
            "default": "0",
            "related_fields": [
                "discount_select",
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_DISCOUNT_AMOUNT"
        },
        "assigned_user_name": {
            "link": "assigned_user_link",
            "type": "relate",
            "label": "LBL_ASSIGNED_TO"
        }
    },
    "quotesFields": {
        "modified_by_name": {
            "type": "relate",
            "link": "modified_user_link",
            "readonly": true,
            "label": "LBL_MODIFIED"
        },


"readonly": true,
            "label": "LBL_MODIFIED"
        },
        "created_by_name": {
            "type": "relate",
            "link": "created_by_link",
            "readonly": true,
            "label": "LBL_CREATED"
        },
        "description": {
            "type": "text",
            "label": "LBL_DESCRIPTION"
        },
        "shipper_name": {
            "type": "relate",
            "link": "shippers",
            "label": "LBL_SHIPPING_PROVIDER"
        },
        "taxrate_name": {
            "type": "relate",
            "link": "taxrates",
            "label": "LBL_TAXRATE"
        },
        "show_line_nums": {
            "type": "bool",
            "default": 1,
            "label": "LBL_SHOW_LINE_NUMS"
        },
        "quote_type": {
            "type": "enum",
            "label": "LBL_QUOTE_TYPE"
        },
        "original_po_date": {
            "type": "date",
            "label": "LBL_ORIGINAL_PO_DATE"
        },
        "payment_terms": {
            "type": "enum",
            "label": "LBL_PAYMENT_TERMS"
        },
        "date_quote_closed": {
            "type": "date",
            "label": "LBL_DATE_QUOTE_CLOSED"
        },
        "date_order_shipped": {
            "type": "date",
            "label": "LBL_LIST_DATE_QUOTE_CLOSED"
        },
        "order_stage": {
            "type": "enum",
            "label": "LBL_ORDER_STAGE"
        },
        "purchase_order_num": {


},
        "purchase_order_num": {
            "type": "varchar",
            "label": "LBL_PURCHASE_ORDER_NUM"
        },
        "subtotal": {
            "type": "currency",
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_SUBTOTAL"
        },
        "subtotal_usdollar": {
            "type": "currency",
            "studio": {
                "wirelesseditview": false,
                "wirelessdetailview": false,
                "wirelesslistview": false,
                "wireless_basic_search": false,
                "wireless_advanced_search": false,
                "mobile": false
            },
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_SUBTOTAL_USDOLLAR"
        },
        "shipping": {
            "type": "currency",
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "default": "0",
            "label": "LBL_SHIPPING"
        },
        "shipping_usdollar": {
            "type": "currency",
            "studio": {
                "wirelesseditview": false,
                "wirelessdetailview": false,
                "wirelesslistview": false,
                "wireless_basic_search": false,
                "wireless_advanced_search": false,
                "mobile": false
            },
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_SHIPPING_USDOLLAR"
        },
        "discount": {
            "type": "currency",


},
        "discount": {
            "type": "currency",
            "default": "0",
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_DISCOUNT_TOTAL"
        },
        "deal_tot": {
            "type": "currency",
            "label": "LBL_DEAL_TOT"
        },
        "deal_tot_discount_percentage": {
            "type": "float",
            "default": "0",
            "label": "LBL_DEAL_TOT_PERCENTAGE"
        },
        "deal_tot_usdollar": {
            "type": "currency",
            "studio": {
                "wirelesseditview": false,
                "wirelessdetailview": false,
                "wirelesslistview": false,
                "wireless_basic_search": false,
                "wireless_advanced_search": false,
                "mobile": false
            },
            "label": "LBL_DEAL_TOT_USDOLLAR"
        },
        "new_sub": {
            "type": "currency",
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_NEW_SUB"
        },
        "new_sub_usdollar": {
            "type": "currency",
            "studio": {
                "wirelesseditview": false,
                "wirelessdetailview": false,
                "wirelesslistview": false,
                "wireless_basic_search": false,
                "wireless_advanced_search": false,
                "mobile": false
            },
            "related_fields": [
                "currency_id",
                "base_rate"
            ],


"currency_id",
                "base_rate"
            ],
            "label": "LBL_NEW_SUB_USDOLLAR"
        },
        "taxable_subtotal": {
            "type": "currency",
            "label": "LBL_TAXABLE_SUBTOTAL"
        },
        "tax": {
            "type": "currency",
            "related_fields": [
                "currency_id",
                "base_rate",
                "taxrate_value",
                "taxable_subtotal"
            ],
            "default": "0",
            "label": "LBL_TAX"
        },
        "tax_usdollar": {
            "type": "currency",
            "studio": {
                "wirelesseditview": false,
                "wirelessdetailview": false,
                "wirelesslistview": false,
                "wireless_basic_search": false,
                "wireless_advanced_search": false,
                "mobile": false
            },
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_TAX_USDOLLAR"
        },
        "billing_address_street": {
            "type": "text",
            "label": "LBL_BILLING_ADDRESS_STREET"
        },
        "billing_address_city": {
            "type": "varchar",
            "label": "LBL_BILLING_ADDRESS_CITY"
        },
        "billing_address_state": {
            "type": "varchar",
            "label": "LBL_BILLING_ADDRESS_STATE"
        },
        "billing_address_postalcode": {
            "type": "varchar",
            "label": "LBL_BILLING_ADDRESS_POSTAL_CODE"
        },
        "billing_address_country": {


},
        "billing_address_country": {
            "type": "varchar",
            "label": "LBL_BILLING_ADDRESS_COUNTRY"
        },
        "shipping_address_street": {
            "type": "text",
            "label": "LBL_SHIPPING_ADDRESS_STREET"
        },
        "shipping_address_city": {
            "type": "varchar",
            "label": "LBL_SHIPPING_ADDRESS_CITY"
        },
        "shipping_address_state": {
            "type": "varchar",
            "label": "LBL_SHIPPING_ADDRESS_STATE"
        },
        "shipping_address_postalcode": {
            "type": "varchar",
            "label": "LBL_SHIPPING_ADDRESS_POSTAL_CODE"
        },
        "shipping_address_country": {
            "type": "varchar",
            "label": "LBL_SHIPPING_ADDRESS_COUNTRY"
        },
        "shipping_account_name": {
            "type": "relate",
            "link": "shipping_accounts",
            "label": "LBL_SHIPPING_ACCOUNT_NAME"
        },
        "shipping_contact_name": {
            "type": "relate",
            "link": "shipping_contacts",
            "label": "LBL_SHIPPING_CONTACT_NAME"
        },
        "shipping_contact_id": {
            "type": "relate",
            "link": "shipping_contacts",
            "label": "LBL_SHIPPING_CONTACT_ID"
        },
        "billing_contact_name": {
            "type": "relate",
            "link": "billing_contacts",
            "label": "LBL_BILLING_CONTACT_NAME"
        },
        "billing_contact_id": {
            "type": "relate",
            "link": "billing_contacts",
            "label": "LBL_BILLING_CONTACT_ID"


"label": "LBL_BILLING_CONTACT_ID"
        },
        "bundles": {
            "type": "collection",
            "label": "LBL_PRODUCT_BUNDLES"
        },
        "opportunity_name": {
            "type": "relate",
            "link": "opportunities",
            "label": "LBL_OPPORTUNITY_NAME"
        },
        "opportunity_id": {
            "type": "relate",
            "link": "opportunities",
            "label": "LBL_OPPORTUNITY_ID"
        },
        "tag": {
            "type": "tag",
            "link": "tag_link",
            "studio": {
                "portal": false,
                "base": {
                    "popuplist": false
                },
                "mobile": {
                    "wirelesseditview": true,
                    "wirelessdetailview": true
                }
            },
            "sortable": false,
            "label": "LBL_TAGS"
        },
        "team_name": {
            "type": "relate",
            "link": "team_link",
            "studio": {
                "portallistview": false,
                "portalrecordview": false
            },
            "label": "LBL_TEAMS"
        },
        "base_rate": {
            "type": "text",
            "label": "LBL_CURRENCY_RATE"
        },
        "quote_num": {
            "type": "int",
            "readonly": true,
            "label": "LBL_LIST_QUOTE_NUM",
            "default": true
        },
        "name": {
            "type": "name",
            "label": "LBL_LIST_QUOTE_NAME",


"type": "name",
            "label": "LBL_LIST_QUOTE_NAME",
            "default": true,
            "link": true
        },
        "billing_account_name": {
            "type": "relate",
            "link": "billing_accounts",
            "label": "LBL_LIST_ACCOUNT_NAME",
            "default": true,
            "sortable": false
        },
        "quote_stage": {
            "type": "enum",
            "label": "LBL_QUOTE_STAGE",
            "default": true
        },
        "total": {
            "type": "currency",
            "label": "LBL_TOTAL",
            "default": true,
            "related_fields": [
                "currency_id"
            ]
        },
        "total_usdollar": {
            "type": "currency",
            "studio": {
                "wirelesseditview": false,
                "wirelessdetailview": false,
                "wirelesslistview": false,
                "wireless_basic_search": false,
                "wireless_advanced_search": false,
                "mobile": false
            },
            "related_fields": [
                "currency_id",
                "base_rate"
            ],
            "label": "LBL_LIST_AMOUNT_USDOLLAR",
            "default": true
        },
        "date_quote_expected_closed": {
            "type": "date",
            "label": "LBL_LIST_DATE_QUOTE_EXPECTED_CLOSED",
            "default": true
        },
        "assigned_user_name": {
            "link": "assigned_user_link",
            "type": "relate",
            "label": "LBL_LIST_ASSIGNED_TO_NAME",
            "default": true,
            "sortable": false
        },


"default": true,
            "sortable": false
        },
        "date_modified": {
            "type": "datetime",
            "studio": {
                "portaleditview": false
            },
            "readonly": true,
            "default": true,
            "label": "LBL_DATE_MODIFIED"
        },
        "date_entered": {
            "type": "datetime",
            "studio": {
                "portaleditview": false
            },
            "readonly": true,
            "default": true,
            "label": "LBL_DATE_ENTERED"
        }
    }
}
Change Log
Version
Change
            v11.3

            Added /Quotes/config GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/pmse_Inbox/userListByTeam/:id GET
Overview
    Deprecated endpoint.
Summary
This endpoint is deprecated and will be removed in a future release.
  	Last modified: 2023-02-03 21:04:03


/globalsearch POST
Overview
    Global search
Summary
    This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
    /search endpoint. This endpoint can be used with a long list of request arguments. Instead of using GET request
    arguments, all described arguments can be used inside a JSON encoded request body using a the GET request. If your
    client has no support for GET requests with a body, the POST method can be used as an alternative.
Request Arguments
Name
Type
Description
Required
            q

            String

            The search expression. Multiple terms can be specified at once. All enabled fields will be searched in. The
            results are ordered by relevance which is based on a multitude of settings based on token counts, hit
            ratio, (weighted) boost values and type of field. Currently no operators are supported in the search
            expression itself. By refining the search expression more relevant results will be returned as top results.
            If no search expression is given results are returned based on last modified date.

            False

            module_list

            String

            Comma delimited list of modules to search. If omitted, all search enabled modules will be queried. Note that
            when consuming the endpoint /:module/globalsearch that this parameter is ignored.

            Example: Accounts,Contacts
            False

            max_num

            Integer

            A maximum number of records to return. Default is 20.

            False

            offset

            Integer

            The number of records to skip over before records are returned. Default is 0.

            False

            highlights

            Boolean

            Wether or not to return highlighted results. Default is true.


Wether or not to return highlighted results. Default is true.

            False

            sort

            Array

            Define the sort order of the results. By default the results are returned by relevance which is the
            preferred approach. Using this argument any search enabled field can be used to sort on. Keep in mind the
            not sorting by relevance may have a negative performance impact.

            Example: {"date_modified":"desc","name":"asc"}
            False

Request
{
}
Response Arguments
Name
Type
Description
            next_offset

            Integer

            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
            records.

            records

            Array

            An array of results containing matched records.

Response
{
}
Change Log
Version
Change
            v10

            Added /globalsearch GET/POST endpoint.

            v10

            Added /:module/globalsearch GET/POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/connector/twitter/currentUser GET
Overview
    Responds with twitter timeline if connector is set up in administration
Request Arguments
Name
Type
Description
Required
count
Integer
The number of tweets to retrieve.
False
Response Arguments
Name
Type
Description
            <response>

            String

Response
[
   {
      "created_at":"Tue Jun 25 23:45:35 +0000 2013",
      "id":349674766946414592,
      "id_str":"349674766946414592",
      "text":"this tweet is awesome!",
      "source":"web",
      "truncated":false,
      "in_reply_to_status_id":null,
      "in_reply_to_status_id_str":null,
      "in_reply_to_user_id":143456975,
      "in_reply_to_user_id_str":"14934565",
      "in_reply_to_screen_name":"testdesk",
      "user":{
         "id":2630841,
         "id_str":"2630841",
         "name":"SugarCRM",
         "screen_name":"sugarcrm",
         "location":"Cupertino, CA",
         "description":"Everyone Sells. Everyone Supports. Everyone Connects.",
         "url":"http:\/\/t.co\/s9ejrBSlki",
         "entities":{
            "url":{
               "urls":[
                  {
                     "url":"http:\/\/t.co\/s9ejrBSlki",
                     "expanded_url":"http:\/\/www.sugarcrm.com",
                     "display_url":"sugarcrm.com",
                     "indices":[
                        0,
                        22
                     ]
                  }
               ]
            },
            "description":{
               "urls":[
               ]


]
            },
            "description":{
               "urls":[
               ]
            }
         },
         "protected":false,
         "followers_count":8761,
         "friends_count":6966,
         "listed_count":453,
         "created_at":"Wed Mar 28 07:16:58 +0000 2007",
         "favourites_count":27,
         "utc_offset":-28800,
         "time_zone":"Pacific Time (US \u0026 Canada)",
         "geo_enabled":false,
         "verified":false,
         "statuses_count":7488,
         "lang":"en",
         "contributors_enabled":false,
         "is_translator":false,
         "profile_background_color":"98C7EA",
         "profile_background_image_url":"http:\/\/a0.twimg.com\/profile_background_images\/551274192\/sugar-twitter-background.png",
         "profile_background_image_url_https":"https:\/\/si0.twimg.com\/profile_background_images\/551274192\/sugar-twitter-background.png",
         "profile_background_tile":false,
         "profile_image_url":"http:\/\/a0.twimg.com\/profile_images\/2027721183\/Sugar_cube_RGB_180x180_normal.png",
         "profile_image_url_https":"https:\/\/si0.twimg.com\/profile_images\/2027721183\/Sugar_cube_RGB_180x180_normal.png",
         "profile_link_color":"0045AD",
         "profile_sidebar_border_color":"FFFFFF",
         "profile_sidebar_fill_color":"CCEAFF",
         "profile_text_color":"000000",
         "profile_use_background_image":true,
         "default_profile":false,
         "default_profile_image":false,
         "following":null,
         "follow_request_sent":false,


"following":null,
         "follow_request_sent":false,
         "notifications":null
      },
      "geo":null,
      "coordinates":null,
      "place":null,
      "contributors":null,
      "retweet_count":1,
      "favorite_count":0,
      "entities":{
         "hashtags":[
         ],
         "symbols":[
         ],
         "urls":[
         ],
         "user_mentions":[
            {
               "screen_name":"testdesk",
               "name":"testdesk",
               "id":143455,
               "id_str":"ertrt75",
               "indices":[
                  0,
                  8
               ]
            }
         ],
         "media":[
         ]
      },
      "favorited":false,
      "retweeted":false,
      "possibly_sensitive":false,
      "lang":"en"
   }
]
Change Log
Version
Change
            v10

            Added /twitter/{twitterId} GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/pmse_Inbox/reassignFlows PUT
Overview
    Call methods to reassign processes
Summary
    This endpoint reassigns a collection of processes
Request Arguments
Name
Type
Description
Required
flow_data
array
Collection of flow data arrays, each containing a user_id property
true
Response Arguments
Name
Type
Description
success
boolean
Result of the reassign operation
Response
{
    "success":true,
}
  	Last modified: 2023-02-03 21:04:03


/Emails/filter POST
Overview
    Lists filtered records.
Summary
    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
    "link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
    use "members.sic_code".
Request Arguments
Name
Type
Description
Required
            filter

            String

            The filter expression. Filter expressions are explained below.

            False

            filter_id

            String

            Identifier for a preexisting filter. If filter is also set, the two
            filters are joined with an AND.

            False

            max_num

            Integer

            A maximum number of records to return. Default is 20.

            False

            offset

            Integer

            The number of records to skip over before records are returned. Default is 0.

            False

            fields

            String

            Comma delimited list of fields to return. The field date_modified will always be returned.

            Example: name,account_type,description
            False

            view

            String

            Instead of defining the fields argument, the view argument can be used instead. The field list is


constructed at the server side based on the view definition which is requested. This argument can be used
            in combination with the fields argument. Common views are "record" and "list".

            Example: record
            False

            order_by

            String

            How to sort the returned records, in a comma delimited list with the direction appended to the column name
            after a colon.

            Example: name:DESC,account_type:DESC,date_modified:ASC
            False

Filter Expressions
There are four types of filters:
Basic
    This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
    Example
{
   "filter":[
      {
         "name":"Nelson Inc"
      }
   ]
}
Full
    This expression allows you to specify what operation you want to use for filtering on the field. In the example
    you would match any record where the field "name" starts with the value "Nelson".
    Example
{
   "filter":[
      {
         "name":{
            "$starts":"Nelson"
         }
      }
   ]
}
        Below is a list of operation types:

Operation
Description
                $equals

                Performs an exact match on that field.

                $not_equals

                Performs an exact match on that field.

                $not_equals

                Matches on non-matching values.

                $starts

                Matches on anything that starts with the value.

                $ends

                Matches anything that ends with the value.

                $contains

                Matches anything that contains the value

                $in


Matches anything that contains the value

                $in

                Finds anything where field matches one of the values as specified as an array.

                $not_in

                Finds anything where field does not matches any of the values as specified as an array.

                $is_null

                Checks if the field is null. This operation does not need a value specified.

                $not_null

                Checks if the field is not null. This operation does not need a value specified.

                $lt

                Matches when the field is less than the value.

                $lte

                Matches when the field is less than or equal to the value.

                $gt

                Matches when the field is greater than the value.

                $gte

                Matches when the field is greater than or equal to the value.

Sub-expressions
    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
    The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
    accepted sub-expression types are "$and" and "$or".
    Example
{
   "filter":[
      {
         "$or":[
            {
               "name":"Nelson Inc"
            },
            {
               "name":"Nelson LLC"
            }
         ]
      }
   ]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would


filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
   "filter":[
      {
         "$favorite":"_this"
      }
   ]
}
Response Arguments
Name
Type
Description
            next_offset

            Integer

            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
            records.

            records

            Array

            An array of results containing matched records.

Response
{
   "next_offset":-1,
   "records":[
      {
         "id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
         "name":"Dale Spivey",
         "date_entered":"2013-02-26T19:12:00+00:00",
         "date_modified":"2013-02-28T05:03:00+00:00",
         "modified_user_id":"1",
         "modified_by_name":"Administrator",
         "created_by":"1",
         "created_by_name":"Administrator",
         "description":"",
         "img":"",
         "deleted":false,
         "assigned_user_id":"seed_sally_id",
         "assigned_user_name":"Sally Bronsen",
         "team_name":[
            {
               "id":"East",
               "name":"East",
               "name_2":"",
               "primary":false
            },
            {
               "id":1,
               "name":"Global",
               "name_2":"",
               "primary":false
            },
            {
               "id":"West",


"primary":false
            },
            {
               "id":"West",
               "name":"West",
               "name_2":"",
               "primary":true
            }
         ],
         "salutation":"",
         "first_name":"Dale",
         "last_name":"Spivey",
         "full_name":"Dale Spivey",
         "title":"VP Operations",
         "linkedin":"",
         "facebook":"",
         "twitter":"",
         "googleplus":"",
         "department":"",
         "do_not_call":false,
         "phone_home":"(523) 825-4311",
         "email":[
            {
               "email_address":"sugar.dev.sugar@example.co.jp",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"1"
            },
            {
               "email_address":"the.support@example.biz",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"0"
            }
         ],
         "phone_mobile":"(373) 861-0757",
         "phone_work":"(212) 542-9596",
         "phone_other":"",
         "phone_fax":"",
         "email1":"sugar.dev.sugar@example.co.jp",
         "email2":"the.support@example.biz",
         "invalid_email":false,
         "email_opt_out":false,
         "primary_address_street":"345 Sugar Blvd.",
         "primary_address_street_2":"",
         "primary_address_street_3":"",
         "primary_address_city":"Denver",
         "primary_address_state":"CA",
         "primary_address_postalcode":"87261",
         "primary_address_country":"USA",


"primary_address_country":"USA",
         "alt_address_street":"",
         "alt_address_street_2":"",
         "alt_address_street_3":"",
         "alt_address_city":"",
         "alt_address_state":"",
         "alt_address_postalcode":"",
         "alt_address_country":"",
         "assistant":"",
         "assistant_phone":"",
         "picture":"",
         "email_and_name1":"",
         "lead_source":"Campaign",
         "account_name":"Smallville Resources Inc",
         "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
         "opportunity_role_fields":"",
         "opportunity_role_id":"",
         "opportunity_role":"",
         "reports_to_id":"",
         "report_to_name":"",
         "portal_name":"DaleSpivey97",
         "portal_active":true,
         "portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
         "portal_password1":"",
         "portal_app":"",
         "preferred_language":"en_us",
         "campaign_id":"",
         "campaign_name":"",
         "c_accept_status_fields":"",
         "m_accept_status_fields":"",
         "accept_status_id":"",
         "accept_status_name":"",
         "sync_contact":"",
         "my_favorite":false,
         "_acl":{
            "fields":{
            }
         }
      },
      {
         "id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
         "name":"Florence Haddock",


"name":"Florence Haddock",
         "date_entered":"2013-02-26T19:12:00+00:00",
         "date_modified":"2013-02-26T19:12:00+00:00",
         "modified_user_id":"1",
         "modified_by_name":"Administrator",
         "created_by":"1",
         "created_by_name":"Administrator",
         "description":"",
         "img":"",
         "deleted":false,
         "assigned_user_id":"seed_sally_id",
         "assigned_user_name":"Sally Bronsen",
         "team_name":[
            {
               "id":"East",
               "name":"East",
               "name_2":"",
               "primary":false
            },
            {
               "id":1,
               "name":"Global",
               "name_2":"",
               "primary":false
            },
            {
               "id":"West",
               "name":"West",
               "name_2":"",
               "primary":true
            }
         ],
         "salutation":"",
         "first_name":"Florence",
         "last_name":"Haddock",
         "full_name":"Florence Haddock",
         "title":"Director Sales",
         "linkedin":"",
         "facebook":"",
         "twitter":"",
         "googleplus":"",
         "department":"",
         "do_not_call":false,
         "phone_home":"(729) 845-3137",
         "email":[
            {
               "email_address":"dev.vegan@example.de",
               "opt_out":"1",
               "invalid_email":"0",
               "primary_address":"0"
            },
            {


"primary_address":"0"
            },
            {
               "email_address":"section71@example.it",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"1"
            }
         ],
         "phone_mobile":"(246) 233-1382",
         "phone_work":"(565) 696-6981",
         "phone_other":"",
         "phone_fax":"",
         "email1":"section71@example.it",
         "email2":"dev.vegan@example.de",
         "invalid_email":false,
         "email_opt_out":false,
         "primary_address_street":"111 Silicon Valley Road",
         "primary_address_street_2":"",
         "primary_address_street_3":"",
         "primary_address_city":"Denver",
         "primary_address_state":"CA",
         "primary_address_postalcode":"79900",
         "primary_address_country":"USA",
         "alt_address_street":"",
         "alt_address_street_2":"",
         "alt_address_street_3":"",
         "alt_address_city":"",
         "alt_address_state":"",
         "alt_address_postalcode":"",
         "alt_address_country":"",
         "assistant":"",
         "assistant_phone":"",
         "picture":"",
         "email_and_name1":"",
         "lead_source":"Support Portal User Registration",
         "account_name":"Smallville Resources Inc",
         "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
         "opportunity_role_fields":"",
         "opportunity_role_id":"",
         "opportunity_role":"",
         "reports_to_id":"",
         "report_to_name":"",


"reports_to_id":"",
         "report_to_name":"",
         "portal_name":"FlorenceHaddock169",
         "portal_active":true,
         "portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
         "portal_password1":"",
         "portal_app":"",
         "preferred_language":"en_us",
         "campaign_id":"",
         "campaign_name":"",
         "c_accept_status_fields":"",
         "m_accept_status_fields":"",
         "accept_status_id":"",
         "accept_status_name":"",
         "sync_contact":"",
         "my_favorite":false,
         "_acl":{
            "fields":{
            }
         }
      }
   ]
}
Change Log
Version
Change
            v10

            Added /<module>/filter POST endpoint.

  	Last modified: 2023-02-03 21:04:03


/VCardDownload GET
Overview
    Downloads a vCard.
Request Arguments
Name
Type
Description
Required
            id

            String

            The id of the vcard.

            True

            module

            String

            The name of the module to get the vcard from.

            True

Request
http://{site_url}/rest/v10/VCardDownload?id=2c9e5c09-6824-0d14-f5cb-5130321ac3cf&module=Contacts
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
            <vcard information>

            String;

            Record in vcard format.

Response
BEGIN:VCARD
N;CHARSET=utf-8:Leone;Rosemarie;;
FN;CHARSET=utf-8: Rosemarie Leone
BDAY:
TEL;WORK;FAX:
TEL;HOME;CHARSET=utf-8:(692) 586-8287
TEL;CELL;CHARSET=utf-8:(117) 577-0969
TEL;WORK;CHARSET=utf-8:(844) 325-7679
EMAIL;INTERNET;CHARSET=utf-8:support.im@example.it
ADR;WORK;CHARSET=utf-8:;;777 West Filmore Ln;San Mateo;CA;74984;USA
ORG;CHARSET=utf-8:Q.R.&E. Corp;
TITLE;CHARSET=utf-8:Director Sales
END:VCARD
Change Log
Version
Change
            v10

            Added /VCardDownload GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/<module>/:record/link/:link_name/count GET
Overview
    Lists related filtered records.
Summary
    This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple
    fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has
    appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can
    be searched by specifying the field name as: "link_name.remote_field", so if you wished to search the Accounts
    module by a related member account you would use "members.sic_code".
Request Arguments
Name
Type
Description
Required
            filter

            String

            The filter expression. Filter expressions are explained below.

            False

            max_num

            Integer

            A maximum number of records to return. Default is 20.

            False

            offset

            Integer

            The number of records to skip over before records are returned. Default is 0.

            False

            fields

            String

            Comma delimited list of fields to return. The field date_modified will always be returned. This argument
            can be combined with the view argument.

            Example: name,account_type,description
            False

            view

            String

            Instead of defining the fields argument, the view argument can be used instead. The field list is
            constructed at the server side based on the view definition which is requested. This argument can be used
            in combination with the fields argument. Common views are "record" and "list".

            Example: record
            False

            order_by

            String


False

            order_by

            String

            How to sort the returned records, in a comma delimited list with the direction appended to the column name
            after a colon.

            Example: name:DESC,account_type:DESC,date_modified:ASC
            False

Filter Expressions
There are four types of filters:
Basic
    This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
    Example
{
   "filter":[
      {
         "name":"Nelson Inc"
      }
   ]
}
Full
    This expression allows you to specify what operation you want to use for filtering on the field. In the example you
    would match any record where the field "name" starts with the value "Nelson".
    Example
{
   "filter":[
      {
         "name":{
            "$starts":"Nelson"
         }
      }
   ]
}
        Below is a list of operation types:

Operation
Description
                $equals

                Performs an exact match on that field.

                $not_equals

                Performs an exact match on that field.

                $not_equals

                Matches on non-matching values.

                $starts

                Matches on anything that starts with the value.

                $ends

                Matches anything that ends with the value.

                $contains

                Matches anything that contains the value

                $in

                Finds anything where field matches one of the values as specified as an array.

                $not_in

                Finds anything where field does not matches any of the values as specified as an array.


$is_null

                Checks if the field is null. This operation does not need a value specified.

                $not_null

                Checks if the field is not null. This operation does not need a value specified.

                $lt

                Matches when the field is less than the value.

                $lte

                Matches when the field is less than or equal to the value.

                $gt

                Matches when the field is greater than the value.

                $gte

                Matches when the field is greater than or equal to the value.

Sub-expressions
    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
    The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
    accepted sub-expression types are "$and" and "$or".
    Example
{
   "filter":[
      {
         "$or":[
            {
               "name":"Nelson Inc"
            },
            {
               "name":"Nelson LLC"
            }
         ]
      }
   ]
}
Modules
    There are two module expressions, they operate on modules instead of fields. The current module can be specified by
    either using the module name "_this" or by leaving the module name as a blank string. The example expression would
    filter the records in the current module to only your favorites. The only currently accepted module expressions are
    "$favorite" and "$owner".
    Example
{
   "filter":[
      {
         "$favorite":"_this"
      }
   ]
}
Response Arguments
Name
Type
Description
            next_offset


]
}
Response Arguments
Name
Type
Description
            next_offset

            Integer

            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
            records.

            records

            Array

            An array of results containing matched records.

Repsonse
{
   "next_offset":-1,
   "records":[
      {
         "id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
         "name":"Dale Spivey",
         "date_entered":"2013-02-26T19:12:00+00:00",
         "date_modified":"2013-02-28T05:03:00+00:00",
         "modified_user_id":"1",
         "modified_by_name":"Administrator",
         "created_by":"1",
         "created_by_name":"Administrator",
         "description":"",
         "img":"",
         "deleted":false,
         "assigned_user_id":"seed_sally_id",
         "assigned_user_name":"Sally Bronsen",
         "team_name":[
            {
               "id":"East",
               "name":"East",
               "name_2":"",
               "primary":false
            },
            {
               "id":1,
               "name":"Global",
               "name_2":"",
               "primary":false
            },
            {
               "id":"West",
               "name":"West",
               "name_2":"",
               "primary":true
            }
         ],
         "salutation":"",
         "first_name":"Dale",
         "last_name":"Spivey",


"first_name":"Dale",
         "last_name":"Spivey",
         "full_name":"Dale Spivey",
         "title":"VP Operations",
         "linkedin":"",
         "facebook":"",
         "twitter":"",
         "googleplus":"",
         "department":"",
         "do_not_call":false,
         "phone_home":"(523) 825-4311",
         "email":[
            {
               "email_address":"sugar.dev.sugar@example.co.jp",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"1"
            },
            {
               "email_address":"the.support@example.biz",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"0"
            }
         ],
         "phone_mobile":"(373) 861-0757",
         "phone_work":"(212) 542-9596",
         "phone_other":"",
         "phone_fax":"",
         "email1":"sugar.dev.sugar@example.co.jp",
         "email2":"the.support@example.biz",
         "invalid_email":false,
         "email_opt_out":false,
         "primary_address_street":"345 Sugar Blvd.",
         "primary_address_street_2":"",
         "primary_address_street_3":"",
         "primary_address_city":"Denver",
         "primary_address_state":"CA",
         "primary_address_postalcode":"87261",
         "primary_address_country":"USA",
         "alt_address_street":"",
         "alt_address_street_2":"",
         "alt_address_street_3":"",
         "alt_address_city":"",
         "alt_address_state":"",
         "alt_address_postalcode":"",


"alt_address_state":"",
         "alt_address_postalcode":"",
         "alt_address_country":"",
         "assistant":"",
         "assistant_phone":"",
         "picture":"",
         "email_and_name1":"",
         "lead_source":"Campaign",
         "account_name":"Smallville Resources Inc",
         "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
         "opportunity_role_fields":"",
         "opportunity_role_id":"",
         "opportunity_role":"",
         "reports_to_id":"",
         "report_to_name":"",
         "portal_name":"DaleSpivey97",
         "portal_active":true,
         "portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
         "portal_password1":"",
         "portal_app":"",
         "preferred_language":"en_us",
         "campaign_id":"",
         "campaign_name":"",
         "c_accept_status_fields":"",
         "m_accept_status_fields":"",
         "accept_status_id":"",
         "accept_status_name":"",
         "sync_contact":"",
         "my_favorite":false,
         "_acl":{
            "fields":{
            }
         }
      },
      {
         "id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
         "name":"Florence Haddock",
         "date_entered":"2013-02-26T19:12:00+00:00",
         "date_modified":"2013-02-26T19:12:00+00:00",


"modified_user_id":"1",
         "modified_by_name":"Administrator",
         "created_by":"1",
         "created_by_name":"Administrator",
         "description":"",
         "img":"",
         "deleted":false,
         "assigned_user_id":"seed_sally_id",
         "assigned_user_name":"Sally Bronsen",
         "team_name":[
            {
               "id":"East",
               "name":"East",
               "name_2":"",
               "primary":false
            },
            {
               "id":1,
               "name":"Global",
               "name_2":"",
               "primary":false
            },
            {
               "id":"West",
               "name":"West",
               "name_2":"",
               "primary":true
            }
         ],
         "salutation":"",
         "first_name":"Florence",
         "last_name":"Haddock",
         "full_name":"Florence Haddock",
         "title":"Director Sales",
         "linkedin":"",
         "facebook":"",
         "twitter":"",
         "googleplus":"",
         "department":"",
         "do_not_call":false,
         "phone_home":"(729) 845-3137",
         "email":[
            {
               "email_address":"dev.vegan@example.de",
               "opt_out":"1",
               "invalid_email":"0",
               "primary_address":"0"
            },
            {
               "email_address":"section71@example.it",
               "opt_out":"0",
               "invalid_email":"0",
               "primary_address":"1"
            }
         ],
         "phone_mobile":"(246) 233-1382",


],
         "phone_mobile":"(246) 233-1382",
         "phone_work":"(565) 696-6981",
         "phone_other":"",
         "phone_fax":"",
         "email1":"section71@example.it",
         "email2":"dev.vegan@example.de",
         "invalid_email":false,
         "email_opt_out":false,
         "primary_address_street":"111 Silicon Valley Road",
         "primary_address_street_2":"",
         "primary_address_street_3":"",
         "primary_address_city":"Denver",
         "primary_address_state":"CA",
         "primary_address_postalcode":"79900",
         "primary_address_country":"USA",
         "alt_address_street":"",
         "alt_address_street_2":"",
         "alt_address_street_3":"",
         "alt_address_city":"",
         "alt_address_state":"",
         "alt_address_postalcode":"",
         "alt_address_country":"",
         "assistant":"",
         "assistant_phone":"",
         "picture":"",
         "email_and_name1":"",
         "lead_source":"Support Portal User Registration",
         "account_name":"Smallville Resources Inc",
         "account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
         "opportunity_role_fields":"",
         "opportunity_role_id":"",
         "opportunity_role":"",
         "reports_to_id":"",
         "report_to_name":"",
         "portal_name":"FlorenceHaddock169",
         "portal_active":true,
         "portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",


"portal_password1":"",
         "portal_app":"",
         "preferred_language":"en_us",
         "campaign_id":"",
         "campaign_name":"",
         "c_accept_status_fields":"",
         "m_accept_status_fields":"",
         "accept_status_id":"",
         "accept_status_name":"",
         "sync_contact":"",
         "my_favorite":false,
         "_acl":{
            "fields":{
            }
         }
      }
   ]
}
Change Log
Version
Change
            v10

            Added /<module>/:record/link/:link_name/filter GET endpoint.

  	Last modified: 2023-02-03 21:04:03


/pmse_Inbox/changeCaseUser/:cas_id GET
Overview
    Deprecated endpoint.
Summary
This endpoint is deprecated and will be removed in a future release.
  	Last modified: 2023-02-03 21:04:03


/pmse_Inbox/save_notes POST
Overview
    Creates a new note for a process
Summary
This endpoint creates a new note for a process
Request Arguments
Name
Type
Description
Required
data
array
Collection of data for a note containing the following:
true
data.cas_id
string
The id of the process trigger sequence
true
data.cas_index
string
The step in the process
true
data.not_content
string
The content of the note
true
data.not_type
string
The type of note, defaults to 'GENERAL'
false
Response Arguments
Name
Type
Description
success
boolean
Result of the update
id
string
Id of new note
date_entered
date
Date of creation
Response
{
    "success":true,
    "id":"06c075d0-28e7-11e6-8bb1-6c4008960436",
    "date_entered":"2016-06-02T10:25:39-07:00"
}
  	Last modified: 2023-02-03 21:04:03


/integrate/<module>/:sync_key_field_name/:sync_key_field_value PUT
Overview
Upserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it.Â Note that the PATCH method is recommended over the PUT method.
Note:Â This endpoint cannot be used to set the sync_key_field_name for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key_field_name is set for the record, then it is possible to leverage this endpoint.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_name
String
The name of the field that contains sync_key_field_value (the default field is namedÂ sync_key but can be renamed via code customization)
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/integrate/<module>/:sync_key_field_name/:sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record that was upserted.
Response
Status 201: For a created record
Status 200: For an updated record
{    record: "a0328573-a252-a27c-3530-4e4297d4c9e1"}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:sync_key_field_name/:sync_key_field_valueÂ PUT endpoint.
  	Last modified: 2023-02-03 21:04:03


/pmse_Inbox/settings PUT
Overview
    Update settings for the SugarBPMTM engine
Summary
    This endpoint updates settings for the SugarBPMTM engine
Request Arguments
Name
Type
Description
Required
data
array
Key/value map of config keys and their associated values for the SugarBPMTM engine to update
false
Response Arguments
Name
Type
Description
success
boolean
Result of update
data
object
Key/Value map of config keys and their new values
Response
{
    "success":true,
    "data":
    {
        "logger_level":"critical",
        "error_number_of_cycles":"10",
        "error_timeout":"40"
    }
}
  	Last modified: 2023-02-03 21:04:03


/pmse_Project/validateCrmData/:data/:filter GET
Overview
Validates information about Fields, Modules, Users, Roles, etc.
Summary
This endpoint will validate the existence of various data related to the Process Definition.
Request Arguments
Name
Type
Description
Required
data
String
The type of data to be retrieved
True
filter
String
Filtering criteria to be applied to data retrieved
False
key
String
Key of the entry to search for within the given data and filter
True
Request
Note: "key" should be provided in the form of a URL query string.
Example Request:
/rest/v11_10/pmse_Project/validateCrmData/field/Accounts?key=data_entered
Response Arguments
Name
Type
Description
result
Boolean
The result of the validation. True if the key exists in the specified data set; false otherwise
Response
{
    result: true
}
Change Log
Version
Change
v11_10
Added /pmse_Project/validateCrmData/:data/:filterÂ GET endpoint.
  	Last modified: 2023-02-03 21:04:03


/pmse_Business_Rules/file/businessrules_import POST
Overview
    Imports a Process Business Rules definition from a .pbr file
Summary
    This endpoint will import a Process Business Rules definition from the
    uploaded .pbr file containing JSON encoded data.
Request Arguments
Name
Type
Description
Required
N/A
Request
Note: A JSON encoded .pbr file attachment should be included with
the request as part of the form-data.
Response Arguments
Name
Type
Description
businessrules_import
Object
Result of the import operation
Response
{
    "businessrules_import":
    {
         "success":true,
         "id":"e4396c91-81cd-c097-8149-5733bab68316"
    }
}
  	Last modified: 2023-02-03 21:04:03


/<module>/filter/count GET
Overview
    Lists filtered records.
Summary
    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
    "link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
    use "members.sic_code".
Request Arguments
Name
Type
Description
Required
            filter

            String

            The filter expression. Filter expressions are explained below.

            False

            filter_id

            String

            Identifier for a preexisting filter. If filter is also set, the two
            filters are joined with an AND.

            False

            max_num

            Integer

            A maximum number of records to return. Default is 20.

            False

            offset

            Integer

            The number of records to skip over before records are returned. Default is 0.

            False

            fields

            String

            Comma delimited list of fields to return. The field date_modified will always be returned.

            Example: name,account_type,description
            False

            view

            String

            Instead of defining the fields argument, the view argument can be used instead. The field list is


constructed at the server side based on the view definition which is requested. This argument can be used
            in combination with the fields argument. Common views are "record" and "list".

            Example: record
            False

            order_by

            String

            How to sort the returned records, in a comma delimited list with the direction appended to the column name
            after a colon.

            Example: name:DESC,account_type:DESC,date_modified:ASC
            False

Filter Expressions
There are four types of filters:
Basic
    This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
    Example
{
   "filter":[
      {
         "name":"Nelson Inc"
      }
   ]
}
Full
    This expression allows you to specify what operation you want to use for filtering on the field. In the example
    you would match any record where the field "name" starts with the value "Nelson".
    Example
{
   "filter":[
      {
         "name":{
            "$starts":"Nelson"
         }
      }
   ]
}
        Below is a list of operation types:

Operation
Description
                $equals

                Performs an exact match on that field.

                $not_equals

                Performs an exact match on that field.

                $not_equals

                Matches on non-matching values.

                $starts

                Matches on anything that starts with the value.

                $ends

                Matches anything that ends with the value.

                $contains

                Matches anything that contains the value

                $in