Overview
Lists Deals for an account based on information sent via an http form post.
Post Url
https://www.allclients.com/api/2/GetDeals.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Form Fields
| Field | Max Length* | Required | Notes |
| response_type | No | Default results will be returned in XML. Set this field value to json to return results in JSON format | |
| accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| teammemberid | No | Must be numeric. ID of Team Member database that deal record belongs to. Leave blank for all account contacts. | |
| status | 1 | No | Filters query based on the deal status (Optional)Possible Values: 1 = Active, 2 = Won, 3 = Lost, 4=Back Burner |
| dealid | No | Filters query based on a specific deal(Optional) | |
| dealtypeid | No | Filters query based on the dealtypeid (Optional) | |
| dealtypename | No | Filters query based on the name of the deal type (Optional) | |
| adddateafter | No |
Enter a date is US Date / Time Format example: 4/24/2013 2:01PM
Only deals added after the date given will be returned.
4/24/2013 assumes midnight, so anything added on or after 4/24/2013 would be included.
Time Zone for Add Date is US Central Time
|
|
| closeddateafter | No |
Enter a date is US Date example: 4/24/2013
Only deals with a CLOSED DATE on or after the date given will be returned.
|
|
| closeddatebefore | No |
Enter a date is US Date example: 4/24/2013
Only deals with a CLOSED DATE on or before the date given will be returned.
|
|
| customfields | No | Set value to 1 to include each deal’s custom fields in the results (new Feb 2015) | |
| relatedcontacts | No | Set value to 1 to include each deal’s related contacts in the results (new Sept 2015) |
Sample Results
Success Message
<results> <deals> <deal> <dealid>10001</dealid> <dealtypeid>2</dealtypeid> <dealtype>Computer Sales</dealtype> <dealstage>New Lead</dealstage> <status>Active</status> <name>Smith New Server</name> <amount>2,100.00</amount> <commission>210.00</commission> <probability>.75</probability> <nextstep>Call to confirm order</nextstep> <editdate>10/21/2013</editdate> <adddate>10/21/2013</adddate> <expectedclosedate>11/1/2013</expectedclosedate> <closeddate>10/13/2013</closeddate> <primarycontactid>2324</primarycontactid> </deal> </deals> </results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>
