id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
fef4fb939099-0 | /<module>/file/vcard_import POST
Overview
Imports a person record from a vcard.
Request Arguments
Name
Type
Description
Required
format
String
The data format. Currently accepts 'sugar-html-json'.
True
module
String
The name of the module to import the vcard to.
True
file
String
The vcard contents.
True
Request
{
"format":"sugar-html-json",
"module":"Contacts"
"file":"@\/path\/to\/ExampleContact.vcf"
}
Response Arguments
Name
Type
Description
file
String
The id of the imported vcard.
Response
{
"file":"2c9e5c09-6824-0d14-f5cb-5130321ac3cf"
}
Change Log
Version
Change
v10
Added /<module>/file/vcard_import POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilevcard_import_POST/index.html |
592347db2f1a-0 | /<module> 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.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: filter[0][id]=1.
By specifying the whole filter as a single JSON-encoded string.
Note that this syntax is currently not supported on certain modules.
Example: filter=[{"id":"1"}].
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html |
592347db2f1a-1 | 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. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","fields":["id","name","sales_status"],"order_by":"date_closed:desc"}
For more details on additional field parameters, see
Relate API and
Collection API.
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
q
String
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
nulls_last
Boolean | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html |
592347db2f1a-2 | False
nulls_last
Boolean
Boolean to return records with null values in order_by fields last in the result set.
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html |
592347db2f1a-3 | $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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html |
592347db2f1a-4 | ]
}
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_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities",
"id": "b0701501-1fab-8ae7-3942-540da93f5017",
"name": "360 Vacations - 228 Units",
"date_modified": "2014-09-08T16:05:00+03:00",
"sales_status": "New"
},
],
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html |
592347db2f1a-5 | {
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html |
8f8e170defab-0 | /integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PATCH
Overview
Sets a sync key value for a record.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
record_id
String
The ID of the record whose sync key will be set
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>/:record_id/:sync_key_field_name/:sync_key_field_value
Response
{"success": true}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PATCH endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulerecord_idsync_key_field_namesync_key_field_value_PATCH/index.html |
791ac2baf9c6-0 | /<module>/audit/export GET
Overview
Returns a list of data changes for a specific module.
Request Arguments
Name
Type
Description
Required
module
String
The name of the module.
True
Query Parameters
Name
Type
Description
Required
max_num
Integer
A maximum number of Audit records to return. The default is 100 records.
False
offset
Integer
The number of records to skip over before records are returned. The default is 0.
False
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":"b569e480-237a-5921-4382-512ff555fee7",
"parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
"date_created":"03\/01\/2013 12:26am",
"created_by":"admin",
"field_name":"Team ID:",
"data_type":"team_list",
"before_value_string":"East",
"after_value_string":"Will"
},
{
"id":"bc0bee72-8398-a0a6-d731-512ff5bfebc7",
"parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
"date_created":"03\/01\/2013 12:26am",
"created_by":"admin",
"field_name":"Teams",
"data_type":"id", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleauditexport_GET/index.html |
791ac2baf9c6-1 | "field_name":"Teams",
"data_type":"id",
"before_value_string":"East, Global, West",
"after_value_string":"Jim, Will"
}
]
}
Change Log
Version
Change
v11_11
Added /<module>/audit/export GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleauditexport_GET/index.html |
b99c60f182fc-0 | /Opportunities/config POST
Overview
Opportunity Config Save
Summary
This saves the config changes to the Opportunity Module, when the opps_view_by attribute changes, it will perform the nessicary migrations for the Metadata and the actual Data.
Request Arguments
Name
Type
Description
Required
<config field>
<config field type>
The list of config fields to update.
False
Request
{
"MyConfigOption":"MyConfigValue"
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"MyConfigOption":"MyConfigValue"
}
Change Log
Version
Change
v10
Added /Opportunities/config POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesconfig_POST/index.html |
46d7f13607bd-0 | /Administration/elasticsearch/replicas/status GET
Overview
[ADMIN] Elasticsearch index replica status
Summary
This endpoint returns the number of replicas for every index managed by SugarCRM. This endpoint is only
available to administrators.
Response
{
"aabbcc_contactsleads": "4",
"aabbcc_accountsonly": "2",
"aabbcc_shared": "1"
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/replicas/status GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchreplicasstatus_GET/index.html |
ea9f394c46dd-0 | /pmse_Inbox GET
Overview
Returns a list of Processes by user using filters
Summary
This endpoint gets a list of processes by user using filters
Request Arguments
Name
Type
Description
Required
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.
false
q
string
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
false
filter
string
The filter expression
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
false
deleted
boolean
Boolean to show deleted records in the result set.
false
Response Arguments
Name
Type
Description
records
<field>:<value>
Process records
next_offset
integer
Next offset for results
Response
{
"next_offset":-1,
"records":
[
{
"id":"839ccd22-2925-11e6-83f3-6c4008960436",
"date_modified":"2016-06-02T17:52:55-07:00",
"created_by":"1",
"cas_finish_date":"",
"assigned_user_id":"1",
"assigned_user_name":"Administrator",
"assigned_user_link":
{
"full_name":"Administrator",
"id":"1",
"_acl":
{
"fields": | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html |
ea9f394c46dd-1 | "id":"1",
"_acl":
{
"fields":
{
"pwd_last_changed":
{
"write":"no",
"create":"no"
},
"last_login":
{
"write":"no",
"create":"no"
}
},
"delete":"no",
"_hash":"08b99a97c2e8d792f7a44d8882b5af6d"
}
},
"_acl":
{
"fields":{}
},
"_module":"pmse_Project\/pmse_BpmFlow",
"_locked_fields":[],
"cas_id":"4",
"act_assignment_method":"static",
"cas_title":"PQR1",
"pro_title":"PD1",
"date_entered":"2016-06-02T17:52:55-07:00",
"name":"PQR1",
"cas_create_date":"2016-06-02T17:52:55-07:00",
"flow_id":"839ccd22-2925-11e6-83f3-6c4008960436",
"id2":"8380e512-2925-11e6-9600-6c4008960436",
"task_name":"Activity # 1",
"cas_assignment_method":"static",
"cas_sugar_module":"Accounts",
"cas_sugar_object_id":"82d5c470-2925-11e6-a269-6c4008960436",
"prj_id":"6e025038-2842-11e6-b4f7-6c4008960436", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html |
ea9f394c46dd-2 | "in_time":true,
"cas_user_id":"1",
"prj_created_by":"1",
"cas_user_id_full_name":"Administrator",
"prj_user_id_full_name":"Administrator"
},
]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html |
b543e74905af-0 | /<module>/:record/link/:link_name/filter/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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html |
b543e74905af-1 | 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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html |
b543e74905af-2 | $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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html |
b543e74905af-3 | ]
}
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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html |
b543e74905af-4 | "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":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"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":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html |
b543e74905af-5 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html |
b543e74905af-6 | "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":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html |
b543e74905af-7 | ],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html |
b543e74905af-8 | "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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html |
c034cc506073-0 | /<module>/:record/movelast/:target PUT
Overview
Move existing node as last child of target node.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
target
String
The ID of record that will be used as target to move node as last child
True
Response Arguments
This endpoint does not return any response arguments.
Response
This endpoint return a record GUID that was moved
"1b7b868d-7357-2e29-7513-54169bdc444d"
Change Log
Version
Change
v10
Added /<module>/movelast/:target PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordmovelasttarget_PUT/index.html |
d1566d1b0ade-0 | /pmse_Project/:record/dproject GET
Overview
Exports a .bpm file with a Process Definition
Summary
This endpoint will retrieve a .bpm file containing JSON encoded data of a
Process Definition identified by the record input parameter.
Request Arguments
Name
Type
Description
Required
record
String
The Process Definition record ID
True
Response Arguments
Name
Type
Description
N/A
Response
Note: The response is a MIME type application/bpm file attachment without any response parameters.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectrecorddproject_GET/index.html |
1f01d0584b35-0 | /Reports/:record/record_count GET
Overview
An API to get total number of filtered records from a saved report.
Summary
This endpoint will return total number of records from a saved report filtered by an expression.
Request Arguments
Name
Type
Description
Required
group_filters
String
The group filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: group_filters[0][name]=value.
By specifying the whole filter as a single JSON-encoded string.
Example: group_filters=[{"name":"value"}].
Example: group_filters[0][industry]=Engineering.
False
use_saved_filters
Boolean
Flag to indicate whether or not to apply saved runtime filters if exists. The default value is false.
Example: use_saved_filters=true.
False
Request Example
GET /rest/v10/Reports/:id/record_count?group_filters[0][industry]=Engineering
Response Arguments
Name
Type
Description
record_count
Integer
Total number of filtered records.
Response
{
"record_count": 5
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecord_count_GET/index.html |
f9d19226146f-0 | /me/preference/:preference_name DELETE
Overview
Deletes a specific preference for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preference/:preference_name DELETE endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferencepreference_name_DELETE/index.html |
6441e96a960c-0 | /Administration/elasticsearch/queue GET
Overview
[ADMIN] Elasticsearch queue statistics
Summary
This endpoint returns the queue statistics for the Elasticsearch backend. This endpoint is only available to
administrators.
Response
{
"total":2238,
"queued":{
"Cases":"250",
"KBDocuments":"5",
"Notes":"50",
"Quotes":"2",
"Accounts":"51",
"Contacts":"201",
"Leads":"201",
"Opportunities":"150",
"RevenueLineItems":"578",
"Bugs":"50",
"Contracts":"2",
"Manufacturers":"2",
"ProductCategories":"43",
"Tasks":"200",
"Calls":"50",
"Emails":"200",
"Meetings":"200",
"Products":"3"
}
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/queue GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchqueue_GET/index.html |
eeb735279e4d-0 | /Forecasts GET
Overview
Updates a record of a specified type as a favorite for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the selected record.
Response
{
"id":"bdd59d85-687b-1739-b00a-512d09f6db9e",
"name":"Insight Marketing Inc",
"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":"",
"last_activity_date":"2013-02-26T19:12:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"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
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html |
eeb735279e4d-1 | "facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Electronics",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"345 Sugar Blvd.",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Mateo",
"billing_address_state":"CA",
"billing_address_postalcode":"56019",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(927) 136-9572",
"phone_alternate":"",
"website":"www.sectionvegan.de",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"345 Sugar Blvd.",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Mateo",
"shipping_address_state":"CA",
"shipping_address_postalcode":"56019",
"shipping_address_country":"USA",
"email1":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html |
eeb735279e4d-2 | "email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":true,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/favorite PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html |
168d14b2ff1f-0 | /recent GET
Overview
Returns all of the current users recently viewed records.
Request Arguments
Name
Type
Description
Required
module_list
String
Comma delimited list of modules to return recently viewed records.
Example: Accounts,Contacts
True
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned.
Example: id,name
False
date
String
The date expression. Filter recently viewed records from this date.
False
limit
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
Request
http://{site_url}/rest/v10/recent?module_list=Accounts%2CContacts
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
next_offset
String
The next offset to start fetching additional records.
records
Array
An array of recently viewed records.
Response
{
"next_offset":-1,
"records":[
{
"my_favorite":false,
"following":false,
"id":"e4213959-35cd-119b-5cd6-5342e8be16f6",
"name":"Leila Purifoy",
"date_entered":"2014-04-07T13:58:50-04:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html |
168d14b2ff1f-1 | "date_modified":"2014-04-07T13:58:50-04:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"assigned_user_id":"seed_will_id",
"assigned_user_name":"Will Westin",
"team_count":"",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":true
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":false
}
],
"email":[
{
"email_address":"[email protected]",
"invalid_email":false,
"opt_out":true,
"primary_address":false,
"reply_to_address":false
},
{
"email_address":"[email protected]",
"invalid_email":false,
"opt_out":false,
"primary_address":true,
"reply_to_address":true
}
],
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"email_addresses_non_primary":"",
"salutation":"",
"first_name":"Leila",
"last_name":"Purifoy",
"full_name":"Leila Purifoy",
"title":"President",
"facebook":"",
"twitter":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html |
168d14b2ff1f-2 | "title":"President",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(841) 469-8223",
"phone_mobile":"(286) 010-9553",
"phone_work":"(369) 075-2809",
"phone_other":"",
"phone_fax":"",
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Santa Monica",
"primary_address_state":"NY",
"primary_address_postalcode":"52255",
"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":"Trade Show",
"account_name":"Sea Region Inc",
"account_id":"b1cd3a55-7e84-e53b-954e-5342e85b63f1",
"dnb_principal_id":"",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"birthdate":"",
"portal_name":"LeilaPurifoy5",
"portal_active":true,
"portal_password":true, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html |
168d14b2ff1f-3 | "portal_active":true,
"portal_password":true,
"portal_password1":null,
"portal_app":"",
"preferred_language":"",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"accept_status_calls":"",
"accept_status_meetings":"",
"sync_contact":false,
"mkto_sync":false,
"mkto_id":null,
"mkto_lead_score":null,
"_acl":{
"fields":{
}
},
"_module":"Contacts",
"_last_viewed_date":"2014-04-07T14:43:46-04:00"
},
{
"my_favorite":false,
"following":false,
"id":"e8f7eb6d-2647-7e57-df30-5342e83c622d",
"name":"Draft Diversified Energy Inc",
"date_entered":"2014-04-07T13:58:50-04:00",
"date_modified":"2014-04-07T13:58:50-04:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_count":"",
"team_name":[
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html |
168d14b2ff1f-4 | "team_count":"",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"email":[
{
"email_address":"[email protected]",
"invalid_email":false,
"opt_out":false,
"primary_address":true,
"reply_to_address":false
},
{
"email_address":"[email protected]",
"invalid_email":false,
"opt_out":false,
"primary_address":false,
"reply_to_address":false
}
],
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"email_addresses_non_primary":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Education",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"111 Silicon Valley Road",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"Los Angeles",
"billing_address_state":"CA",
"billing_address_postalcode":"26022",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(790) 406-0049",
"phone_alternate":"",
"website":"www.phonesugar.de",
"ownership":"",
"employees":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html |
168d14b2ff1f-5 | "ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"111 Silicon Valley Road",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"Los Angeles",
"shipping_address_state":"CA",
"shipping_address_postalcode":"26022",
"shipping_address_country":"USA",
"parent_id":"",
"sic_code":"",
"duns_num":"",
"parent_name":"",
"campaign_id":"",
"campaign_name":"",
"_acl":{
"fields":{
}
},
"_module":"Accounts",
"_last_viewed_date":"2014-04-07T14:43:36-04:00"
}
]
}
Change Log
Version
API
Change
7.2.0
v10
Added /recent GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html |
cf53f4e31c36-0 | /pmse_Inbox/engine_route PUT
Overview
Evaluates the response of the user form Show Process [Approve, Reject, Route]
Summary
This endpoint handles Approve, Reject and Route actions for a process record.
Request Arguments
Name
Type
Description
Required
frm_action
string
The action to take when it comes to routing the record.
true
Response Arguments
Name
Type
Description
success
boolean
Result of the routing operation
Response
{
"success":true,
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxengine_route_PUT/index.html |
3b19c625b9a8-0 | /pmse_Project/EventDefinition/:record GET
Overview
Retrieves the definition data for an event
Summary
This endpoint will retrieve the JSON encoded definition data for the Process
Definition event identified by the record input parameter.
Request Arguments
Name
Type
Description
Required
record
String
The value for the evn_uid field in the pmse_bpmn_event record
True
Request
Note: Additional input parameters can be provided in the form
of a URL query string.
/rest/v11/pmse_Project/EventDefinition/632263607573cb74a582507093735454?related=modules
Response Arguments
Name
Type
Description
<field>
<value>
Field value in the pmse_bpmn_activity record
Response
{
"id":"80a37c82-8be8-c668-a547-573cb791b905",
"name":"",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:42",
"created_by":"1",
"description":null,
"deleted":"0",
"evn_status":"ACTIVE",
"evn_type":"START",
"evn_module":"Accounts",
"evn_criteria":"",
"evn_params":"new",
"evn_script":"",
"execution_mode":"DEFAULT",
"au_first_name":null,
"au_last_name":null,
"cbu_first_name":null,
"cbu_last_name":"Administrator",
"mbu_first_name":null,
"mbu_last_name":"Administrator",
"my_favorite":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html |
3b19c625b9a8-1 | "mbu_last_name":"Administrator",
"my_favorite":null,
"evn_uid":"632263607573cb74a582507093735454",
"related":
{
"modules":
[
{
"value":"Accounts",
"text":"Accounts"
},
{
"value":"Bugs",
"text":"Bugs"
},
{
"value":"Calls",
"text":"Calls"
},
{
"value":"Campaigns",
"text":"Campaigns"
},
{
"value":"Cases",
"text":"Cases"
},
{
"value":"Contacts",
"text":"Contacts"
},
{
"value":"Contracts",
"text":"Contracts"
},
{
"value":"Documents",
"text":"Documents"
},
{
"value":"KBContents",
"text":"Knowledge Base"
},
{
"value":"Leads",
"text":"Leads"
},
{
"value":"Meetings",
"text":"Meetings"
},
{
"value":"Notes",
"text":"Notes"
},
{
"value":"Opportunities",
"text":"Opportunities"
},
{
"value":"ProductTemplates",
"text":"Product Catalog"
},
{
"value":"ProjectTask",
"text":"Project Tasks"
},
{
"value":"Project",
"text":"Projects"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html |
3b19c625b9a8-2 | "value":"Project",
"text":"Projects"
},
{
"value":"Products",
"text":"Quoted Line Items"
},
{
"value":"Quotes",
"text":"Quotes"
},
{
"value":"RevenueLineItems",
"text":"Revenue Line Items"
},
{
"value":"Prospects",
"text":"Targets"
},
{
"value":"Tasks",
"text":"Tasks"
}
]
}
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html |
4adc7adaaf62-0 | /<module>/:record/link/:link_name 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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
4adc7adaaf62-1 | 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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
4adc7adaaf62-2 | $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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
4adc7adaaf62-3 | ]
}
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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
4adc7adaaf62-4 | "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":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"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":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
4adc7adaaf62-5 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
4adc7adaaf62-6 | "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":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
4adc7adaaf62-7 | ],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
4adc7adaaf62-8 | "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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html |
b0a8111c28ce-0 | /OutboundEmail POST
Overview
Create a new OutboundEmail configuration to use to send emails over SMTP.
Summary
Each configuration that is created is validated first by attempting to connect to the server.
Request Arguments
Name
Type
Description
Required
name
String
The display name of the configuration.
True
mail_sendtype
String
Only SMTP is supported. This field is defaulted to smtp.
False
mail_smtptype
String
The email provider through which emails are sent. This is merely a convenience which allows for
prepopulating data in the UI. Possible values are: google, exchange, outlook, other. other is the
default.
False
mail_smtpserver
String
The address of the SMTP server.
True
mail_smtpport
Integer
The port on which to connect to the SMTP server. The default is 465, which assumes you are using
SSL.
False
mail_smtpuser
String
The username for authenticating with the SMTP server. It is only required if mail_smtpauth_req is
true.
False
mail_smtppass
String
The password for authenticating with the SMTP server. It is only required if mail_smtpauth_req is
true.
False
mail_smtpauth_req
Boolean
Indicates whether or not the SMTP server requires authentication. The default is false.
False
mail_smtpssl | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmail_POST/index.html |
b0a8111c28ce-1 | False
mail_smtpssl
String
The encryption protocol used for connecting to the SMTP server. "0" represents no encryption.
"1" represents SSL. "2" represents TLS. The default is SSL.
False
Request
{
"name": "My Exchange Account",
"mail_smtptype": "exchange",
"mail_smtpserver": "smtp.example.com",
"mail_smtpport": 465,
"mail_smtpuser": "[email protected]",
"mail_smtppass": "P@55w0rd",
"mail_smtpauth_req": true,
"mail_smtpssl": "1"
}
Response Arguments
Name
Type
Description
name
String
The display name of the configuration.
type
String
Only user configuration may be created using this endpoint, so user will always be
returned. system and system-override configurations are always created by the application.
user_id
String
The current user's ID. The current user may only create configurations for himself or herself.
mail_sendtype
String
Only SMTP is supported, so smtp will always be returned.
mail_smtptype
String
The email provider through which emails are sent. Possible values are: google, exchange, outlook, other.
mail_smtpserver
String
The address of the SMTP server.
mail_smtpport
Integer
The port on which to connect to the SMTP server. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmail_POST/index.html |
b0a8111c28ce-2 | Integer
The port on which to connect to the SMTP server.
mail_smtpuser
String
The username for authenticating with the SMTP server.
mail_smtppass
Boolean
Indicates whether or not a password exists. true is returned for this field when a password does
exist. This field is not included in the response when a password does not exist.
mail_smtpauth_req
Boolean
Indicates whether or not the SMTP server requires authentication.
mail_smtpssl
String
The encryption protocol used for connecting to the SMTP server.
Response
{
"id": "e04ce998-960e-11e6-8628-3c15c2d582c6",
"name": "My Exchange Account",
"type": "user",
"user_id": "e91b1fa7-1bd8-3c71-be96-512e643f9ca4",
"mail_sendtype": "smtp",
"mail_smtptype": "exchange",
"mail_smtpserver": "smtp.example.com",
"mail_smtpport": 465,
"mail_smtpuser": "[email protected]",
"mail_smtppass": true,
"mail_smtpauth_req": true,
"mail_smtpssl": "1",
"deleted": false,
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "OutboundEmail"
}
Change Log
Version
Change
v10
Added /OutboundEmail POST endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmail_POST/index.html |
b0a8111c28ce-3 | Version
Change
v10
Added /OutboundEmail POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmail_POST/index.html |
f560111a823b-0 | /Quotes/config GET
Overview
Quote Config GET Help
Summary
This endpoint returns dependent and related fields for all fields used in the Quoted Line Items
area of the Quote record.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"summary_columns": [
{
"name": "deal_tot",
"label": "LBL_LIST_DEAL_TOT",
"css_class": "quote-totals-row-item",
"related_fields": [
"deal_tot_discount_percentage"
],
"type": "currency",
"labelModule": "Quotes"
},
{
"name": "new_sub",
"css_class": "quote-totals-row-item",
"type": "currency",
"label": "LBL_NEW_SUB",
"labelModule": "Quotes"
},
{
"name": "tax",
"label": "LBL_TAX_TOTAL",
"css_class": "quote-totals-row-item",
"type": "currency",
"labelModule": "Quotes"
},
{
"name": "shipping",
"css_class": "quote-totals-row-item",
"type": "currency",
"label": "LBL_SHIPPING",
"labelModule": "Quotes"
},
{
"name": "total",
"label": "LBL_LIST_GRAND_TOTAL",
"css_class": "quote-totals-row-item",
"type": "currency", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-1 | "type": "currency",
"labelModule": "Quotes"
}
],
"worksheet_columns": [
{
"name": "line_num",
"label": null,
"widthClass": "cell-xsmall",
"css_class": "line_num tcenter",
"type": "line-num",
"readonly": true
},
{
"name": "quantity",
"label": "LBL_QUANTITY",
"widthClass": "cell-small",
"css_class": "quantity",
"type": "float",
"labelModule": "Products"
},
{
"name": "product_template_name",
"label": "LBL_ITEM_NAME",
"widthClass": "cell-large",
"type": "quote-data-relate",
"required": true,
"labelModule": "Quotes"
},
{
"name": "mft_part_num",
"label": "LBL_MFT_PART_NUM",
"type": "base",
"labelModule": "Products"
},
{
"name": "discount_price",
"label": "LBL_DISCOUNT_PRICE",
"type": "currency",
"convertToBase": true,
"showTransactionalAmount": true,
"related_fields": [
"discount_price",
"currency_id",
"base_rate"
],
"labelModule": "Products"
},
{
"name": "discount",
"type": "fieldset",
"css_class": "quote-discount-percent",
"label": "LBL_DISCOUNT_AMOUNT",
"fields": [
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-2 | "label": "LBL_DISCOUNT_AMOUNT",
"fields": [
{
"name": "discount_amount",
"label": "LBL_DISCOUNT_AMOUNT",
"type": "discount",
"convertToBase": true,
"showTransactionalAmount": true
},
{
"type": "discount-select",
"name": "discount_select",
"no_default_action": true,
"buttons": [
{
"type": "rowaction",
"name": "select_discount_amount_button",
"label": "LBL_DISCOUNT_AMOUNT",
"event": "button:discount_select_change:click"
},
{
"type": "rowaction",
"name": "select_discount_percent_button",
"label": "LBL_DISCOUNT_PERCENT",
"event": "button:discount_select_change:click"
}
],
"label": "LBL_DISCOUNT_AS_PERCENT"
}
],
"labelModule": "Products"
},
{
"name": "total_amount",
"label": "LBL_LINE_ITEM_TOTAL",
"type": "currency",
"widthClass": "cell-medium",
"showTransactionalAmount": true,
"related_fields": [
"total_amount",
"currency_id",
"base_rate"
],
"labelModule": "Quotes"
}
],
"footer_rows": [
{
"name": "new_sub",
"type": "currency"
},
{
"name": "tax",
"type": "currency"
},
{
"name": "shipping", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-3 | },
{
"name": "shipping",
"type": "quote-footer-currency",
"css_class": "quote-footer-currency",
"default": "0.00"
},
{
"name": "total",
"type": "currency",
"css_class": "grand-total"
}
],
"summary_columns_related_fields": [
"base_rate",
"deal_tot",
"deal_tot_usdollar",
"shipping",
"subtotal",
"subtotal_usdollar",
"tax",
"taxable_subtotal"
],
"worksheet_columns_related_fields": [
"base_rate",
"deal_calc",
"discount_amount",
"discount_price",
"discount_select",
"quantity",
"subtotal",
"tax_class",
"total_amount",
"description",
"quote_id",
"name",
"product_template_id",
"product_template_name"
],
"footer_rows_related_fields": [
"deal_tot",
"deal_tot_usdollar",
"shipping",
"subtotal",
"subtotal_usdollar",
"tax",
"taxable_subtotal"
],
"dependentFields": {
"Quotes": {
"currency_id": {
"related": {
"subtotal": {
"module": "Quotes",
"field": "subtotal",
"reason": "related_fields"
},
"discount": {
"module": "Quotes",
"field": "discount",
"reason": "related_fields"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-4 | "field": "discount",
"reason": "related_fields"
},
"new_sub": {
"module": "Quotes",
"field": "new_sub",
"reason": "related_fields"
},
"tax": {
"module": "Quotes",
"field": "tax",
"reason": "related_fields"
},
"shipping": {
"module": "Quotes",
"field": "shipping",
"reason": "related_fields"
},
"subtotal_usdollar": {
"module": "Quotes",
"field": "subtotal_usdollar",
"reason": "related_fields"
}
}
},
"base_rate": {
"related": {
"subtotal": {
"module": "Quotes",
"field": "subtotal",
"reason": "related_fields"
},
"discount": {
"module": "Quotes",
"field": "discount",
"reason": "related_fields"
},
"new_sub": {
"module": "Quotes",
"field": "new_sub",
"reason": "related_fields"
},
"tax": {
"module": "Quotes",
"field": "tax",
"reason": "related_fields"
},
"shipping": {
"module": "Quotes",
"field": "shipping",
"reason": "related_fields"
},
"subtotal_usdollar": {
"module": "Quotes",
"field": "subtotal_usdollar",
"reason": "related_fields"
}
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-5 | "reason": "related_fields"
}
},
"locked": {
"subtotal_usdollar": {
"module": "Quotes",
"field": "subtotal_usdollar",
"reason": "formula"
},
"deal_tot_usdollar": {
"module": "Quotes",
"field": "deal_tot_usdollar",
"reason": "formula"
}
}
},
"taxable_subtotal": {
"locked": {
"tax": {
"module": "Quotes",
"field": "tax",
"reason": "formula"
}
},
"related": {
"tax": {
"module": "Quotes",
"field": "tax",
"reason": "related_fields"
}
}
},
"taxrate_value": {
"locked": {
"tax": {
"module": "Quotes",
"field": "tax",
"reason": "formula"
}
},
"related": {
"tax": {
"module": "Quotes",
"field": "tax",
"reason": "related_fields"
}
}
},
"subtotal_usdollar": {
"locked": {
"deal_tot_discount_percentage": {
"module": "Quotes",
"field": "deal_tot_discount_percentage",
"reason": "formula"
}
}
},
"subtotal": {
"locked": {
"subtotal_usdollar": {
"module": "Quotes",
"field": "subtotal_usdollar", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-6 | "module": "Quotes",
"field": "subtotal_usdollar",
"reason": "formula"
}
}
},
"deal_tot_usdollar": {
"locked": {
"deal_tot_discount_percentage": {
"module": "Quotes",
"field": "deal_tot_discount_percentage",
"reason": "formula"
}
}
},
"deal_tot": {
"locked": {
"deal_tot_usdollar": {
"module": "Quotes",
"field": "deal_tot_usdollar",
"reason": "formula"
}
}
},
"tax": {
"locked": {
"total": {
"module": "Quotes",
"field": "total",
"reason": "formula"
}
}
},
"shipping": {
"locked": {
"total": {
"module": "Quotes",
"field": "total",
"reason": "formula"
}
}
}
},
"ProductBundles": {
"subtotal": {
"locked": {
"new_sub": {
"module": "ProductBundles",
"field": "new_sub",
"reason": "formula"
}
}
},
"currency_id": {
"related": {
"subtotal": {
"module": "ProductBundles",
"field": "subtotal",
"reason": "related_fields"
},
"deal_tot": {
"module": "ProductBundles",
"field": "deal_tot", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-7 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-8 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-9 | },
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-10 | "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" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-11 | "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"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-12 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-13 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-14 | },
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-15 | "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"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-16 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-17 | },
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-18 | },
"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"
}
}
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-19 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-20 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-21 | "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"
}
}
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-22 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-23 | },
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-24 | "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": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-25 | "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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-26 | "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": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-27 | },
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-28 | "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"
] | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-29 | "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"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-30 | "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": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-31 | },
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-32 | },
"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"
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-33 | "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": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-34 | },
"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" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-35 | "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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-36 | "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
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
f560111a823b-37 | "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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html |
8cb4fac91111-0 | /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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxuserListByTeamid_GET/index.html |
9f0f0aca3caa-0 | /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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_POST/index.html |
9f0f0aca3caa-1 | 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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_POST/index.html |
5d58541d4bdb-0 | /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":[
] | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html |
5d58541d4bdb-1 | ]
},
"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, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html |
5d58541d4bdb-2 | "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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html |
5a975fb3a45d-0 | /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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxreassignFlows_PUT/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.