POST api/2.0/crm/opportunity
Важно
Для этой функции требуется аутентификация.
Описание
Создает возможно сделку с параметрами, указанными в запросе.
Параметры
| Название | Описание | Тип | Пример |
| contactid sent in body |
Идентификатор основного контакта возможной сделки | номер | 1234 |
| members sent in body |
Участники возможной сделки Необязательно |
Collection of numbers collection |
1234 |
| title sent in body |
Название возможной сделки | строковый | some text |
| description sent in body |
Описание возможной сделки Необязательно |
строковый | some text |
| responsibleid sent in body |
Идентификатор ответственного за возможную сделку | guid | 9924256A-739C-462b-AF15-E652A3B1B6EB |
| bidType sent in body |
Тип ставки Допустимые значения: FixedBid, PerHour, PerDay,PerWeek, PerMonth, PerYear |
FixedBid, PerHour, PerDay, PerWeek, PerMonth, PerYear | |
| bidValue sent in body |
Сумма транзакций Необязательно |
System.Decimal | |
| bidCurrencyAbbr sent in body |
Валюта (аббревиатура) Допустимые значения: EUR, RUB и т.д. Весь список доступных валют можно получить по API |
строковый | some text |
| perPeriodValue sent in body |
Сумма за период | номер | 1234 |
| stageid sent in body |
Идентификатор этапа | номер | 1234 |
| successProbability sent in body |
Вероятность успеха возможной сделки Необязательно |
номер | 1234 |
| actualCloseDate sent in body |
Фактическая дата закрытия возможной сделки Необязательно |
дата и время | Roundtrip format: 2008-04-10T06-30-00.000Z |
| expectedCloseDate sent in body |
Ожидаемая дата закрытия возможной сделки Необязательно |
дата и время | Roundtrip format: 2008-04-10T06-30-00.000Z |
| customFieldList sent in body |
Список пользовательских полей Необязательно |
Collection of ASC.Api.Collections.ItemKeyValuePair`2[System.Int32,System.String]s collection |
|
| isPrivate sent in body |
Конфиденциальность возможной сделки: частная или нет | логический | истина |
| accessList sent in body |
Список пользователей с правами доступа к возможной сделки Необязательно |
Collection of guids collection |
9924256A-739C-462b-AF15-E652A3B1B6EB |
| isNotify sent in body |
Уведомляет пользователей из списка доступа о возможной сделки Необязательно |
логический | истина |
Пример
POST api/2.0/crm/opportunity
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json
{
"contactid": 1234,
"members": [
1234
],
"title": "some text",
"description": "some text",
"responsibleid": "9924256A-739C-462b-AF15-E652A3B1B6EB",
"bidType": "fixedbid",
"bidValue": 0.0,
"bidCurrencyAbbr": "some text",
"perPeriodValue": 1234,
"stageid": 1234,
"successProbability": 1234,
"actualCloseDate": "2008-04-10T06-30-00.000Z",
"expectedCloseDate": "2008-04-10T06-30-00.000Z",
"customFieldList": [
{
"Key": 0,
"Value": null
}
],
"isPrivate": true,
"accessList": [
"00000000-0000-0000-0000-000000000000"
],
"isNotify": true
}
Возвращает
Возможная сделка.
Пример ответа
application/json
{
"status": 0,
"response": {
"createBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"created": "2022-10-08T15:03:33.2100361Z",
"contact": {
"smallFotoUrl": "url to foto",
"displayName": "Tadjeddine Bachir",
"isCompany": false,
"isPrivate": true,
"isShared": false,
"shareType": 0,
"currency": null,
"canEdit": false,
"canDelete": false,
"id": 0
},
"title": "Hotel catalogue",
"description": "",
"responsible": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"stage": {
"successProbability": 20,
"stageType": 0,
"title": "Discussion",
"description": "The potential buyer showed his\/her interest and sees how your offering meets his\/her goal",
"color": "#B9AFD3",
"sortOrder": 2,
"id": 30
},
"successProbability": 65,
"expectedCloseDate": "2022-10-08T15:03:33.2100361Z",
"isPrivate": false,
"canEdit": false,
"id": 0
}
}
text/xml
<result>
<status>0</status>
<response>
<createBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</createBy>
<created>2022-10-08T15:03:33.2100361Z</created>
<contact>
<smallFotoUrl>url to foto</smallFotoUrl>
<displayName>Tadjeddine Bachir</displayName>
<isCompany>false</isCompany>
<isPrivate>true</isPrivate>
<isShared>false</isShared>
<shareType>0</shareType>
<currency />
<canEdit>false</canEdit>
<canDelete>false</canDelete>
<id>0</id>
</contact>
<title>Hotel catalogue</title>
<description></description>
<responsible>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</responsible>
<stage>
<successProbability>20</successProbability>
<stageType>0</stageType>
<title>Discussion</title>
<description>The potential buyer showed his/her interest and sees how your offering meets his/her goal</description>
<color>#B9AFD3</color>
<sortOrder>2</sortOrder>
<id>30</id>
</stage>
<successProbability>65</successProbability>
<expectedCloseDate>2022-10-08T15:03:33.2100361Z</expectedCloseDate>
<isPrivate>false</isPrivate>
<canEdit>false</canEdit>
<id>0</id>
</response>
</result>
