Введение
Спасибо за выбор SynergyCRM API. Данный API позволяет работать со всеми основными объектами и настройками SynergyCRM, благодаря чему вы можете быстро создавать свои собственные приложения.
Получение API токена
Для корректной работы всех последующих примеров вам потребуется ключ для доступа к SynergyCRM API. Чтобы получить данный ключ перейдите в раздел Настройки / Настройки API из своего аккаунта.
Спецификация
Форматы запросов и ответов к API соответствуют спецификации JSON API v1.0.
Авторизация
Чтобы авторизоваться используйте следующий код:
curl "https://app.syncrm.ru/api/v1/deals" \
-H "Authorization: Bearer api_token"
Используйте полученный в настройках API токен вместо
api_token
.
Каждый запрос к API требует авторизации. Для авторизации необходим специальный уникальный токен.
Токен авторизации необходимо передавать в заголовке Authorization
каждого запроса. Пример:
Authorization: Bearer access_api_token
Контакты
Создание контакта с предустановленным источником и ответственным
curl "https://app.syncrm.ru/api/v1/contacts" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"contacts",
"attributes":{
"first-name":"Иван",
"last-name":"Петров"
},
"relationships":{
"source":{
"data":{
"type":"sources",
"id":"1"
}
},
"responsible":{
"data":{
"type":"users",
"id":"1"
}
}
}
}
}
EOF
JSON API type | contacts |
URL | /api/v1/contacts |
Список | GET /api/v1/contacts |
Чтение | GET /api/v1/contacts/{id} |
Создание | POST /api/v1/contacts |
Редактирование | PATCH /api/v1/contacts/{id} |
Удаление | DELETE /api/v1/contacts/{id} |
Атрибуты
Ниже приведен пример формата данных, в реальном ответе будут присутствовать все перечисленные атрибуты
{
"data": {
"type":"contacts",
"id":"1",
"attributes":{
"first-name":"Иван",
"last-name":"Петров",
"work-phone":"+79001234567",
"customs":{
"custom-1":"5 собак",
"custom-943":"2016-11-26T12:07:51.572+03:00"
},
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"archived-at":null
}
}
}
Основные атрибуты
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
first-name* | string |
Иван | да | Имя |
last-name* | string |
Иванов | да | Фамилия |
middle-name | string |
Иванович | да | Отчество |
description | string |
Описание | да | Описание |
general-phone | string |
+79001234567 |
да | Телефон (основной) |
mobile-phone | string |
+79001234567 |
да | Телефон (мобильный) |
work-phone | string |
+79001234567 |
да | Телефон (рабочий) |
work-phone-postfix | string |
200 |
да | Добавочный (рабочий) |
other-phone | string |
+79001234567 |
да | Телефон (дополнительный) |
other-phone-postfix | string |
200 |
да | Добавочный (дополнительный) |
fax | string |
+79001234567 |
да | Факс |
string |
help@syncrm.ru | да | E-mail адрес | |
other-email | string |
help@syncrm.ru | да | E-mail адрес (дополнительный) |
website | string |
syncrm.ru | да | Сайт |
customs | hash |
{"custom-1":'custom value'} |
да | Свои поля |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
archived-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата архивации |
* Обязательные поля
Рабочий адрес
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
work-country | string |
Свазиленд | да | Страна |
work-region | string |
Московская обл. | да | Область, регион, край |
work-city | string |
Челябинск | да | Город, населенный пункт |
work-zipcode | string |
100000 |
да | Индекс |
work-street | string |
ул. Печатников | да | Улица, проспект |
work-building | string |
12а |
да | Номер дома |
work-housing | string |
3 |
да | Корпус |
work-apartment | string |
123 |
да | Номер офиса или квартиры |
Домашний адрес
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
home-country | string |
Свазиленд | да | Страна |
home-region | string |
Московская обл. | да | Область, регион, край |
home-city | string |
Челябинск | да | Город, населенный пункт |
home-zipcode | string |
100000 |
да | Индекс |
home-street | string |
ул. Печатников | да | Улица, проспект |
home-building | string |
12а |
да | Номер дома |
home-housing | string |
3 |
да | Корпус |
home-apartment | string |
123 |
да | Номер офиса или квартиры |
Соц. сети и мессенджеры
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
vkontakte | string |
vk.com/durov | да | ВКонтакте |
string |
facebook.com | да | ||
string |
ru.linkedin.com | да | Linked-in | |
odnoklassniki | string |
да | Одноклассники | |
string |
instagram.com | да | ||
string |
twitter.com | да | ||
string |
да | |||
viber | string |
да | Viber | |
telegram | string |
да | Telegram | |
skype | string |
да | Skype |
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"contacts",
"id":"1",
"relationships":{
"responsible":{
"links":{
"self":"/api/v1/contacts/1/relationships/responsible",
"related":"/api/v1/contacts/1/responsible"
}
},
"contact-type":{
"links":{
"self":"/api/v1/contacts/1/relationships/contact-type",
"related":"/api/v1/contacts/1/contact-type"
}
}
}
}
}
Пример запроса с загруженными отвественными и типом контакта
curl "https://app.syncrm.ru/api/v1/contacts?include=responsible,contact-type" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Ответственный | responsible | users |
Создатель | user | users |
Источник | source | sources |
Компании | companies | companies |
Статус | status | contact-statuses |
Тип | contact-type | contact-types |
Сделки | deals | deals |
Заявки | orders | orders |
Продукты | products | products |
Спецификации | entities-products | entity-products |
Задачи | tasks | diary-tasks |
События | events | diary-events |
Фильтры
Получить список контактов с определённым рабочим номером
curl -G "https://app.syncrm.ru/api/v1/contacts" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[work_phone]=+79969930000"
Фильтр | Описание | Пример |
---|---|---|
work-phone | Вывести объекты по определенному work-phone |
filter[work_phone]=+79969930000 |
mobile-phone | Вывести объекты по определенному mobile-phone |
filter[mobile_phone]=+79969930000 |
other-phone | Вывести объекты по определенному other-phone |
filter[other_phone]=+79969930000 |
any-phone | Вывести объекты в которых из одном из телефонных полей хранится значение any-phone |
filter[any_phone]=+79969930000 |
Вывести объекты по определенному email |
filter[email]=support@syncrm.ru |
|
other-email | Вывести объекты по определенному other-email |
filter[other-email]=support@syncrm.ru |
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Статусы
Создание статуса контакта
curl "https://app.syncrm.ru/api/v1/contact-statuses" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"contact-statuses",
"attributes":{
"name":"Статус контакта в API",
"color":"#000000"
}
}
}
EOF
JSON API type | contact-statuses |
URL | /api/v1/contact-statuses |
Список | GET /api/v1/contact-statuses |
Чтение | GET /api/v1/contact-statuses/{id} |
Создание | POST /api/v1/contact-statuses |
Редактирование | PATCH /api/v1/contact-statuses/{id} |
Удаление | DELETE /api/v1/contact-statuses/{id} |
Атрибуты
{
"data": {
"type":"contact-statuses",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Новый",
"color": "#c62356"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Имя статуса контакта |
color | string |
#1f2f3f | да | Цвет статуса контакта |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список статусов контактов созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/contact-statuses" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Типы
Создание типа контакта
curl "https://app.syncrm.ru/api/v1/contact-types" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"contact-types",
"attributes":{
"name":"Тип контакта в API"
}
}
}
EOF
JSON API type | contact-types |
URL | /api/v1/contact-types |
Список | GET /api/v1/contact-types |
Чтение | GET /api/v1/contact-types/{id} |
Создание | POST /api/v1/contact-types |
Редактирование | PATCH /api/v1/contact-types/{id} |
Удаление | DELETE /api/v1/contact-types/{id} |
Атрибуты
{
"data": {
"type":"contact-types",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Новый"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой тип контакта | да | Имя типа контакта |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список типов контактов созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/contact-types" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Компании
Создание компании с предустановленным источником и ответственным
curl "https://app.syncrm.ru/api/v1/companies" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"companies",
"attributes":{
"name":"ООО Радужные единороги",
"description":"Коллекторское агенство"
},
"relationships":{
"source":{
"data":{
"type":"sources",
"id":"1"
}
},
"responsible":{
"data":{
"type":"users",
"id":"1"
}
}
}
}
}
EOF
JSON API type | companies |
URL | /api/v1/companies |
Список | GET /api/v1/companies |
Чтение | GET /api/v1/companies/{id} |
Создание | POST /api/v1/companies |
Редактирование | PATCH /api/v1/companies/{id} |
Удаление | DELETE /api/v1/companies/{id} |
Атрибуты
{
"data": {
"type":"companies",
"id":"1",
"attributes":{
"created-at": "2015-12-21T23:25:30.691+03:00",
"updated-at": "2016-02-25T20:19:21.080+03:00",
"name": "ООО Рога",
"general-phone": null,
"work-phone": "7848200000",
"mobile-phone": null,
"other-phone": "78482000000",
"fax": null,
"country": "Россия",
"city": "Новосибирск",
"region": "Новосибирская область",
"address": "Ворошилова, 1, корп. 1",
"zip-code": null,
"email": "email@mail.ru",
"other-email": "mail@gmail.com",
"website": "www.site.com",
"juristic-country": "Россия",
"juristic-region": "Новосибирская область",
"juristic-city": "Новосибирск",
"juristic-zip-code": "153512",
"juristic-street": "Ворошилова",
"juristic-house": "1",
"juristic-build": "1",
"juristic-office": "1",
"actual-country": null,
"actual-region": null,
"actual-city": null,
"actual-zip-code": null,
"actual-street": null,
"actual-house": null,
"actual-build": null,
"actual-office": null,
"mailing-country": "Россия",
"mailing-region": "Новосибирская область",
"mailing-city": "Новосибирск",
"mailing-zip-code": "382662",
"mailing-street": "Ворошилова",
"mailing-house": "1",
"mailing-build": "1",
"mailing-office": "1",
"inn": null,
"description": null,
"full-name": null,
"short-name": null,
"ogrn": null,
"kpp": null,
"okved": null,
"manager-name": null,
"manager-position": null,
"lawfulness-base": null,
"accountant": null,
"customs": {
"custom-98": "",
"custom-9": ""
},
"archived-at": null
}
}
}
Основные атрибуты
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Иван | да | Название |
description | string |
Описание | да | Описание |
general-phone | string |
+79001234567 |
да | Телефон (основной) |
mobile-phone | string |
+79001234567 |
да | Телефон (мобильный) |
work-phone | string |
+79001234567 |
да | Телефон (рабочий) |
work-phone-postfix | string |
200 |
да | Добавочный (рабочий) |
other-phone | string |
+79001234567 |
да | Телефон (дополнительный) |
other-phone-postfix | string |
200 |
да | Добавочный (дополнительный) |
fax | string |
+79001234567 |
да | Факс |
string |
help@syncrm.ru | да | E-mail адрес | |
other-email | string |
help@syncrm.ru | да | E-mail адрес (дополнительный) |
website | string |
syncrm.ru | да | Сайт |
country | string |
РФ | да | Страна |
region | string |
Крымская обл. | да | Регион |
city | string |
Тамбов | да | Город |
address | string |
Молдавских партизан 13 | да | Адрес |
zip-code | string |
190001 | да | Индекс |
customs | hash |
{"custom-1":'custom value'} |
да | Свои поля |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
archived-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата архивации |
* Обязательные поля
Фактический адрес
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
actual-country | string |
Свазиленд | да | Страна |
actual-region | string |
Московская обл. | да | Область, регион, край |
actual-city | string |
Челябинск | да | Город, населенный пункт |
actual-zip-code | string |
100000 |
да | Индекс |
actual-street | string |
ул. Печатников | да | Улица, проспект |
actual-house | string |
12а |
да | Номер дома |
actual-build | string |
3 |
да | Корпус |
actual-office | string |
123 |
да | Номер офиса |
Юридический адрес
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
juristic-country | string |
Свазиленд | да | Страна |
juristic-region | string |
Московская обл. | да | Область, регион, край |
juristic-city | string |
Челябинск | да | Город, населенный пункт |
juristic-zip-code | string |
100000 |
да | Индекс |
juristic-street | string |
ул. Печатников | да | Улица, проспект |
juristic-house | string |
12а |
да | Номер дома |
juristic-build | string |
3 |
да | Корпус |
juristic-office | string |
123 |
да | Номер офиса |
Почтовый адрес
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
mailing-country | string |
Свазиленд | да | Страна |
mailing-region | string |
Московская обл. | да | Область, регион, край |
mailing-city | string |
Челябинск | да | Город, населенный пункт |
mailing-zip-code | string |
100000 |
да | Индекс |
mailing-street | string |
ул. Печатников | да | Улица, проспект |
mailing-house | string |
12а |
да | Номер дома |
mailing-build | string |
3 |
да | Корпус |
mailing-office | string |
123 |
да | Номер офиса |
Реквизиты
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
full-name | string |
Общество с ограниченной ответственностью | да | Полное наименование |
short-name | string |
ООО "Рога" | да | Короткое наименование |
inn | string |
62010101010101 |
да | ИНН |
ogrn | string |
521300000000000 |
да | ОГРН |
kpp | string |
62010101010101 |
да | КПП |
okved | string |
234-456 |
да | ОКВЭД |
director | string |
Иванков И.И. | да | Директор |
accountant | string |
Иванков И.И. | да | Бухгалтер |
lawfulness-base | string |
да | Правомочность | |
manager-name | string |
Крабов В.В. | да | ФИО руководителя |
manager-position | string |
Официант | да | Должность руководителя |
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"companies",
"id":"1",
"relationships":{
"responsible":{
"links":{
"self":"/api/v1/contacts/1/relationships/responsible",
"related":"/api/v1/contacts/1/responsible"
}
},
"company-type":{
"links":{
"self":"/api/v1/contacts/1/relationships/company-type",
"related":"/api/v1/contacts/1/company-type"
}
}
}
}
}
Пример запроса с загруженными отвественными и типом компании
curl "https://app.syncrm.ru/api/v1/companies?include=responsible,company-type" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Ответственный | responsible | users |
Создатель | user | users |
Источник | source | sources |
Контакты | contacts | contacts |
Статус | status | company-statuses |
Тип | company-type | company-types |
Сделки | deals | deals |
Продукты | products | products |
Спецификации | entities-products | entity-products |
Задачи | tasks | diary-tasks |
События | events | diary-events |
Банк. реквизиты | bank-details | company-bank-details |
Фильтры
Получить список компаний с определённым рабочим номером
curl -G "https://app.syncrm.ru/api/v1/companies" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[general_phone]=+79969930000"
Фильтр | Описание | Пример |
---|---|---|
inn | Вывести объекты по определенному номеру ИНН | filter[inn]=123456789 |
work-phone | Вывести объекты по определенному work-phone |
filter[work_phone]=+79969930000 |
general-phone | Вывести объекты по определенному general-phone |
filter[general_phone]=+79969930000 |
other-phone | Вывести объекты по определенному other-phone |
filter[other_phone]=+79969930000 |
any-phone | Вывести объекты в которых из одном из телефонных полей хранится значение any-phone |
filter[any_phone]=+79969930000 |
Вывести объекты по определенному email |
filter[email]=support@syncrm.ru |
|
other-email | Вывести объекты по определенному other-email |
filter[other-email]=support@syncrm.ru |
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Банковские реквизиты
Создание банковских реквизитов для компании
curl "https://app.syncrm.ru/api/v1/company-bank-details" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"company-bank-details",
"attributes":{
"name":"test"
},
"relationships":{
"company":{
"data":{
"type":"companies",
"id":510571
}
}
}
}
}
EOF
JSON API type | company-bank-details |
URL | /api/v1/company-bank-details |
Список | GET /api/v1/company-bank-details |
Чтение | GET /api/v1/company-bank-details/{id} |
Создание | POST /api/v1/company-bank-details |
Редактирование | PATCH /api/v1/company-bank-details/{id} |
Удаление | DELETE /api/v1/company-bank-details/{id} |
Атрибуты
{
"data":{
"id": "1",
"type": "company-bank-details",
"attributes":{
"created-at": "2017-09-04T12:48:33.114+03:00",
"updated-at": "2017-09-04T12:48:33.114+03:00",
"name": "КАЛУЖСКОЕ ОТДЕЛЕНИЕ N8608 ПАО СБЕРБАНК",
"bank-name": "СБЕРБАНК РОССИИ КАЛУЖСКОЕ ОТДЕЛЕНИЕ № 8608",
"bik": "042908612",
"corr-number": "12345678900000000000",
"number": "12345678900000000000",
"is-default": true
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Название набора реквизитов |
bank-name | string |
Sberbank | да | Имя банка |
bik | string |
11239393 | да | БИК банка |
corr-number | string |
1234566788888 | да | Корр. счет |
number | string |
1234567890987 | да | Номер счета |
is-default | boolean |
true |
да | Основные реквизиты? |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Связи
Загрузка банковских реквизитов по определенной компании (id = 100)
curl "https://app.syncrm.ru/api/v1/companies/100/relationships/bank-details" \
-X GET \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token"
Название | Связь | JSON API type |
---|---|---|
Компания | company | companies |
Статусы
Создание статуса компании
curl "https://app.syncrm.ru/api/v1/company-statuses" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"company-statuses",
"attributes":{
"name":"Статус компании в API",
"color":"#000000"
}
}
}
EOF
JSON API type | company-statuses |
URL | /api/v1/company-statuses |
Список | GET /api/v1/company-statuses |
Чтение | GET /api/v1/company-statuses/{id} |
Создание | POST /api/v1/company-statuses |
Редактирование | PATCH /api/v1/company-statuses/{id} |
Удаление | DELETE /api/v1/company-statuses/{id} |
Атрибуты
{
"data": {
"type":"company-statuses",
"id":"1",
"attributes":{
"created-at": "2016-11-26T12:07:51.572+03:00",
"updated-at": "2017-11-26T12:07:51.572+03:00",
"name": "Новый",
"color": "#c62356"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Имя статуса компании |
color | string |
#1f2f3f | да | Цвет статуса компании |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список статусов компаний созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/company-statuses" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Типы
Создание типа компании
curl "https://app.syncrm.ru/api/v1/company-types" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"company-types",
"attributes":{
"name":"Тип компании в API"
}
}
}
EOF
JSON API type | company-types |
URL | /api/v1/company-types |
Список | GET /api/v1/company-types |
Чтение | GET /api/v1/company-types/{id} |
Создание | POST /api/v1/company-types |
Редактирование | PATCH /api/v1/company-types/{id} |
Удаление | DELETE /api/v1/company-types/{id} |
Атрибуты
{
"data": {
"type":"company-types",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Новый"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой тип компании | да | Имя типа компании |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список типов компаний созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/company-types" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Сделки
Создание сделки с предустановленным источником
curl "https://app.syncrm.ru/api/v1/deals" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"deals",
"attributes":{
"name":"Сделка из API",
"planned-at":"2016-12-31"
},
"relationships":{
"source":{
"data":{
"type":"sources",
"id":"1"
}
}
}
}
}
EOF
Создание сделки с привязанной заявкой
curl "https://app.syncrm.ru/api/v1/deals" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"deals",
"attributes":{
"name":"Сделка из API с привязанной заявкой"
},
"relationships":{
"orders": {
"data" : [{
"type": "orders",
"id": 35634
}]
}
}
}
}
EOF
Создание сделки с привязанными продуктами
curl "https://app.syncrm.ru/api/v1/deals" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"deals",
"attributes":{
"name":"Сделка из API с привязанными продуктами"
},
"relationships":{
"products": {
"data" : [{
"type": "products",
"id": 8187
}, {
"type": "products",
"id": 9018
}]
}
}
}
}
EOF
JSON API type | deals |
URL | /api/v1/deals |
Список | GET /api/v1/deals |
Чтение | GET /api/v1/deals/{id} |
Создание | POST /api/v1/deals |
Редактирование | PATCH /api/v1/deals/{id} |
Удаление | DELETE /api/v1/deals/{id} |
Атрибуты
{
"data": {
"type":"deals",
"id":"1",
"attributes":{
"name":"Квартира на Ленинском",
"description":"двушка в 15м доме",
"amount":4700000.0,
"number":16,
"planned-at":null,
"finished-at":"2016-11-26",
"customs":{
"custom-1":"5 собак",
"custom-943":"2016-11-26T12:07:51.572+03:00"
},
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"archived-at":null
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name | string |
Моя сделка | да | Имя сделки |
description | string |
Описание сделки | да | Подробное описание сделки |
amount | decimal |
123.0 | да | Сумма сделки |
cost | decimal |
123.0 | да | Себестомость сделки |
profit | decimal |
123.0 | нет | Прибыль сделки |
number | integer |
16 | да | Номер сделки |
planned-at | date |
2016-01-29 |
да | Планируемая дата закрытия |
finished-at | date |
2016-01-30 |
да | Фактическая дата закрытия |
customs | hash |
{"custom-1":'custom value'} |
да | Свои поля |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
archived-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата архивации |
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"deals",
"id":"1",
"relationships":{
"responsible":{
"links":{
"self":"/api/v1/deals/1/relationships/responsible",
"related":"/api/v1/deals/1/responsible"
}
},
"stage-category":{
"links":{
"self":"/api/v1/deals/1/relationships/stage-category",
"related":"/api/v1/deals/1/stage-category"
}
}
}
}
}
Пример запроса с загруженными источниками и отвественными
curl "https://app.syncrm.ru/api/v1/deals?include=source,responsible" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Ответственный | responsible | users |
Создатель | user | users |
Компания | company | companies |
Контакт | contact | contacts |
Этап | stage | deal-stages |
Воронка | stage-category | deal-stage-categories |
Источник | source | sources |
Статус | status | deal-statuses |
Причина поражения | loss-reason | deal-loss-reasons |
Конкурент поражения | loss-competitor | competitors |
Территория | area | areas |
Продукты | products | products |
Сделки | deals | deals |
Заявки | orders | orders |
Спецификации | entities-products | entity-products |
Фильтры
Получить список сделок созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/deals" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Причины поражения
Создание причины поражения сделок
curl "https://app.syncrm.ru/api/v1/deal-loss-reasons" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"deal-loss-reasons",
"attributes":{
"name":"Ушел к конкуренту"
}
}
}
EOF
JSON API type | deal-loss-reasons |
URL | /api/v1/deal-loss-reasons |
Список | GET /api/v1/deal-loss-reasons |
Чтение | GET /api/v1/deal-loss-reasons/{id} |
Создание | POST /api/v1/deal-loss-reasons |
Редактирование | PATCH /api/v1/deal-loss-reasons/{id} |
Удаление | DELETE /api/v1/deal-loss-reasons/{id} |
Атрибуты
{
"data": {
"type":"deal-loss-reasons",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Ушёл к конкуренту"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Отказался от услуг | да | Название причины поражения сделки |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список причин поражений сделок созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/deal-loss-reasons" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Воронки
Создание новой категории этапов сделки
curl "https://app.syncrm.ru/api/v1/deal-stage-categories" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"deal-stage-categories",
"attributes":{
"name":"Воронка из API"
}
}
}
EOF
JSON API type | deal-stage-categories |
URL | /api/v1/deal-stage-categories |
Список | GET /api/v1/deal-stage-categories |
Чтение | GET /api/v1/deal-stage-categories/{id} |
Создание | POST /api/v1/deal-stage-categories |
Редактирование | PATCH /api/v1/deal-stage-categories/{id} |
Удаление | DELETE /api/v1/deal-stage-categories/{id} |
Атрибуты
{
"data": {
"type":"deal-stage-categories",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Воронка",
"calculation-method": "by_billings",
"is-default": true,
"win-by-diaries": false
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
на Мира | да | Название воронки |
amount-calc-method* | string |
invoices | да | Способ расчета суммы сделки |
cost-calc-method* | string |
payments | да | Способ расчета себестоимости сделки |
amount-calc-field | string |
custom_1 | да | Поле формулы при расчете суммы сделки по формуле |
cost-calc-field | string |
custom_2 | да | Поле формулы при расчете себестоимости сделки по формуле |
is-default | boolean |
true | да | По-умолчанию |
win-by-diaries | boolean |
false | да | Cчитать сделку выиграной, eсли все задачи выполнены |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Ограничения по значениям
Аттрибут | Варианты |
---|---|
amount-calc-method | manually , invoices , products , payments , formula |
cost-calc-method | manually , products , payments , formula |
Фильтры
Получить список категорий этапов сделок созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/deal-stage-categories" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Этапы
Создание нового этапа сделки
curl "https://app.syncrm.ru/api/v1/deal-stages" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"deal-stages",
"attributes":{
"name":"Этап из API"
},
"relationships":{
"deal-stage-category": {
"data": {
"type": "deal-stage-categories",
"id": 1
}
}
}
}
}
EOF
JSON API type | deal-stages |
URL | /api/v1/deal-stages |
Список | GET /api/v1/deal-stages |
Чтение | GET /api/v1/deal-stages/{id} |
Создание | POST /api/v1/deal-stages |
Редактирование | PATCH /api/v1/deal-stages/{id} |
Удаление | DELETE /api/v1/deal-stages/{id} |
Атрибуты
{
"data": {
"type":"deal-stages",
"id":"1",
"attributes":{
"created-at": "2017-07-31T14:23:02.458+03:00",
"updated-at": "2017-07-31T14:23:02.458+03:00",
"name": "Открыта",
"description": null,
"duration": null,
"color": "#e0e0e0",
"next-if-items-done": false
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
на Мира | да | Название воронки |
duration | integer |
10000 | да | Длительность этапа |
next-if-items-done | boolean |
false | да | Переходить на следующий этап, если все задачи выполнены |
description | boolean |
true | да | Описание |
color | string |
#ee66aa | да | Цвет этапа |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список этапов сделок созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/deal-stages" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Статусы
Создание статуса сделки
curl "https://app.syncrm.ru/api/v1/deal-statuses" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"deal-statuses",
"attributes":{
"name":"Статус сделки в API",
"color":"#000000"
}
}
}
EOF
JSON API type | deal-statuses |
URL | /api/v1/deal-statuses |
Список | GET /api/v1/deal-statuses |
Чтение | GET /api/v1/deal-statuses/{id} |
Создание | POST /api/v1/deal-statuses |
Редактирование | PATCH /api/v1/deal-statuses/{id} |
Удаление | DELETE /api/v1/deal-statuses/{id} |
Атрибуты
{
"data": {
"type":"deal-statuses",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Новый",
"color": "#c62356"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Имя статуса сделки |
color | string |
#1f2f3f | да | Цвет статуса сделки |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список статусов сделок созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/deal-statuses" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Заявки
Создание заявки с предустановленным источником
curl "https://app.syncrm.ru/api/v1/orders" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"orders",
"attributes":{
"name":"Заявка из API",
"archived-at":"2016-12-31"
},
"relationships":{
"source":{
"data":{
"type":"sources",
"id":"1"
}
}
}
}
}
EOF
Создание заявки с предустановленной сделкой
curl "https://app.syncrm.ru/api/v1/orders" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"orders",
"attributes":{
"name":"Заявка из API с предустановленной сделкой",
"archived-at":"2016-12-31"
},
"relationships":{
"deals": {
"data" : [{
"type": "deals",
"id": 33435
}]
}
}
}
}
EOF
JSON API type | orders |
URL | /api/v1/orders |
Список | GET /api/v1/orders |
Чтение | GET /api/v1/orders/{id} |
Создание | POST /api/v1/orders |
Редактирование | PATCH /api/v1/orders/{id} |
Удаление | DELETE /api/v1/orders/{id} |
Атрибуты
{
"data": {
"type":"orders",
"id":"1",
"attributes":{
"name":"Уборка квартиры",
"description":"на Ленинском в 15м доме",
"amount":"5000.0",
"number":21,
"archived-at":"2016-11-26",
"customs":{
"custom-11":"5 собак",
"custom-43":"2016-11-26T12:07:51.572+03:00"
},
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name | string |
Моя сделка | да | Имя заявки |
description | string |
Описание сделки | да | Подробное описание заявки |
amount | decimal |
123.0 | да | Сумма заявки |
number | integer |
16 | да | Номер заявки |
customs | hash |
{"custom-1":'custom value'} |
да | Свои поля |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
archived-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата архивации |
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"orders",
"id":"1",
"relationships":{
"responsible":{
"links":{
"self":"/api/v1/orders/1/relationships/responsible",
"related":"/api/v1/orders/1/responsible"
}
},
"stage":{
"links":{
"self":"/api/v1/orders/1/relationships/stage",
"related":"/api/v1/orders/1/stage"
}
}
}
}
}
Пример запроса с загруженными источниками и отвественными
curl "https://app.syncrm.ru/api/v1/orders?include=source,responsible" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Ответственный | responsible | users |
Создатель | user | users |
Компания | company | companies |
Контакт | contact | contacts |
Этап | stage | order-stages |
Источник | source | sources |
Статус | status | order-statuses |
Причина поражения | loss-reason | order-loss-reasons |
Конкурент поражения | loss-competitor | competitors |
Территория | area | areas |
Продукты | products | products |
Сделки | deals | deals |
Спецификации | entities-products | entity-products |
Фильтры
Получить список заявок до определённой даты
curl -G "https://app.syncrm.ru/api/v1/orders" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Причины поражения
Создание причины поражения заявки
curl "https://app.syncrm.ru/api/v1/order-loss-reasons" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"order-loss-reasons",
"attributes":{
"name":"Отказ без причин"
}
}
}
EOF
JSON API type | order-loss-reasons |
URL | /api/v1/order-loss-reasons |
Список | GET /api/v1/order-loss-reasons |
Чтение | GET /api/v1/order-loss-reasons/{id} |
Создание | POST /api/v1/order-loss-reasons |
Редактирование | PATCH /api/v1/order-loss-reasons/{id} |
Удаление | DELETE /api/v1/order-loss-reasons/{id} |
Атрибуты
{
"data": {
"type":"order-loss-reasons",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Отказ без причин"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Высокая цена | да | Название причины поражения заявки |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список причин поражений заявок созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/order-loss-reasons" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Этапы
Создание нового этапа заявки
curl "https://app.syncrm.ru/api/v1/order-stages" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"deal-stages",
"attributes":{
"name":"Этап из API"
},
"relation
}
}
EOF
JSON API type | order-stages |
URL | /api/v1/order-stages |
Список | GET /api/v1/order-stages |
Чтение | GET /api/v1/order-stages/{id} |
Создание | POST /api/v1/order-stages |
Редактирование | PATCH /api/v1/order-stages/{id} |
Удаление | DELETE /api/v1/order-stages/{id} |
Атрибуты
{
"data": {
"type":"order-stages",
"id":"1",
"attributes":{
"created-at": "2017-07-31T14:23:02.458+03:00",
"updated-at": "2017-07-31T14:23:02.458+03:00",
"name": "Не обработана",
"description": null,
"color": "#e0e0e0",
"duration": null,
"next-if-items-done": false
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
на Мира | да | Название воронки |
duration | integer |
10000 | да | Длительность этапа |
next-if-items-done | boolean |
false | да | Переходить на следующий этап, если все задачи выполнены |
description | boolean |
true | да | Описание |
color | string |
#ee66aa | да | Цвет этапа |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список этапов заявок созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/deal-stages" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Статусы
Создание статуса заявки
curl "https://app.syncrm.ru/api/v1/order-statuses" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"order-statuses",
"attributes":{
"name":"Статус заявки в API",
"color":"#000000"
}
}
}
EOF
JSON API type | order-statuses |
URL | /api/v1/order-statuses |
Список | GET /api/v1/order-statuses |
Чтение | GET /api/v1/order-statuses/{id} |
Создание | POST /api/v1/order-statuses |
Редактирование | PATCH /api/v1/order-statuses/{id} |
Удаление | DELETE /api/v1/order-statuses/{id} |
Атрибуты
{
"data": {
"type":"order-statuses",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Новый",
"color": "#c62356"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Имя статуса заявки |
color | string |
#1f2f3f | да | Цвет статуса заявки |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список статусов заявок созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/order-statuses" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
События
Создание события с предустановленным исполнителем и компанией
curl "https://app.syncrm.ru/api/v1/diary-events" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"diary-events",
"attributes":{
"name":"Задача из API",
"description":"Данная задача было создана при помощи API",
"start-time":"2016-06-15 12:00 +0300"
},
"relationships":{
"responsible": {
"data":{
"type":"users",
"id":"5"
}
},
"company":{
"data":{
"type":"companies",
"id":"51"
}
}
}
}
}
EOF
JSON API type | diary-events |
URL | /api/v1/diary-events |
Список | GET /api/v1/diary-events |
Чтение | GET /api/v1/diary-events/{id} |
Создание | POST /api/v1/diary-events |
Редактирование | PATCH /api/v1/diary-events/{id} |
Удаление | DELETE /api/v1/diary-events/{id} |
Атрибуты
{
"data": {
"type":"diary-events",
"id":"1",
"attributes":{
"name":"Копия договора",
"description":"Отправить копию договора в ООО \"Рога\"",
"start-time":"2016-11-26T12:07:51.572+03:00",
"end-time":"2016-11-26T15:31:11.232+03:00",
"color":"#fff",
"status":"completed",
"due-date":"2016-11-28T12:00:00.000+03:00",
"duration":null,
"customs":{
"custom-1":"Важный клиент",
"custom-943":"2016-11-26T12:07:51.572+03:00"
},
"created-at":"2016-11-26T12:07:51.572+03:00",
"completed-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"archived-at":null
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Переговоры с ООО "Рога" | да | Название события |
description | string |
Переговоры для дальнейшей координации сотрудничества | да | Подробное описание события |
start-time | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Время начала |
end-time | datetime |
2016-11-26T15:31:11.232+03:00 |
да | Время окончания |
due-date | datetime |
2016-11-28T12:00:00.000+03:00 |
да | Дедлайн |
color | string |
#fff | да | Цвет |
status | string |
completed, overdue, opened | нет | Статус |
customs | hash |
{"custom-1":'custom value'} |
да | Свои поля |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
completed-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата завершения |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
archived-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата архивации |
* Обязательные поля
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"diary-events",
"id":"1",
"relationships":{
"responsible":{
"links":{
"self":"/api/v1/diary-events/1/relationships/responsible",
"related":"/api/v1/diary-events/1/responsible"
}
},
"diary-type":{
"links":{
"self":"/api/v1/diary-events/1/relationships/diary-type",
"related":"/api/v1/diary-events/1/diary-type"
}
}
}
}
}
Пример запроса с загруженными типами задачи и отвественными
curl "https://app.syncrm.ru/api/v1/diary-events?include=diary-type,responsible" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Ответственный | responsible | users |
Создатель | user | users |
Компания | company | companies |
Контакт | contact | contacts |
Сделка | deal | deals |
Заявка | order | orders |
Тип задачи | diary-type | diary-types |
Фильтры
Получить список событий созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/diary-events" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
completed-at-gte | Вывести объекты завершенные после указанного времени | filter[completed-at-gte]=2017.08.01 12:00 |
completed-at-lte | Вывести объекты завершенные до указанного времени | filter[completed-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
started-gte | Вывести объекты имеющие даты начала позднее указанного времени | filter[started-gte]=2017.08.01 12:00 |
started-lte | Вывести объекты имеющие даты начала раннего до указанного времени | filter[started-lte]=2017.08.01 12:00 |
expired-gte | Вывести объекты истекающие после указанного времени | filter[expired-gte]=2017.08.01 12:00 |
expired-lte | Вывести объекты истекающие до указанного времени | filter[expired-lte]=2017.08.01 12:00 |
Задачи
Создание задачи с предустановленным исполнителем и контактом
curl "https://app.syncrm.ru/api/v1/diary-tasks" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"diary-tasks",
"attributes":{
"name":"Задача из API",
"description":"Данная задача было создана при помощи API",
"due-date":"2016-12-31 12:00 +0300",
"start-time":"2016-06-15 12:00 +0300"
},
"relationships":{
"responsible": {
"data":{
"type":"users",
"id":"3"
}
},
"contact":{
"data":{
"type":"contacts",
"id":"12"
}
}
}
}
}
EOF
JSON API type | diary-tasks |
URL | /api/v1/diary-tasks |
Список | GET /api/v1/diary-tasks |
Чтение | GET /api/v1/diary-tasks/{id} |
Создание | POST /api/v1/diary-tasks |
Редактирование | PATCH /api/v1/diary-tasks/{id} |
Удаление | DELETE /api/v1/diary-tasks/{id} |
Атрибуты
{
"data": {
"type":"diary-tasks",
"id":"1",
"attributes":{
"name":"Копия договора",
"description":"Отправить копию договора в ООО \"Рога\"",
"start-time":"2016-11-26T12:07:51.572+03:00",
"end-time":"2016-11-26T15:31:11.232+03:00",
"color":"#fff",
"status":"completed",
"due-date":"2016-11-28T12:00:00.000+03:00",
"duration":null,
"customs":{
"custom-1":"Важный клиент",
"custom-943":"2016-11-26T12:07:51.572+03:00"
},
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"completed-at":"2016-11-26T12:07:51.572+03:00",
"archived-at":null
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Копия договора | да | Имя задачи |
description | string |
Отправить копию договора в ООО "Рога" | да | Подробное описание задачи |
start-time | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Время начала |
end-time | datetime |
2016-11-26T15:31:11.232+03:00 |
да | Время окончания |
due-date | datetime |
2016-11-28T12:00:00.000+03:00 |
да | Дедлайн |
color | string |
#fff | да | Цвет |
status | string |
completed, overdue, opened | нет | Статус |
customs | hash |
{"custom-1":'custom value'} |
да | Свои поля |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
completed-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата завершения |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
archived-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата архивации |
* Обязательные поля
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"diary-tasks",
"id":"1",
"relationships":{
"responsible":{
"links":{
"self":"/api/v1/diary-tasks/1/relationships/responsible",
"related":"/api/v1/diary-tasks/1/responsible"
}
},
"company":{
"links":{
"self":"/api/v1/diary-tasks/1/relationships/company",
"related":"/api/v1/diary-tasks/1/company"
}
}
}
}
}
Пример запроса с загруженными сделками и контактами
curl "https://app.syncrm.ru/api/v1/diary-tasks?include=deal,contact" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Ответственный | responsible | users |
Создатель | user | users |
Компания | company | companies |
Контакт | contact | contacts |
Сделка | deal | deals |
Заявка | order | orders |
Тип задачи | diary-type | diary-types |
Приоритет | diary-priority | diary-priorities |
Фильтры
Получить список задач созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/diary-tasks" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
completed-at-gte | Вывести объекты завершенные после указанного времени | filter[completed-at-gte]=2017.08.01 12:00 |
completed-at-lte | Вывести объекты завершенные до указанного времени | filter[completed-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
started-gte | Вывести объекты имеющие даты начала позднее указанного времени | filter[started-gte]=2017.08.01 12:00 |
started-lte | Вывести объекты имеющие даты начала раннего до указанного времени | filter[started-lte]=2017.08.01 12:00 |
expired-gte | Вывести объекты истекающие после указанного времени | filter[expired-gte]=2017.08.01 12:00 |
expired-lte | Вывести объекты истекающие до указанного времени | filter[expired-lte]=2017.08.01 12:00 |
Приоритеты
Создание приоритета задачи
curl "https://app.syncrm.ru/api/v1/diary-priorities" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"diary-priorities",
"attributes":{
"name":"Приоритет задачи в API",
"color":"#000000"
}
}
}
EOF
JSON API type | diary-priorities |
URL | /api/v1/diary-priorities |
Список | GET /api/v1/diary-priorities |
Чтение | GET /api/v1/diary-priorities/{id} |
Создание | POST /api/v1/diary-priorities |
Редактирование | PATCH /api/v1/diary-priorities/{id} |
Удаление | DELETE /api/v1/diary-priorities/{id} |
Атрибуты
{
"data": {
"type":"diary-priorities",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Новый",
"color": "#c62356"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Название приоритета |
color | string |
#1f2f3f | да | Цвет приоритета |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Телефония
Создание телефонии
curl "https://app.syncrm.ru/api/v1/telephonies" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"telephonies",
"attributes":{
"provider":"mango",
"mango-code":"1122",
"mango-sign-key":"signkey"
}
}
}
EOF
JSON API type | telephonies |
URL | /api/v1/telephonies |
Список | GET /api/v1/telephonies |
Чтение | GET /api/v1/telephonies/{id} |
Создание | POST /api/v1/telephonies |
Редактирование | PATCH /api/v1/telephonies/{id} |
Удаление | DELETE /api/v1/telephonies/{id} |
Атрибуты
{
"data": {
"type":"telephonies",
"id":"1",
"attributes":{
"provider":"mango",
"sipuni-integration-key": null,
"sipuni-system-number": null,
"mango-code":"1122",
"mango-sign-key":"signkey",
"oktell-order-call-url": null,
"dialog-order-call-url": null,
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
provider* | string |
mango |
да | Провайдер телефонии |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
archived-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата архивации |
* Обязательные поля
Ограничения по значениям
Аттрибут | Варианты |
---|---|
provider | API ,sipuni ,mango ,bmi_telecom ,oktell ,dialog |
Некоторые атрибуты зависят от провайдера телефонии.
Атрибуты Sipuni
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
sipuni-integration-key | string |
110012 | да | Ключ интеграции Sipuni |
sipuni-system-number | string |
SomeKey |
да | Системный номер в Sipuni |
Атрибуты Mango
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
mango-code | string |
SomeKey | да | Код интеграции Mango |
mango-sign-key | string |
10201110 | да | Ключ интеграции Mango |
Атрибуты Oktell
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
oktell-order-call-url | string |
http://example.com/ | да | URL для запроса звонка в Oktell |
Атрибуты Dialog
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
dialog-order-call-url | string |
http://example.com/ | да | URL для запроса звонка в Dialog |
Фильтры
Получить список телефоний созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/telephonies" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Номера
Создание номера
curl "https://app.syncrm.ru/api/v1/telephony-phones" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"telephony-phones",
"attributes":{
"number":"100112"
},
"relationships":{
"telephony":{
"data":{
"type":"telephonies",
"id":"1"
}
},
"user":{
"data":{
"type":"users",
"id":"3"
}
}
}
}
}
EOF
JSON API type | telephony-phones |
URL | /api/v1/telephony-phones |
Список | GET /api/v1/telephony-phones |
Чтение | GET /api/v1/telephony-phones/{id} |
Создание | POST /api/v1/telephony-phones |
Редактирование | PATCH /api/v1/telephony-phones/{id} |
Удаление | DELETE /api/v1/telephony-phones/{id} |
Атрибуты номеров
{
"data": {
"type":"telephony-phones",
"id":"1",
"attributes":{
"number":"112",
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
number* | string |
3301 |
да | Номер телефона |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Связи номеров
Пример данных
{
"data": {
"type":"telephonies-phones",
"id":"1",
"relationships":{
"telephony":{
"links":{
"self":"/api/v1/telephonies-phone/1/relationships/telephony",
"related":"/api/v1/telephonies-phone/1/telephony"
}
},
"user":{
"links":{
"self":"/api/v1/telephonies-phone/1/relationships/user",
"related":"/api/v1/telephonies-phone/1/user"
}
}
}
}
}
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Для создания номера телефона, в связях обязательно должны указываться сотрудник, которому присваивается номер,
и телефония, в которой этот номер будет функционировать.
Название | Связь | JSON API type |
---|---|---|
Телефония | telephony | telephonies |
Сотрудник | user | users |
Фильтры
Получить список номеров телефонов по определённому пользователю
curl -G "https://app.syncrm.ru/api/v1/telephony-phones" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[user]=11"
Фильтр | Описание | Пример |
---|---|---|
user | Вывести объекты по определенному user |
filter[user]=10 |
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Звонки
Создание звонка
curl "https://app.syncrm.ru/api/v1/telephony-calls" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"telephony-calls",
"attributes":{
"direction":"planned",
"src-phone-number":"+73221223442",
"planned-at":"2017-02-02 17:04:41 +0300"
},
"relationships":{
"telephony":{
"data":{
"type":"telephonies",
"id":"3"
}
},
"dst-phone":{
"data":{
"type":"telephony-phones",
"id":"2"
}
}
}
}
}
EOF
JSON API type | telephony-calls |
URL | /api/v1/telephony-calls |
Список | GET /api/v1/telephony-calls |
Чтение | GET /api/v1/telephony-calls/{id} |
Создание | POST /api/v1/telephony-calls |
Редактирование | PATCH /api/v1/telephony-calls/{id} |
Удаление | DELETE /api/v1/telephony-calls/{id} |
Атрибуты звонков
{
"data": {
"type":"telephony-calls",
"id":"1",
"attributes":{
"direction":"outgoing",
"dst-phone-number": "+79990306111",
"src-phone-number":"112",
"duration": 10000.0,
"created-at":"2016-11-26T12:07:51.572+03:00",
"completed-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"planned-at": null,
"answered-at": "2016-11-26T12:07:51.572+03:00"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
dst-phone-number* | string |
+7223311 |
да | Номер входящего телефона |
src-phone-number* | string |
3301 |
да | Номер исходящего телефона |
direction* | string |
incoming |
да | Тип звонка |
duration | double |
6000.0 | да | Длительность звонка |
answered-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата ответа |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
completed-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата окончания звонка |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
planned-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Плановая дата звонка |
* Обязательные поля
Связи звонков
Пример данных (перечислены не все связи)
{
"data": {
"type":"telephonies-calls",
"id":"1",
"relationships":{
"src-phone":{
"links":{
"self":"/api/v1/telephonies-phone/1/relationships/src-phone",
"related":"/api/v1/telephonies-phone/1/src-phone"
}
},
"dst-phone":{
"links":{
"self":"/api/v1/telephonies-phone/1/relationships/dst-phone",
"related":"/api/v1/telephonies-phone/1/dst-phone"
}
}
}
}
}
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Для создания номера телефона, в связях обязательно должен указываться номер в телефонии. В зависимости от типа звонка,
указанного в поле direction
, привязываться он дожен к разным связям.
Название | Связь | JSON API type |
---|---|---|
Телефония* | telephony | telephonies |
Звонящий номер | src-phone | telephony-phones |
Целевой номер | dst-phone | telephony-phones |
Статус | status | telephony-status |
* Обязательная связь
Обязательные связи в зависимости от ключа
Ключ | Обязательные связи | Описание |
---|---|---|
outgoing | src-phone |
Исходящий звонок |
incoming | dst-phone |
Входящий звонок |
internal | src-phone и dst-phone |
Внутренний звонок |
planned | dst-phone |
Плановый звонок |
error | src-phone или dst-phone |
Ошибка |
Фильтры
Получить список звонков созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/telephony-calls" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Статусы
Создание статуса
curl "https://app.syncrm.ru/api/v1/telephony-statuses" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"telephony-statuses",
"attributes":{
"name":"Статус заявки в API",
"color":"#000000"
}
}
}
EOF
JSON API type | telephony-statuses |
URL | /api/v1/telephony-statuses |
Список | GET /api/v1/telephony-statuses |
Чтение | GET /api/v1/telephony-statuses/{id} |
Создание | POST /api/v1/telephony-statuses |
Редактирование | PATCH /api/v1/telephony-statuses/{id} |
Удаление | DELETE /api/v1/telephony-statuses/{id} |
Атрибуты
{
"data": {
"type":"telephony-statuses",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Новый",
"color": "#c62356"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Имя статуса телефонии |
color | string |
#1f2f3f | да | Цвет статуса телефонии |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список статусов звонков созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/telephony-statuses" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Продукты
Создание продукта с предустановленными типом и статусом
curl "https://app.syncrm.ru/api/v1/products" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"products",
"attributes":{
"name":"Продукт из API",
"description":"Продукт созданный при помощи API",
"purchase-price":10000.0
},
"relationships":{
"product-type":{
"data":{
"type":"product-types",
"id":"11"
}
},
"status":{
"data":{
"type":"product-statuses",
"id":"2"
}
}
}
}
}
EOF
Пример установки обложки.
curl "https://app.syncrm.ru/api/v1/products/10" \
-X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"products",
"id":"10",
"relationships":{
"cover":{
"data":{
"type":"documents",
"id":"103"
}
}
}
}
}
EOF
JSON API type | products |
URL | /api/v1/products |
Список | GET /api/v1/products |
Чтение | GET /api/v1/products/{id} |
Создание | POST /api/v1/products |
Редактирование | PATCH /api/v1/products/{id} |
Удаление | DELETE /api/v1/products/{id} |
Атрибуты
{
"data": {
"type":"products",
"id": 1,
"attributes":{
"name": "Квартира на Ленинском",
"description": "двушка в 15м доме",
"cost-price": 100.0,
"selling-price": 100.0,
"purchase-price": 50.0,
"code": "10110",
"number": 8,
"vendor-code": "1BM40",
"is-service": false,
"cover-image": "https://example.com/path/to/file.jpg",
"customs":{
"custom-943":"2016-11-26T12:07:51.572+03:00"
},
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Квартира на Ленинском | да | Название товара |
description | string |
двушка в 15м доме | да | Описание товара |
code | string |
11030 | да | Код |
vendor-code | string |
1BM40 | да | Артикул |
is-service | boolean |
true |
да | Услуга |
purchase-price | decimal |
150.0 | да | Цена закупки |
cost-price | decimal |
100.0 | да | Себестоимость |
selling-price | decimal |
100.0 | да | Цена продажи |
customs | hash |
{"custom-1":'custom value'} |
да | Свои поля |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
cover-image | string |
https://example.com/path/to/file.jpg |
нет | Обложка.** |
volume | decimal |
15.0 | да | Объём |
weight | decimal |
20.0 | да | Вес, кг |
ccd | string |
11111111 / 111111 / 1111111 |
да | ГТД |
country | string |
Россия | да | Страна |
vat | decimal |
18.0 | да | НДС |
number | bigint |
8 | да | Номер продукта |
* Обязательные поля ** Обложка может быть установлена только из тех документов, которые уже связаны с продуктом и являются изображением.
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"products",
"id":"1",
"relationships":{
"status":{
"links":{
"self":"/api/v1/products/1/relationships/status",
"related":"/api/v1/products/1/status"
}
},
"category":{
"links":{
"self":"/api/v1/products/1/relationships/category",
"related":"/api/v1/products/1/category"
}
}
}
}
}
Пример запроса с загруженными статусами и категориями продуктов
curl "https://app.syncrm.ru/api/v1/products?include=status,category" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Категория | category | product-categories |
Статус | status | product-statuses |
Скидка | discount | product-discounts |
Единица измерения | unit | product-units |
Склад | store | stores |
Задачи | diaries | diaries |
Заявки | orders | orders |
Сделки | deals | deals |
Изображения | images | documents |
Обложка | cover | documents |
Документы | documents | documents |
Фильтры
Получить список продуктов по определённому контакту
curl -G "https://app.syncrm.ru/api/v1/products/?filter[contacts]=11" \
-X GET \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token"
Фильтр | Описание | Пример |
---|---|---|
contacts | Вывести объекты по определенному contacts |
filter[contacts]=1 |
companies | Вывести объекты по определенному companies |
filter[companies]=1 |
deals | Вывести объекты по определенному deals |
filter[deals]=1 |
orders | Вывести объекты по определенному orders |
filter[orders]=1 |
diaries | Вывести объекты по определенному diaries |
filter[diaries]=1 |
record-objects | Вывести объекты по определенному record-objects |
filter[record-objects]=1 |
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Категории продуктов
Создание новой категории продуктов
curl "https://app.syncrm.ru/api/v1/product-categories" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"product-categories",
"attributes":{
"name":"Категория из API"
}
}
}
EOF
JSON API type | product-categories |
URL | /api/v1/product-categories |
Список | GET /api/v1/product-categories |
Чтение | GET /api/v1/product-categories/{id} |
Создание | POST /api/v1/product-categories |
Редактирование | PATCH /api/v1/product-categories/{id} |
Удаление | DELETE /api/v1/product-categories/{id} |
Атрибуты
{
"data": {
"type":"product-categories",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Оптом"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Квартиры по-суточно | да | Название категории продукта |
ancestry | string |
112,12 |
нет | Список родительских категорий |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Вложенные категории продуктов
Пример данных для создания подкатегории
{
"data": {
"type":"product-categories",
"attributes":{
"name":"Дочерняя категория"
},
"relationships":{
"parent":{
"data":{
"type":"product-categories",
"id":"123"
}
}
}
}
}
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Родитель | parent | product-categories |
Дети | children | product-categories |
Дерево | subtree | product-categories |
Фильтры
Получить список категорий продуктов созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/product-categories" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Скидки
Создание новой скидки
curl "https://app.syncrm.ru/api/v1/product-discounts" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"product-discounts",
"attributes":{
"name":"Скидка из API",
"size":10.0
}
}
}
EOF
JSON API type | product-discounts |
URL | /api/v1/product-discounts |
Список | GET /api/v1/product-discounts |
Чтение | GET /api/v1/product-discounts/{id} |
Создание | POST /api/v1/product-discounts |
Редактирование | PATCH /api/v1/product-discounts/{id} |
Удаление | DELETE /api/v1/product-discounts/{id} |
Атрибуты
{
"data": {
"type":"product-discounts",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Постоянный клиент",
"size": "10.0"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Постоянный клиент | да | Название скидки |
size* | float |
10.0 | да | Размер скидки |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Связи
Пример запроса с загруженными типами контактов
curl "https://app.syncrm.ru/api/v1/product-discounts?include=contact-type" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Тип контакта | contact-type | contact-types |
Фильтры
Получить список скидок созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/product-discounts" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Статусы продуктов
Создание статуса продукта
curl "https://app.syncrm.ru/api/v1/product-statuses" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"product-statuses",
"attributes":{
"name":"Статус заявки в API",
"color":"#000000"
}
}
}
EOF
JSON API type | product-statuses |
URL | /api/v1/product-statuses |
Список | GET /api/v1/product-statuses |
Чтение | GET /api/v1/product-statuses/{id} |
Создание | POST /api/v1/product-statuses |
Редактирование | PATCH /api/v1/product-statuses/{id} |
Удаление | DELETE /api/v1/product-statuses/{id} |
Атрибуты
{
"data": {
"type":"product-statuses",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Новый",
"color": "#c62356"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Имя статуса продукта |
color | string |
#1f2f3f | да | Цвет статуса продукта |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список статусов продуктов созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/product-statuses" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Типы продуктов
Создание типа продуктов
curl "https://app.syncrm.ru/api/v1/product-types" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"product-types",
"attributes":{
"name":"Тип продукта из API"
}
}
}
EOF
JSON API type | product-types |
URL | /api/v1/product-types |
Список | GET /api/v1/product-types |
Чтение | GET /api/v1/product-types/{id} |
Создание | POST /api/v1/product-types |
Редактирование | PATCH /api/v1/product-types/{id} |
Удаление | DELETE /api/v1/product-types/{id} |
Атрибуты
{
"data": {
"type":"product-types",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Квартира"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Квартира | да | Название типа продукта |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список единиц измерений продуктов созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/product-types" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Единицы измерений
Создание новой единицы измерения
curl "https://app.syncrm.ru/api/v1/product-units" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"product-units",
"attributes":{
"name":"Единица измерения из API"
}
}
}
EOF
JSON API type | product-units |
URL | /api/v1/product-units |
Список | GET /api/v1/product-units |
Чтение | GET /api/v1/product-units/{id} |
Создание | POST /api/v1/product-units |
Редактирование | PATCH /api/v1/product-units/{id} |
Удаление | DELETE /api/v1/product-units/{id} |
Атрибуты
{
"data": {
"type":"product-units",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "руб/кв. м."
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
штука | да | Название единицы измерения |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список единиц измерений продуктов созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/product-units" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Спецификации
Добавление продукта в сделку
curl "https://app.syncrm.ru/api/v1/entity-products" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"entity-products",
"attributes":{
"quantity": 5
},
"relationships":{
"entity":{
"data":{
"type":"deals",
"id": 42
},
"product":{
"data":{
"type":"products",
"id": 11
}
}
}
}
}
EOF
Добавление нескольких спецификаций по связи с продуктами у сделки. Из указанных продуктов будут созданы соответветствующие спецификации.
curl "https://app.syncrm.ru/api/v1/deal/42/relationships/products" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":[{
"type":"products",
"id":"19"
}, {
"type":"products",
"id":"22"
}]
}
EOF
Изменение количества продуктов в сделке
curl "https://app.syncrm.ru/api/v1/entity-products/11/" \
-X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"entity-products",
"attributes":{
"quantity":12
}
}
}
EOF
JSON API type | entity-products |
URL | /api/v1/entity-products |
Список | GET /api/v1/entity-products |
Чтение | GET /api/v1/entity-products/{id} |
Создание | POST /api/v1/entity-products |
Редактирование | PATCH /api/v1/entity-products/{id} |
Удаление | DELETE /api/v1/entity-products/{id} |
Получение списка возможно только в контексте какого-либо объекта, то есть с обязательно указанными фильтрами entity-id
и entity-type
.
Связи
Пример данных
{
"data": {
"type":"products",
"id":"1",
"relationships":{
"entity":{
"links":{
"self":"/api/v1/entity-products/1/relationships/entity",
"related":"/api/v1/entity-products/1/entity"
}
},
"product":{
"links":{
"self":"/api/v1/entity-products/1/relationships/product",
"related":"/api/v1/entity-products/1/product"
}
},
"product-unit":{
"links":{
"self":"/api/v1/entity-products/1/relationships/product-unit",
"related":"/api/v1/entity-products/1/product-unit"
}
}
}
}
}
Пример запроса с загруженным объектом
curl "https://app.syncrm.ru/api/v1/entity-products??filter[entity-id]=11&filter[entity-type]=deals&include=entity" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Единица измерения | unit | product-units |
Объект | entity | deals , orders , contacts , companies |
Продукт | product | products |
Атрибуты
Атрибуты спецификаций
{
"data": {
"type":"entity-products",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Квартира",
"description": null,
"quantity": 2,
"purchase-price": "5000.0",
"total-amount": "10000.0"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name | string |
Квартира | нет | Название продукта |
description | string |
На улице Ленина | да | Описание продукта |
quantity | integer |
3 | да | Количество |
purchase-price | decimal |
200.0 | да | Цена закупочная за один продукт |
selling-price | decimal |
500.0 | да | Цена продажи за один продукт |
cost-price | decimal |
300.0 | да | себестоимость за один продукт |
total-amount | decimal |
1500.0 | нет | Конечная цена |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
Фильтры
Получить список спецификаций по определённой сделке
curl -G "https://app.syncrm.ru/api/v1/entity-products/?filter[entity-id]=11&filter[entity-type]=deals" \
-X GET \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token"
Фильтр | Описание | Пример |
---|---|---|
entity-id | Вывести объекты по определенному entity-id |
filter[entity-id]=1 |
entity-type | Вывести объекты по определенному entity-type . Допустимые значения: contacts , deals , orders , companies |
filter[entity-type]=contacts |
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Склады продуктов
Создание нового склада продуктов
curl "https://app.syncrm.ru/api/v1/stores" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"stores",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name":"Категория из API"
}
}
}
EOF
JSON API type | stores |
URL | /api/v1/stores |
Список | GET /api/v1/stores |
Чтение | GET /api/v1/stores/{id} |
Создание | POST /api/v1/stores |
Редактирование | PATCH /api/v1/stores/{id} |
Удаление | DELETE /api/v1/stores/{id} |
Атрибуты
{
"data": {
"type":"stores",
"id":"1",
"attributes":{
"name": "на Ленина"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
на Мира | да | Название склада |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список складов продуктов созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/stores" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Объекты недвижимости
Создание объекта недвижимости с предустановленными статусом
curl "https://app.syncrm.ru/api/v1/estate-properties" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"estate-properties",
"attributes":{
"name":"Объект недвижимости из API",
"description":"объект созданный при помощи API",
"purchase-price":10000.0
},
"relationships":{
"status":{
"data":{
"type":"estate-property-statuses",
"id":"2"
}
}
}
}
}
EOF
Пример установки обложки.
curl "https://app.syncrm.ru/api/v1/estate-properties/10" \
-X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"estate-properties",
"id":"10",
"relationships":{
"cover":{
"data":{
"type":"documents",
"id":"103"
}
}
}
}
}
EOF
JSON API type | estate-properties |
URL | /api/v1/estate-properties |
Список | GET /api/v1/estate-properties |
Чтение | GET /api/v1/estate-properties/{id} |
Создание | POST /api/v1/estate-properties |
Редактирование | PATCH /api/v1/estate-properties/{id} |
Удаление | DELETE /api/v1/estate-properties/{id} |
Атрибуты
{
"data": {
"type":"estate-properties",
"id": 1,
"attributes":{
"created-at": "2018-06-04T15:55:43.507+03:00",
"updated-at": "2018-06-08T14:01:41.353+03:00",
"cached-at": "2018-06-08T14:01:41.353+03:00",
"name": "Луначарского 9-280",
"cover-image": null,
"description": "отличное состояние",
"archived-at": null,
"purchase-price": null,
"map-url": "http://app.syncrm.ru",
"railway": "Станция 1",
"cadastral-num": "123123",
"highway-name": null,
"subway-name": "Метро 1",
"address": null,
"country": "Россия",
"region": "Москва",
"locality": "Москва",
"district": "Алтуфьевский",
"building-name": "ЖК Чистоста и порядок",
"build-at": 2005,
"city-dist": 10,
"subway-dist": 1,
"subway-transport": 5,
"subway-foot": 20,
"room-number": 100,
"total-room": 3,
"separate-rooms": 3,
"rooms-for-sell": 3,
"floor-number": 5,
"total-floors": 9,
"deal-type": null,
"object-type": "flat_and_room:flat",
"installments": null,
"bargain": "yes",
"mortgage": null,
"deal-category": "sell",
"balcony": "loggia",
"building-class": "aplus",
"building-type": "administrative",
"business-usage-type": null,
"commission-type": "percent",
"condition": null,
"climate": "heating",
"currency": "rur",
"feature": [],
"electricity": "yes",
"flat-status": null,
"flat-type": null,
"gas": "no",
"gate": "drive_a_truck",
"heating": "central",
"highway-access": "direct_access",
"land-usage-type": null,
"layout": "free",
"material": "concrete",
"new-flat": "yes",
"ownership": "agent",
"parking-type": "on_ground",
"rent-period": "long",
"plumbing": "central",
"payment-period": "month",
"land-purpose": null,
"ready-quarter": "II",
"relief": null,
"renovation": null,
"sewerage": "central",
"storage-type": null,
"toilet": "joined",
"warehouse-floor": null,
"warehouse-type": null,
"location-type": null,
"object-category": "flat_and_room",
"window-view": "street",
"encumbrance": null,
"build-stage": "done_not_passed",
"ceiling-height": 2.7,
"longitude": 37.617673,
"latitude": 55.755831,
"land-area": null,
"total-area": 69,
"living-area": 60,
"kitchen-area": 20,
"commission-sum": null,
"contact-phone": "79999999999",
"uid": "5efc566c803eea8beaab850e5c779eb6",
"rent-deposit": "without",
"customs": {
"custom-11801": "Кастомное значение"
}
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
address | string |
Ленинский 15 | Да | Адрес |
archived-at | datetime |
2016-11-26T12:07:51.572+03:00 |
Нет | Помещено в архив |
balcony | string |
balcony | Да | Балкон |
bargain | string |
yes | Да | Торг |
build-at | integer |
1981 | Да | Год постройки |
build-stage | string |
passed | Да | Стадия строительства |
building-class | string |
aplus | Да | Класс здания |
building-name | string |
ООО Управляющая компания | Да | Название ЖК |
building-type | string |
living_house | Да | Тип здания |
business-usage-type | string |
any | Да | Тип использования коммерческого помещения |
cached-at | datetime |
2016-11-26T12:07:51.572+03:00 |
Нет | Закэшировано |
cadastral-num | string |
47:14:1203001:814 | Да | Кадастровый номер |
ceiling-height | decimal |
2.9 | Да | Высота потолков |
city-dist | integer |
10 | Да | Расстояние до города, км |
climate | string |
heating | Да | Система контроля климата |
commission-sum | decimal |
10.0 | Да | Комиссия |
commission-type | string |
percent | Да | Тип комиссии |
condition | string |
normal | Да | Состояние коммерческого помещения |
contact-phone | string |
79999999999 | Да | Контактный телефон |
country | string |
Россия | Да | Страна |
cover-image | string |
https://example.com/path/to/file.jpg |
нет | Обложка.** |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
currency | string |
rur | Да | Валюта |
customs | hash |
{"custom-1":'custom value'} |
да | Свои поля |
deal-category | string |
sell | Да | Категория сделки |
deal-type | string |
sell:direct |
Да | Тип сделки |
description | string |
Хорошая квартира... |
Да | Описание |
district | string |
Автозаводский | Да | Район |
electricity | string |
yes |
Да | Электроснабжение |
encumbrance | string |
yes |
Да | Обременение |
feature | text |
['pool', 'wireless_internet', 'billiards', 'boiler', 'concierge] |
Да | Опции |
flat-status | string |
free | Да | Статус квартиры |
flat-type | string |
elite | Да | Тип квартиры |
floor-number | integer |
3 | Да | Этаж |
gas | string |
possible | Да | Газификация |
gate | string |
hyudralic_ramps | Да | Въезд |
heating | string |
central | Да | Отопление |
highway-access | string |
direct_access | Да | Транспортная доступность |
highway-name | string |
Шоссейное | Да | Шоссе |
installments | string |
no | Да | Рассрочка |
kitchen-area | decimal |
30.0 | Да | Кухня, м. кв. |
land-area | decimal |
0.0 | Да | Площадь участка, соток |
land-purpose | string |
settlements | Да | Использование земли |
land-usage-type | string |
igs | Да | Назначение земли |
latitude | decimal |
55.755831 | Да | Широта |
layout | string |
free | Да | Планировка |
living-area | decimal |
58 | Да | Жилая площадь, м. кв. |
locality | string |
Москва | Да | Населенный пункт |
location-type | string |
town | Да | Расположение |
longitude | decimal |
37.617673 | Да | Долгота |
map-url | string |
https://url_to_map | Да | Ссылка на карту |
material | string |
panel | Да | Материал стен |
mortgage | string |
no | Да | Ипотека |
name | string |
Квартира на комсомольской 15 | Да | Название |
new-flat | string |
yes | Да | Новостройка |
object-category | string |
flat_and_room | Да | Категория объекта |
object-type | string |
foreign_estate:apartments | Да | Тип объекта |
ownership | string |
owner | Да | Собственность |
parking-type | string |
on_ground | Да | Тип парковки |
payment-period | string |
month | Да | Период оплаты |
plumbing | string |
hole | Да | Водоснабжение |
purchase-price | decimal |
8000000 | Да | Цена |
railway | string |
Красная | Да | Ж/д станция |
ready-quarter | string |
III | Да | Квартал сдачи дома |
region | string |
Московская область | Да | Регион |
relief | string |
flat | Да | Рельеф |
renovation | string |
good | Да | Ремонт |
rent-deposit | string |
two_month | Да | Залог для аренды |
rent-period | string |
long | Да | Срок аренды |
room-number | integer |
14 | Да | Квартира |
rooms-for-sell | integer |
4 | Да | Комнат продается |
separate-rooms | integer |
4 | Да | Комнат раздельно |
sewerage | string |
Выгребная яма | Да | Канализация |
storage-type | string |
Напольное | Да | Тип хранения |
subway-dist | integer |
2 | Да | Расстояние до метро, м. |
subway-foot | integer |
5 | Да | До метро пешком, мин. |
subway-name | string |
Станция "тест" | Да | Метро |
subway-transport | integer |
2 | Да | До метро на транспорте, мин. |
toilet | string |
Совмещенный | Да | Туалет |
total-area | decimal |
55 | Да | Общая площадь, м. кв. |
total-floors | integer |
5 | Да | Этажей в доме |
total-room | integer |
3 | Да | Комнат всего |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Обновлено |
warehouse-floor | string |
Бетонный пол | Да | Покрытие полов |
warehouse-type | string |
Склад | Да | Тип складского помещения |
window-view | string |
Во двор | Да | Вид из окна |
Справочник атрибутов объектов недвижимости
* Обязательные поля ** Обложка может быть установлена только из тех документов, которые уже связаны с продуктом и являются изображением.
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"estate-properties",
"id":"1",
"relationships":{
"status":{
"links":{
"self":"/api/v1/estate-properties/1/relationships/status",
"related":"/api/v1/estate-properties/1/status"
}
}
}
}
}
Пример запроса с загруженными статусами
curl "https://app.syncrm.ru/api/v1/estate-properties?include=status" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Статус | status | product-statuses |
Источник | source | sources |
Задачи | diaries | diaries |
Заявки | orders | orders |
Сделки | deals | deals |
Изображения | images | documents |
Обложка | cover | documents |
Документы | documents | documents |
Статусы
Создание статуса объекта недвижимости
curl "https://app.syncrm.ru/api/v1/estate-property-statuses" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"estate-property-statuses",
"attributes":{
"name":"Статус объекта недвижимости в API",
"color":"#d2d2d2"
}
}
}
EOF
JSON API type | estate-property-statuses |
URL | /api/v1/estate-property-statuses |
Список | GET /api/v1/estate-property-statuses |
Чтение | GET /api/v1/estate-property-statuses/{id} |
Создание | POST /api/v1/estate-property-statuses |
Редактирование | PATCH /api/v1/estate-property-statuses/{id} |
Удаление | DELETE /api/v1/estate-property-statuses/{id} |
Атрибуты
{
"data": {
"type":"estate-property-statuses",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Новый",
"color": "#c62356"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Имя статуса объекта недвижимости |
color | string |
#1f2f3f | да | Цвет статуса объекта недвижимости |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список статусов объектов недвижимости созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/estate-property-statuses" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Счета и платежи
Пример данных для создания счета с позициями. Обязательно необходимо указать плательщика payer
{
"data":{
"type":"invoices",
"attributes":{
"positions":[
{
"product-id":41922,
"quantity":5,
"amount":300
},
{
"product-id":43329,
"quantity":1
}]
},
"relationships":{
"payer":{
"data":{
"type":"companies",
"id":510571
}
}
}
}
}
JSON API type | invoices |
URL | /api/v1/invoices |
Список | GET /api/v1/invoices |
Чтение | GET /api/v1/invoices/{id} |
Создание | POST /api/v1/invoices |
Редактирование | PATCH /api/v1/invoices/{id} |
Удаление | DELETE /api/v1/invoices/{id} |
Атрибуты
{
"data": {
"type":"invoices",
"id": 1,
"attributes":{
"number": 1112,
"custom-number": 1112,
"amount": "1500.0",
"due-date": null,
"vat-kind": "without",
"vat-rate": null,
"reason": null,
"issued-at": "2017-09-09T11:50:03.289+03:00",
"vi-date": "2017-09-09T11:50:03.289+03:00",
"torg-12-date": "2017-09-09T11:50:03.289+03:00",
"upd-date": "2017-09-09T11:50:03.289+03:00",
"act-date": "2017-09-09T11:50:03.289+03:00",
"shipping-date": "2017-09-09T11:50:03.289+03:00",
"status": "not_paid",
"balance": "1500.0",
"created-at": "2017-09-09T11:50:03.367+03:00",
"updated-at": "2017-09-09T11:50:03.420+03:00"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
positions | array |
[{"product-id":41922}] | да | Позиции счета |
number | integer |
345 | да | Номер автоматический |
custom-number | string |
мм.345.пп | да | Номер ручной |
amount | decimal |
1103.0 | да | Сумма счета |
vat-kind | string |
without |
да | Тип НДС |
vat-rate | integer |
10 | да | Значение НДС (%) |
due-date | datetime |
да | Срок оплаты | |
issued-at | datetime |
да | Дата проведения счета | |
vi-date | date |
да | Дата СФ | |
torg-12-date | date |
да | Дата ТОРГ-12 | |
upd-date | date |
да | Дата УПД | |
act-date | date |
да | Дата акта | |
shipping-date | date |
да | Дата отгрузки | |
reason | string |
л/с 56123 | да | Основание |
status | string |
not_paid |
да | Статус |
balance | decimal |
15000.0 | нет | Неоплаченный остаток по счету |
Позиции
Допустимые поля для значений массива JSON-объектов атрибута positions.
Поле | Тип | Описание |
---|---|---|
name* | string |
Переопределенное наименование товара |
product_id* | integer |
ID продукта |
quantity | integer |
Количество товара |
amount | decimal |
Сумма позиции |
is-service | boolean |
Товар (false) или услуга (true) |
unit | string |
Единица измерения |
code | code |
Код товара |
* Обязательные поля
Типы НДС
Допустимые значения для атрибута vat-kind
.
Тип НДС | Код |
---|---|
Без НДС | without |
НДС сверху | top |
НДС включен | include |
Статусы счетов
Допустимые значения для атрибута status
.
Статус | Код |
---|---|
Частично оплачен | partial |
Частично оплачен с просрочкой | partial_overdue |
Просрочен | overdue |
Не оплачен | not_paid |
Полностью оплачен | paid |
Без позиций | without_positions |
Связи
Название | Связь | JSON API type |
---|---|---|
Плательщик* | payer | companies , contacts |
Создатель | user | users |
Сделка | deal | deals |
Заявка | order | orders |
Продукты | products | products |
Позиции | positions | invoice-positions |
Платежи | payments | invoice-payments |
Банк. реквизиты | account-bank-detail | account-bank-details |
Банк. реквизиты компании | company-bank-detail | company-bank-details |
* Обязательная связь
Фильтры
Получить список счетов созданных после указанной даты
curl -G "https://app.syncrm.ru/api/v1/invoices/?filter[created-at-gte]=2017.08.01 12:00" \
-X GET \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Банковские реквизиты
Создание банковских реквизитов
curl "https://app.syncrm.ru/api/v1/account-bank-details" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"account-bank-details",
"attributes":{
"name":"test",
"kind":"calculated_invoice"
}
}
}
EOF
JSON API type | account-bank-details |
URL | /api/v1/account-bank-details |
Список | GET /api/v1/account-bank-details |
Чтение | GET /api/v1/account-bank-details/{id} |
Создание | POST /api/v1/account-bank-details |
Редактирование | PATCH /api/v1/account-bank-details/{id} |
Удаление | DELETE /api/v1/account-bank-details/{id} |
Атрибуты
{
"data":{
"id": "1",
"type": "account-bank-details",
"attributes":{
"created-at": "2017-09-04T12:48:33.114+03:00",
"updated-at": "2017-09-04T12:48:33.114+03:00",
"name": "КАЛУЖСКОЕ ОТДЕЛЕНИЕ N8608 ПАО СБЕРБАНК",
"bank-name": "СБЕРБАНК РОССИИ КАЛУЖСКОЕ ОТДЕЛЕНИЕ № 8608",
"bik": "042908612",
"corr-number": "12345678900000000000",
"number": "12345678900000000000",
"is-default": true,
"kind": "calculated_invoice"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Мой статус | да | Название набора реквизитов |
kind* | string |
cashbox |
да | Тип реквизитов (cashbox - касса, calculated_invoice - р/счет) |
bank-name | string |
Sberbank | да | Имя банка |
bik | string |
11239393 | да | БИК банка |
corr-number | string |
1234566788888 | да | Корр. счет |
number | string |
1234567890987 | да | Номер счета |
is-default | boolean |
true |
да | Основные реквизиты? |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Юридические лица аккаунта
Создание юридических лиц
curl "https://app.syncrm.ru/api/v1/org-details" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"org-details",
"attributes":{
"short-name":"test"
}
}
}
EOF
JSON API type | org-details |
URL | /api/v1/org-details |
Список | GET /api/v1/org-details |
Чтение | GET /api/v1/org-details/{id} |
Создание | POST /api/v1/org-details |
Редактирование | PATCH /api/v1/org-details/{id} |
Удаление | DELETE /api/v1/org-details/{id} |
Атрибуты
{
"data":{
"id": "1",
"type": "org-details",
"attributes":{
"created-at": "2017-09-04T12:48:33.114+03:00",
"updated-at": "2017-09-04T12:48:33.114+03:00",
"short-name": "ООО Рога и копыта",
"full-name": "Общество с ограниченной ответственность Рога и копыта"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
short-name* | string |
ООО Рога и копыта | да | Сокращенное название |
full-name | string |
ООО Рога и копыта | да | Название полное |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Позиции счета
Пример данных для создания позиции счета. Обязательно необходимо указать счет
invoice
, связь сproduct
является опциональной, если он не будет передан, то необходимо, чтобы были педераны атрибутыinvoice-position
, такие как:name
*,quantity
,amount
,code
,is-service
,unit
,discount
{
"data":{
"type":"invoice-positions",
"attributes":{
"quantity":10,
"amount":535.5,
"discount":10
},
"relationships":{
"product":{
"data":{
"type":"products",
"id":1
}
},
"invoice":{
"data":{
"type":"invoices",
"id":231
}
}
}
}
}
JSON API type | invoice-positions |
URL | /api/v1/invoice-positions |
Список | GET /api/v1/invoice-positions |
Чтение | GET /api/v1/invoice-positions/{id} |
Создание | POST /api/v1/invoice-positions |
Редактирование | PATCH /api/v1/invoice-positions/{id} |
Удаление | DELETE /api/v1/invoice-positions/{id} |
Атрибуты
{
"data": {
"type":"invoice-positions",
"id": 1,
"attributes":{
"name": "",
"quantity":15,
"amount": 1500.0,
"is-service": false,
"code": "3123"
"unit": "шт",
"created-at": "2017-09-09T11:50:03.367+03:00",
"updated-at": "2017-09-09T11:50:03.420+03:00"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name | string |
Товар | да | Переопределенное наименование товара |
quantity | integer |
5 | да | Количество товара |
discount | decimal |
10 | да | Скидка на товар |
amount | decimal |
1103.0 | да | Сумма позиции |
is-service | boolean |
false | да | Товар (false) или услуга (true) |
unit | string |
'шт' | да | Единица измерения |
code | code |
'123123' | да | Код товара |
Связи
Загрузка позиций по определенному счету (id = 100)
curl "https://app.syncrm.ru/api/v1/invoices/100/relationships/positions" \
-X GET \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token"
Название | Связь | JSON API type |
---|---|---|
Счет | invoice | invoices |
Продукт | product | products |
Платежи
Пример данных для создания платежа с типом "Приход" и привязкой к сделке. Указываем плательщика (payer), счет получателя (receiver-bank-detail) и счет (invoice), на основании которого происходит операция.
{
"data":{
"type":"invoice-payments",
"attributes":{
"direction":"income",
"amount":10.0,
"operation-created-at":"18.09.2017 13:45"
},
"relationships":{
"deal": {
"data": {
"type":"deals",
"id":175905
}
},
"payer":{
"data":{
"type":"companies",
"id":510571
}
},
"receiver-bank-detail":{
"data":{
"type":"account-bank-details",
"id":12
}
},
"invoice":{
"data":{
"type":"invoices",
"id":4128
}
}
}
}
}
Пример данных для создания платежа с типом "Расход" и привязкой к сделке. Указываем получателя (receiver), счет получателя (receiver-bank-detail) и счет (invoice), на основании которого происходит операция.
{
"data":{
"type":"invoice-payments",
"attributes":{
"direction":"outcome",
"amount":10.0,
"operation-created-at":"18.09.2017 13:45"
},
"relationships":{
"deal": {
"data": {
"type":"deals",
"id":175905
}
},
"receiver":{
"data":{
"type":"companies",
"id":510571
}
},
"payer-bank-detail":{
"data":{
"type":"account-bank-details",
"id":12
}
},
"invoice":{
"data":{
"type":"invoices",
"id":4128
}
}
}
}
}
Пример данных для создания платежа с типом "Перевод". Указываем с какого счета (payer-bank-detail) на какой счет (receiver-bank-detail) происходит перевод.
{
"data":{
"type":"invoice-payments",
"attributes":{
"direction":"transfer",
"amount":10.0,
"operation-created-at":"18.09.2017 13:45"
},
"relationships":{
"payer-bank-detail":{
"data":{
"type":"account-bank-details",
"id":75
}
},
"receiver-bank-detail":{
"data":{
"type":"account-bank-details",
"id":12
}
}
}
}
}
Атрибуты
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
number | integer |
345 | нет | Номер автоматический |
custom-number | string |
мм.345.пп | да | Номер ручной |
amount | decimal |
1103.0 | да | Сумма счета |
purpose | string |
Счет №23 | да | Назначение |
operation-created-at* | datetime |
да | Когда | |
operation-accounted-at | datetime |
да | Учесть в | |
operation-executed-at | datetime |
нет | Проведено | |
operation-canceled-at | datetime |
нет | Отменено | |
description | string |
от Петра | да | Комментарий |
direction | string |
income |
да (создание) | Тип |
status | string |
canceled |
да | Статус платежа |
* Обязательные поля
Фильтры платежей
Получить список платежей, созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/invoice-payments" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести платежи созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести платежи созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести платежи обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести платежи обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Статусы платежей
Название | Код |
---|---|
Исходящий, ожидающий исполнения | send_to_bank |
Проведен | executed |
Не проведен | not_executed |
Запланирован | planned |
Отменен | canceled |
Неизвестный | unknown |
Просрочен | overdue |
В обработке | process |
Типы платежей
Название | Код |
---|---|
Приход | income |
Расход | outcome |
Перевод | transfer |
Связи
Название | Связь | JSON API type |
---|---|---|
Ответственный | responsible | users |
Создатель | user | users |
Сделка | deal | deals |
Заявка | order | orders |
Плательщик | payer | companies , contacts |
Получатель | receiver | companies , contacts |
Счет | invoice | invoices |
Статья операции | invoice-payment-category | invoice-payment-categories |
Банк. реквизиты | account-bank-detail | account-bank-details |
Банк. реквизиты компании | company-bank-detail | company-bank-details |
Со счета | payer-bank-detail | company-bank-details , account-bank-details |
На счет | receiver-bank-detail | company-bank-details , account-bank-details |
Правила создания платежа
В платежах с типом "Приход" (income) контрагентом является Плательщик (payer). Так же необходимо указать банковские реквизиты получателя (receiver-bank-detail).
В платежах с типом "Расход" (outcome) контрагентом является Получатель (receiver).
В платежах с типом "Перевод" (transfer) необходимо указать счет отправителя (payer-bank-detail) и счет получателя (receiver-bank-detail).
Справочники
Получить список этапов сделок
curl "https://app.syncrm.ru/api/v1/deal-stages" -H "Authorization: Bearer api_token"
Добавить новый источник
curl "https://app.syncrm.ru/api/v1/sources" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"sources",
"attributes":{
"name":"Новый источник"
}
}
}
EOF
Справочник | JSON API type |
---|---|
Источники | sources |
Территории | areas |
Категории своих полей | custom-field-categories |
Свои поля | custom-fields |
Продукты | products |
Конкуренты | competitors |
Статусы компаний | company-statuses |
Типы компаний | company-types |
Воронки сделок | deal-stage-categories |
Этапы сделок | deal-stages |
Статусы сделок | deal-statuses |
Причины поражения сделок | deal-loss-reasons |
Этапы заявок | order-stages |
Статусы заявок | order-statuses |
Склады | stores |
Причины поражения заявок | order-loss-reasons |
Скидки | product-discounts |
Типы продкутов | product-types |
Статусы продуктов | product-statuses |
Категории продуктов | product-categories |
Статусы телефонии | telephony-statuses |
Статьи операций | invoice-payment-categories |
Запросы к справочникам имеют следующий формат:
URL | /api/v1/{json_api_type} |
Список | GET /api/v1/{json_api_type} |
Чтение | GET /api/v1/{json_api_type}/{id} |
Создание | POST /api/v1/{json_api_type} |
Редактирование | PATCH /api/v1/{json_api_type}/{id} |
Удаление | DELETE /api/v1/{json_api_type}/{id} |
Территории
Создание новой территории
curl "https://app.syncrm.ru/api/v1/areas" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"areas",
"attributes":{
"name":"Саратов"
}
}
}
EOF
Создание новой территории с привязанными сотрудниками
curl "https://app.syncrm.ru/api/v1/areas" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"areas",
"attributes":{
"name":"Красноярск"
},
"relationships":{
"users":{
"data":[{
"type":"users",
"id":"1"
},{
"type":"users",
"id":"2"
}]
}
}
}
}
EOF
JSON API type | areas |
URL | /api/v1/areas |
Список | GET /api/v1/areas |
Чтение | GET /api/v1/areas/{id} |
Создание | POST /api/v1/areas |
Редактирование | PATCH /api/v1/areas/{id} |
Удаление | DELETE /api/v1/areas/{id} |
Атрибуты
{
"data": {
"type":"areas",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Офис на Ленина"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Первый кабинет | да | Имя территории |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список территорий созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/areas" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Конкуренты
Создание нового конкурента
curl "https://app.syncrm.ru/api/v1/competitors" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"competitors",
"attributes":{
"name":"Конкурент из API",
"description":"ООО \"Рога и копыта\""
}
}
}
EOF
JSON API type | competitors |
URL | /api/v1/competitors |
Список | GET /api/v1/competitors |
Чтение | GET /api/v1/competitors/{id} |
Создание | POST /api/v1/competitors |
Редактирование | PATCH /api/v1/competitors/{id} |
Удаление | DELETE /api/v1/competitors/{id} |
Атрибуты
{
"data": {
"type":"competitors",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Конкурент из API",
"description": "ООО \"Рога и копыта\""
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
ООО "Копыта" | да | Имя конкурента |
description | string |
Коллекторское агенство | да | Описание конкурента |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список конкурентов созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/competitors" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Категории своих полей
Создание категории своих полей
curl "https://app.syncrm.ru/api/v1/custom-field-categories" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"custom-field-categories",
"attributes":{
"class-name":"Order",
"name":"Категория полей из API"
}
}
}
EOF
Атрибуты
{
"data": {
"id": "1",
"type": "custom-field-categories",
"links": {
"self": "https://app.syncrm.ru/api/v1/custom-field-categories/37"
},
"attributes": {
"created-at": "2016-01-14T17:18:25.675+03:00",
"updated-at": "2016-07-15T07:29:05.581+03:00",
"name": "Категория полей из API",
"class-name": "Order"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
День рождения | да | Название |
class-name* | string |
TelephonyCall |
да | Класс объекта |
* Обязательные поля
Ограничения по значениям
Аттрибут | Варианты |
---|---|
class-name | Company , Contact , Deal , Order , User , Product , TelephonyCall |
Фильтры
Получить список категорий своих полей созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/competitors" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Свои поля
Создание поля с предустановленной категорией своих полей
curl "https://app.syncrm.ru/api/v1/custom-fields" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"custom-fields",
"attributes":{
"required": false,
"resource-name": "deals",
"field-type": "text",
"name":"Своё поле из API"
},
"relationships":{
"custom-field-category":{
"data":{
"type":"custom-fields-categories",
"id":"1"
}
}
}
}
}
EOF
Атрибуты
{
"data": {
"id": "1",
"type": "custom-fields",
"links": {
"self": "https://app.syncrm.ru/api/v1/custom-fields/1"
},
"attributes": {
"created-at": "2016-01-14T17:18:25.675+03:00",
"updated-at": "2016-07-15T07:29:05.581+03:00",
"name": "Порода коровы",
"required": false,
"resource-name": "deals",
"field-type": "text",
"attribute-name": "custom-1",
"params": {
"acts_like":"text"
}
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
День рождения | да | Название |
resource-name* | string |
deals |
да | Расширяемый ресурс |
field-type* | string |
text |
да | Тип поля |
required | boolean |
true | да | Обязательное поле |
attribute-name | string |
custom-2 |
нет | Имя аттрибута для JSON API |
params | object |
{ "options": ["Пункт 1", "Пункт 2"] } | нет | Дополнительные параметры поля |
select-options | array |
[ "Пункт 1", "Пункт 2" ] | да | Атрибут для установки вариантов селекта (только у field-type select и только при создании и обновлении) |
tree-options | array |
[ { "name": "test", "childs": [] } ] | да | Дерево (только у field-type tree ). Доступны также через отдельный ресурс |
* Обязательные поля
Ограничения по значениям
Аттрибут | Варианты |
---|---|
resource-name | contacts , companies , deals , diaries , orders , products , telephony-calls , users |
field-type | text , date , number , select , tree |
Фильтры
Получить список своих полей для сделок
curl "https://app.syncrm.ru/api/v1/custom-fields" \
-X GET \
-H "Authorization: Bearer api_token" \
-d "filter[resources]=deals"
Фильтр | Описание | Пример |
---|---|---|
resources | Вывести поля по определенному resource-name |
filter[resources]=deals |
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Параметры дерева
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
id | integer |
23 | нет | Системный идентификатор узла дерева |
name* | string |
`Узел** | да | Текст узла |
childs* | object |
[{"name":"test", "childs":[]}] | Дочерние узлы дерева |
* Обязательные поля
Обноление своего поля с типом список и двумя пунктами
curl "https://app.syncrm.ru/api/v1/custom-fields" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"custom-fields",
"attributes":{
"required": false,
"resource-name": "deals",
"field-type": "select",
"name":"Своё поле из API",
"select-options": [
"Пункт 1",
"Пункт 2"
]
},
"relationships":{
"custom-field-category":{
"data":{
"type":"custom-fields-categories",
"id":"1"
}
}
}
}
}
Создание своего поля с типом дерево. Каждому пункту будет присвоен
curl "https://app.syncrm.ru/api/v1/custom-fields" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"custom-fields",
"attributes":{
"required": false,
"resource-name": "deals",
"field-type": "tree",
"name":"Своё поле из API",
"tree-options": [
{
"name": "Первый узел",
"childs": [
{
"name": "Вложенный узел",
"childs": []
}
]
}
]
},
"relationships":{
"custom-field-category":{
"data":{
"type":"custom-fields-categories",
"id":"1"
}
}
}
}
}
EOF
Обноление своего поля с типом дерево
curl "https://app.syncrm.ru/api/v1/custom-fields" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"custom-fields",
"attributes":{
"required": false,
"resource-name": "deals",
"field-type": "tree",
"name":"Своё поле из API",
"tree-options": [
{
"id": 20
"name": "Первый узел",
"childs": [
{
"id": 21
"name": "Переименованный узел",
"childs": []
}
]
}
]
},
"relationships":{
"custom-field-category":{
"data":{
"type":"custom-fields-categories",
"id":"1"
}
}
}
}
}
Пункты списка своего поля типа "Дерево"
Создание нового пункта для определённого своего поля
curl "https://app.syncrm.ru/api/v1/custom-field-options" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"custom-field-options",
"attributes":{
"name":"Пункт из API"
},
"relationships":{
"custom-field":{
"data":{
"type":"custom-fields",
"id":"1"
}
}
}
}
}
EOF
Создание нового пункта для определённого своего поля с предустановленным родительским пунктом
curl "https://app.syncrm.ru/api/v1/custom-field-options" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"custom-field-options",
"attributes":{
"name":"Пункт из API"
},
"relationships":{
"custom-field":{
"data":{
"type":"custom-fields",
"id":"1"
}
},
"parent":{
"data": {
"type":"custom-field-options",
"id":"1"
}
}
}
}
}
EOF
Перенос пункта от одного родителя другому
curl "https://app.syncrm.ru/api/v1/custom-field-options/2" \
-X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"id":"2"
"type":"custom-field-options",
"relationships":{
"custom-field":{
"data":{
"type":"custom-fields",
"id":"1"
}
},
"parent":{
"data": {
"type":"custom-field-options",
"id":"1"
}
}
}
}
}
EOF
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Пункт | да | Название |
* Обязательные поля
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"custom-field-options",
"id":"1",
"relationships":{
"parent":{
"links":{
"self":"/api/v1/diary-events/1/relationships/parent",
"related":"/api/v1/diary-events/1/parent"
}
},
"custom-field":{
"links":{
"self":"/api/v1/diary-events/1/relationships/custom-field",
"related":"/api/v1/diary-events/1/custom-field"
}
}
}
}
}
Пример запроса с загруженными типами задачи и отвественными
curl "https://app.syncrm.ru/api/v1/custom-field-options?include=parent" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Своё поле | custom-field | custom-fields |
Родительский пункт | parent | custom-field-options |
Дочерние пункты | children | custom-field-options |
Поддерево | subtree | custom-field-options |
Фильтры
Получить список своих полей для сделок
curl "https://app.syncrm.ru/api/v1/custom-field-options" \
-X GET \
-H "Authorization: Bearer api_token" \
-d "filter[custom-field-id]=123"
Фильтр | Описание | Пример |
---|---|---|
custom-field-id | Вывести поля по определенному идентификтору своего поля | filter[custom-field-id]=deals |
Источники
Создание нового источника
curl "https://app.syncrm.ru/api/v1/sources" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"sources",
"attributes":{
"name":"Источник из API"
}
}
}
EOF
JSON API type | sources |
URL | /api/v1/sources |
Список | GET /api/v1/sources |
Чтение | GET /api/v1/sources/{id} |
Создание | POST /api/v1/sources |
Редактирование | PATCH /api/v1/sources/{id} |
Удаление | DELETE /api/v1/sources/{id} |
Атрибуты
{
"data": {
"type":"sources",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "E-Mail рассылка"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Холодные звонки | да | Имя источника |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Ограничения по значениям
Аттрибут | Варианты |
---|---|
type | per_lead , flat_fee |
Фильтры
Получить список источников созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/sources" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Должности
Создание новой должности
curl "https://app.syncrm.ru/api/v1/work-positions" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"work-positions",
"attributes":{
"name":"Менеджер"
}
}
}
EOF
JSON API type | work-positions |
URL | /api/v1/work-positions |
Список | GET /api/v1/work-positions |
Чтение | GET /api/v1/work-positions/{id} |
Создание | POST /api/v1/work-positions |
Редактирование | PATCH /api/v1/work-positions/{id} |
Удаление | DELETE /api/v1/work-positions/{id} |
Атрибуты
{
"data": {
"type":"work-positions",
"id":"1",
"attributes":{
"created-at":"2016-11-26T12:07:51.572+03:00",
"updated-at":"2016-11-26T12:07:51.572+03:00",
"name": "Менеджер"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
name* | string |
Менеджер | да | Название должности |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
* Обязательные поля
Фильтры
Получить список должностей созданных до определённой даты
curl -G "https://app.syncrm.ru/api/v1/areas" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[created-at-gte]=2017.08.01 12:00"
Фильтр | Описание | Пример |
---|---|---|
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |
Пользователи
Профиль текущего пользователя
Обновление номера телефона в профиле текущего пользователя
curl "https://app.syncrm.ru/api/v1/profile" \
-X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"id": 10,
"type":"users",
"attributes":{
"phone":"+77054310114"
}
}
}
EOF
JSON API type | users |
URL | /api/v1/profile |
Чтение | GET /api/v1/profile |
Редактирование | PATCH /api/v1/profile |
Атрибуты
{
"data": {
"id": "1",
"type": "users",
"attributes": {
"created-at": "2017-09-01T12:00:00.000+00:00",
"updated-at": "2017-09-01T12:00:00.000+00:00",
"email": "executive@example.com",
"first-name": "Иван",
"last-name": "Иванов",
"middle-name": "Иванович",
"phone": "+5627508253",
"position": "Executive Marketing Secretary",
"avatar": "https://example.com/link/to/avatar.png"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
first-name | string |
Иван |
да | Имя |
last-name | string |
Иванов |
да | Фамилия |
middle-name | string |
Иванович |
да | Отчество |
phone | string |
+5627508253 |
да | Телефон |
position | string |
Менеджер |
да | Должность |
avatar | string |
https://example.com/link/to/avatar.png |
нет | Аватар пользователя |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
Вебхуки
Раздел системы: Настройки -> Автоматизации -> Сценарии
С помощью вебхуков вы можете отправить информацию об объекте автоматизации на указанный адрес.
Объектом автоматизации может быть сделка, заявка, почтовое сообщение, компания или контакт.
Структура JSON
{
"type": "Deal",
"timestamp": 1519466739,
"data": {
"id": 1
},
"custom_fields": {
"custom_1": "Свое поле №1"
}
}
Информация об объекте представлена в формате JSON. Каждый объект JSON имеет следующие поля:
type
- тип объекта. может быть Deal, Order, Company, Contact, MailMessage
timestamp
- дата срабатывания автоматизации. Может не совпадать с временем отправки в том
случае если сообщение было отправлено повторно (например, адрес указанный для вебхука
недоступен или возвращает ошибку).
data
- вся информация по объекту
custom_fields
- база данных с сопоставлением имен своих полей и сгенерированных имен системой
Сделки
{
"type": "Deal",
"timestamp": 1519466985,
"data": {
"id": 72738,
"name": "Сделка",
"description": null,
"note": null,
"amount": "0.0",
"cost": "0.0",
"finished_at": null,
"planned_at": null,
"created_at": "02.02.2018 18:36:41",
"updated_at": "02.02.2018 18:36:41",
"user_id": 1,
"user": "Andreeeee",
"responsible_id": 1,
"responsible": "Andreeeee",
"stage_id": 1129,
"stage": "База для обзвона",
"stage_category_id": 150,
"stage_category": "Партнеры",
"status_id": 65,
"status": "Без статуса",
"source_id": null,
"source": "",
"area_id": null,
"area": "",
"loss_reason_id": null,
"loss_reason": "",
"loss_competitor_id": null,
"loss_competitor": "",
"company_id": null,
"company": "",
"contact_id": null,
"contact": "",
"custom_5808": [],
"custom_10535": [],
"custom_11906": []
},
"custom_fields": {
"custom_5808": "Маркерt",
"custom_10535": "Куратор ФГ",
"custom_11906": "Тариф"
}
}
Атрибут | Описание |
---|---|
id | ID объекта |
name | Название |
description | Описание |
note | Заметка |
amount | Цена |
cost | Себестоимость |
finished_at | Фактическая дата закрытия |
planned_at | Планируемая дата закрытия |
created_at | Дата создания |
updated_at | Дата последнего обновления |
user_id | Создатель (ID) |
user | Создатель (ФИО) |
responsible_id | Ответственный (ID) |
responsible | Ответственный (ФИО) |
stage_id | Этап (ID) |
stage | Этап (название) |
stage_category_id | Воронка (ID) |
stage_category | Воронка (название) |
status_id | Статус (ID) |
status | Статус (название) |
source_id | Источник (ID) |
source | Источник (название) |
area_id | Территория (ID) |
area | Территория (название) |
loss_reason_id | Причина поражения (ID) |
loss_reason | Причина поражения (название) |
loss_competitor_id | Конкурент поражения (ID) |
loss_competitor | Конкурент поражения (название) |
company_id | Компания (ID) |
company | Компания (название) |
contact_id | Контакт (ID) |
contact | Контакт (ФИО) |
custom_{id} | Свои поля |
Заявки
{
"type": "Order",
"timestamp": 1519556577,
"data": {
"id": 45797,
"name": "Api test",
"description": "Api test v 0.1",
"note": null,
"amount": "0.0",
"cost": "0.0",
"created_at": "04.10.2017 19:06:01",
"updated_at": "04.10.2017 19:06:01",
"user_id": 1,
"user": "Andreeeee",
"responsible_id": null,
"responsible": "",
"stage_id": 127,
"stage": "Не обработана",
"status_id": 45,
"status": "Без статуса",
"source_id": null,
"source": "",
"loss_reason_id": null,
"loss_reason": "",
"loss_competitor_id": null,
"loss_competitor": "",
"company_id": null,
"company": "",
"contact_id": null,
"contact": "",
"custom_26": "",
"custom_27": "",
"custom_130": "",
"custom_12239": []
},
"custom_fields": {
"custom_26": "Сообщение",
"custom_27": "Комп. (партнер)",
"custom_130": "Интересно",
"custom_12239": "Куратор ФГ"
}
}
Атрибут | Описание |
---|---|
id | ID объекта |
name | Название |
description | Описание |
note | Заметка |
amount | Цена |
cost | Себестоимость |
finished_at | Фактическая дата закрытия |
planned_at | Планируемая дата закрытия |
created_at | Дата создания |
updated_at | Дата последнего обновления |
user_id | Создатель (ID) |
user | Создатель (ФИО) |
responsible_id | Ответственный (ID) |
responsible | Ответственный (ФИО) |
stage_id | Этап (ID) |
stage | Этап (название) |
status_id | Статус (ID) |
status | Статус (название) |
source_id | Источник (ID) |
source | Источник (название) |
loss_reason_id | Причина поражения (ID) |
loss_reason | Причина поражения (название) |
loss_competitor_id | Конкурент поражения (ID) |
loss_competitor | Конкурент поражения (название) |
company_id | Компания (ID) |
company | Компания (название) |
contact_id | Контакт (ID) |
contact | Контакт (ФИО) |
custom_{id} | Свои поля |
Компании
{
"type": "Company",
"timestamp": 1519556956,
"data": {
"name": "Conroy-Parker",
"general_phone": null,
"work_phone": "+79001231212",
"other_phone": "+79001231212",
"fax": null,
"email": "e@ma.il",
"other_email": "email@mail.com",
"website": "google.com",
"description": null,
"note": null,
"inn": null,
"full_name": null,
"short_name": null,
"ogrn": null,
"kpp": null,
"okved": null,
"manager_name": null,
"manager_position": null,
"lawfulness_base": null,
"accountant": null,
"country": null,
"address": "5th Avenue",
"region": "NY",
"city": "NY, Manhattan",
"street": null,
"house": null,
"flat": null,
"zip_code": "37891-0000",
"juristic_country": null,
"juristic_region": null,
"juristic_city": null,
"juristic_zip_code": null,
"juristic_street": null,
"juristic_house": null,
"juristic_build": null,
"juristic_office": null,
"actual_country": null,
"actual_region": null,
"actual_city": null,
"actual_zip_code": null,
"actual_street": null,
"actual_house": null,
"actual_build": null,
"actual_office": null,
"mailing_country": null,
"mailing_region": null,
"mailing_city": null,
"mailing_zip_code": null,
"mailing_street": null,
"mailing_house": null,
"mailing_build": null,
"mailing_office": null,
"created_at": "26.12.2017 10:30:56",
"updated_at": "26.12.2017 10:30:56",
"user_id": 5851,
"user": "Светочка",
"responsible_id": null,
"responsible": "",
"source_id": null,
"source": "",
"status_id": null,
"status": "",
"type_id": null,
"type": "",
"custom_1": "Только наличными"
},
"custom_fields": {
"custom_1": "Особые отметки"
}
}
Атрибут | Описание |
---|---|
name | Название |
general_phone | Осн. тел. |
work_phone | Раб. тел. |
other_phone | Доп. тел. |
fax | Факс |
other_email | Доп. e-mail |
website | Вебсайт |
description | Описание |
note | Заметка |
inn | ИНН |
full_name | Полн. наименование |
short_name | Сокр. наименование |
ogrn | ОГРН |
kpp | КПП |
okved | ОКВЭД |
manager_name | ФИО рук-ля |
manager_position | Должность рук-ля |
lawfulness_base | Правомочность |
accountant | Гл.бухгалтер |
country | Страна |
address | Адрес |
region | Регион |
city | Город |
street | Улица |
house | Дом |
flat | Офис/Квартира |
zip_code | Индекс |
juristic_country | Юр. страна |
juristic_region | Юр. регион |
juristic_city | Юр. город |
juristic_zip_code | Юр. индекс |
juristic_street | Юр. улица |
juristic_house | Юр. дом |
juristic_build | Юр. строение |
juristic_office | Юр. офис |
actual_country | Факт. страна |
actual_region | Факт. регион |
actual_city | Факт. город |
actual_zip_code | Факт. индекс |
actual_street | Факт. улица |
actual_house | Факт. дом |
actual_build | Факт. корпус |
actual_office | Факт. офис |
mailing_country | Почт. страна |
mailing_region | Почт. регион |
mailing_city | Почт. город |
mailing_zip_code | Почт. индекс |
mailing_street | Почт. улица |
mailing_house | Почт. дом |
mailing_build | Почт. строение |
mailing_office | Почт. офис |
created_at | Создано |
updated_at | Обновлено |
user_id | Создатель (ID) |
user | Создатель |
responsible_id | Ответственный (ID) |
responsible | Ответственный |
source_id | Источник (ID) |
source | Источник |
status_id | Статус (ID) |
status | Статус |
type_id | Тип (ID) |
type | Тип |
custom_{id} | Свои поля |
Контакты
{
"type": "Contact",
"timestamp": 1519557678,
"data": {
"name": "Lastname Firstname Middlename",
"position": "lll",
"first_name": "Firstname",
"last_name": "Lastname",
"middle_name": "Middlename",
"mobile_phone": null,
"general_phone": null,
"work_phone": null,
"other_phone": null,
"email": "llll@llll.lll",
"other_email": null,
"description": "basic",
"note": null,
"fax": null,
"website": null,
"created_at": "27.12.2017 10:00:11",
"updated_at": "27.12.2017 10:00:11",
"work_country": null,
"work_region": null,
"work_city": null,
"work_zipcode": null,
"work_street": null,
"work_building": null,
"work_housing": null,
"work_apartment": null,
"home_country": null,
"home_region": null,
"home_city": null,
"home_zipcode": null,
"home_street": null,
"home_building": null,
"home_housing": null,
"home_apartment": null,
"vkontakte": null,
"facebook": null,
"linkedin": null,
"odnoklassniki": null,
"instagram": null,
"twitter": null,
"whatsapp": null,
"viber": null,
"telegram": null,
"skype": null,
"responsible_id": 2,
"responsible": "Яковлевски Эндрю",
"user_id": 2,
"user": "Яковлевски Эндрю",
"status_id": null,
"status": "",
"type_id": 19975,
"type": "Регистрация",
"source_id": null,
"source": ""
},
"custom_fields": {}
}
Атрибут | Описание |
---|---|
name | ФИО |
position | Должность |
first_name | Имя |
last_name | Фамилия |
middle_name | Отчество |
mobile_phone | Моб. тел. |
general_phone | Осн. тел. |
work_phone | Раб. тел. |
other_phone | Доп. тел. |
other_email | Доп. e-mail |
description | Описание |
note | Заметка |
fax | Факс |
website | Вебсайт |
created_at | Создано |
updated_at | Изменено |
work_country | Раб. страна |
work_region | Раб. регион |
work_city | Раб. город |
work_zipcode | Раб. индекс |
work_street | Раб. улица |
work_building | Раб. дом |
work_housing | Раб. корпус |
work_apartment | Раб. офис |
home_country | Дом. страна |
home_region | Дом. регион |
home_city | Дом. город |
home_zipcode | Дом. индекс |
home_street | Дом. улица |
home_building | Дом. дом |
home_housing | Дом. корпус |
home_apartment | Дом. квартира |
vkontakte | VK |
odnoklassniki | Одноклассники |
viber | Viber |
telegram | Telegram |
skype | Skype |
responsible_id | Ответственный (ID) |
responsible | Ответственный |
user_id | Создатель (ID) |
user | Создатель |
status_id | Status (ID) |
status | Статус |
type_id | Тип (ID) |
type | Тип |
source_id | Источник (ID) |
source | Источник |
Почтовые сообщения
{
"type": "MailMessage",
"timestamp": 1519557828,
"data": {
"from": [
{
"name": "Андрей Спамер",
"address": "spam@yandex.ru"
}
],
"to": [
{
"name": null,
"address": "retired@person.ru"
}
],
"subject": "Просто заберите ваши деньги",
"message_id": "<00000000000000@web52g.yandex.ru>",
"body": "<div>Здравствуйте!</div><br /><span lang=\"ru\">Вы выиграли лярд!</span>",
"direction": "outgoing",
"replied_at": null,
"forwarded_at": null,
"created_at": "04.09.2017 15:14:38",
"folder_id": 3193,
"folder": "Отправленные",
"label_id": null,
"label": "",
"responsible_id": null,
"responsible": "",
"creator_id": 3136,
"creator": "Андрей Спамер"
}
}
Атрибут | Описание |
---|---|
from | От кого |
to | Кому |
subject | Тема |
message_id | MessageID у почтового провайдера |
body | Сообщение |
direction | Тип (outgoing - исходящее, incoming - входящее) |
replied_at | Отвечено |
forwarded_at | Переслано |
created_at | Создано |
folder_id | Папка (ID) |
folder | Папка |
label_id | Метка (ID) |
label | Метка |
responsible_id | Ответственный (ID) |
responsible | Ответственный |
creator_id | Создатель (ID) |
creator | Создатель |
Активности
Чтение активности с предустановленным ресурсом контакта
curl "https://app.syncrm.ru/api/v1/activities" \
-X GET \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[trackable-type]=contacts"
EOF
JSON API type | activities |
URL | /api/v1/activities |
Список | GET /api/v1/activities |
Чтение | GET /api/v1/activities/{id} |
Атрибуты
{
"data": {
"type":"activities",
"id":"1",
"attributes":{
"created-at": "2015-12-21T23:25:30.691+03:00",
"updated-at": "2016-02-25T20:19:21.080+03:00",
"key": "create",
"parameters":{
"changes" : {
"Id" : {
"new_name" : 55,
"old_name" : null,
"field" : "id"
},
"Создатель" : {
"old_id" : null,
"new_name" : "Иван Иванов",
"new_id" : 13,
"old_name" : "",
"field" : "user_id"
},
"Сотрудник" : {
"new_id" : 13,
"old_name" : "",
"field" : "responsible_id",
"new_name" : "Иван Иванов",
"old_id" : null
},
"Тема" : {
"new_name" : "test",
"field" : "name",
"old_name" : null
}
},
"creator" : "Иван Иванов",
"object" : "",
"this" : "test"
}
}
}
}
Основные атрибуты
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
key | string |
Иван | да | Тип активности |
parameters | json |
{"editor":"Иван"} | да | Параметры активности (изменения/описание события) |
Связи
Пример данных (перечислены не все связи)
{
"data": {
"type":"activities",
"id":"1",
"relationships":{
"trackable":{
"links":{
"self":"/api/v1/activities/1/relationships/trackable",
"related":"/api/v1/activities/1/trackable"
}
},
"user":{
"links":{
"self":"/api/v1/activities/1/relationships/user",
"related":"/api/v1/activities/1/user"
}
}
}
}
}
Пример запроса с загруженными автором изменения и изменённым объектом
curl "https://app.syncrm.ru/api/v1/activities?include=user,trackable" \
-H "Authorization: Bearer api_token"
Каждая связь может быть включена в JSON ответ через параметр include
, согласно
официальной спецификации JSON API Inclusion of Related Resources.
Название | Связь | JSON API type |
---|---|---|
Объект активности | trackable | companies , contacts , deals , entries , orders , diaries , products , estate-properties , users , invoices , invoice-payments |
Автор активности | user | users |
Фильтры
Получить список активностей определённого пользователя
curl -G "https://app.syncrm.ru/api/v1/activities" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[user_id]=117"
Получить список активностей по определённой компании
curl -G "https://app.syncrm.ru/api/v1/activities" \
-X GET \
-H "Authorization: Bearer api_token" \
--data-urlencode "filter[trackable_type]=companies"
--data-urlencode "filter[trackable_id]=8122"
Фильтр | Описание | Пример |
---|---|---|
trackable_type* | Вывести активности по определённому типу ресурса | filter[trackable_type]=contacts |
trackable_id | Вывести активности по идентификатору объекта | filter[trackable_id]=8122 |
key** | Вывести активности по определённому типу события | filter[key]=create |
user_id | Вывести активности по определённому пользователю | filter[user_id]=113 |
* Возможные значения: companies, contacts, deals, entries, orders, diaries, products, estate-properties, users, invoices, invoice-payments.
** Возможные значения: sms_sent, restore, create_invoice, create_invoice_payment, import, diary_action, archive, update, destroy, create, message.
Трекинг рабочего времени пользователя
Создание рабочего времени
curl "https://app.syncrm.ru/api/v1/user-work-times" \
-X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer api_token" \
-d @- << EOF
{
"data":{
"type":"user-work-times",
"attributes":{
"started-at":"2019-02-12T11:32:32+03:00",
"finished-at":"2019-02-12T15:57:10+03:00"
}
}
}
EOF
JSON API type | user-work-times |
URL | /api/v1/user-work-times |
Список | GET /api/v1/user-work-times |
Чтение | GET /api/v1/user-work-times/{id} |
Создание | POST /api/v1/user-work-times |
Редактирование | PATCH /api/v1/user-work-times/{id} |
Удаление | DELETE /api/v1/user-work-times/{id} |
Атрибуты
{
"data": {
"type":"user-work-times",
"id":"1",
"attributes":{
"started-at":"2019-02-12T11:32:32+03:00",
"finished-at":"2019-02-12T15:57:10+03:00",
"created-at":"2019-02-12T11:32:32+03:00",
"updated-at":"2019-02-12T11:32:32+03:00"
}
}
}
Имя | Тип | Пример | Запись | Описание |
---|---|---|---|---|
started-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Провайдер телефонии |
finished-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата окончания рабочего времени |
created-at | datetime |
2016-11-26T12:07:51.572+03:00 |
да | Дата создания |
updated-at | datetime |
2016-11-26T12:07:51.572+03:00 |
нет | Дата обновления |
Фильтры
Получить список учтённого рабочего времени по определённому пользователю
curl -G "https://app.syncrm.ru/api/v1/user-work-times?filter[user-id]=324" \
-X GET \
-H "Authorization: Bearer api_token"
Фильтр | Описание | Пример |
---|---|---|
user-id | Вывести объекты созданные определённым пользователем | filter[user-id]=324 |
started-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
started-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
finished-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
finished-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
created-at-gte | Вывести объекты созданные после указанного времени | filter[created-at-gte]=2017.08.01 12:00 |
created-at-lte | Вывести объекты созданные до указанного времени | filter[created-at-lte]=2017.08.01 12:00 |
updated-at-gte | Вывести объекты обновлённые после указанного времени | filter[updated-at-gte]=2017.08.01 12:00 |
updated-at-lte | Вывести объекты обновлённые до указанного времени | filter[updated-at-lte]=2017.08.01 12:00 |