Список

Примечание

Нужно помнить: позиции в списке будут выданы согласно уровня доступа собственника токена.

О правах права доступа

Список сделок с постраничной выдачей

POST https://do.freshoffice.ru/common/list/paging/20

Path Parameters

Name Type Description
/20* Int Код модуля

Query Parameters

Name Type Description
columns* String Список колонок
records_onpage Int Записей на странице, но не более 500
page Int Номер страницы
sorting_column String Колонка сортировки
sorting_direction Int Сортировка 0 Asc 1 Desc

Headers

Name Type Description
Authorization* String Bearer XXXXX-XXXXXXX-XXXXX
Content-Type* String application/json 
{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 1,
  "pages": 1,
  "page": 1,
  "value": "[
       {"id":1,"name":"Sale"}
  ]"

{
    // Response
}

Пример

curl --location --request
POST 'https://do.freshoffice.ru/common/list/paging/20
?columns=id,name,type,status,sum
&records_onpage=1000
&sorting_direction=0
&sorting_column=id
&user_ids=37
&type_id=1
&date1=2021-01-01&date2=2022-12-31' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXX.XXXXX.XXXXX' \
--data-raw ''

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://do.freshoffice.ru/common/list/paging/20
  ?columns=id,name,type,status,sum
  &records_onpage=1000
  &sorting_direction=0
  &sorting_column=id
  &user_ids=37
  &type_id=1
  &date1=2021-01-01
  &date2=2022-12-31',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer XXXXXX.XXXXXX.XXXXX'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

// Some code

Фильтрация

Примечание

На заметку: можно использовать 2 метода фильтрации. Стандартная фильтрация по колонкам. По ID готового фильтра, который был создан внутри приложения, подробней: фильтры в приложении ⚡️

Фильтры добавляются к запросу как query-параметры и сочетаются между собой:

  • company_id — код контрагента, только сделки одной компании: ?company_id=368132
  • id — код сделки: ?id=12345
  • user_ids — коды ответственных, один или несколько: ?user_ids=37 или ?user_ids=1,3,5
  • type_id — код типа сделки: ?type_id=1
  • status_id — код статуса (этапа) сделки: ?status_id=5
  • date1 — с даты (формат YYYY-MM-DD): ?date1=2026-01-01
  • date2 — по дату (формат YYYY-MM-DD): ?date2=2026-12-31
  • tags — теги через запятую: ?tags=vip,опт

Пример — сделки одного контрагента:

curl --location --request POST 'https://do.freshoffice.ru/common/list/paging/20?company_id=368132&columns=id,name,status,sum' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Примечание

Это общий паттерн: пагинация и фильтры company_id, deal_id, user_ids, date1/date2, tags работают одинаково во всех модулях универсального списка common/list/paging/{модуль}. Коды модулей: 1 — контрагенты, 2 — задачи, 4 — документы, 5 — финансы, 6 — продажи, 20 — сделки, 21 — товары, 24 — почта, 50 — журнал.

Примечание

⚡️type_id ⚡️status_id

Коды можно найти в разделе Справочники

Примечание

⚡️user_ids

Коды пользователей можно найти в разделе Пользователи

Columns

Примечание

На заметку: колонки с префиксом company_ содержат информацию о контрагенте, это может быть как юридическое лицо, так и физическое. В случае с юридическим лицом company_name это название компании, а в случае с физическим лицом это ФИО физ лица.

Имя Описние
id Идентификатор сделки
name Наименование
sum Сумма
type_id Код типа сделки
type Тип сделки
status_id Код статуса сделки
status Статус сделки
company_id Код контрагента
company_name Наименование контрагента
company_type Тип контрагента
company_status Статус контрагента
company_category Категория контрагента
company_tax_id Код налогоплательщика по списку реквизитов компании
company_country Страна контрагента
company_region Регион контрагента
company_city Город контрагента
company_url Вэб сайт контрагента
user_id Код ответственного за сделку
user_name Ответственный за сделку
note Примечание к сделке
ADD_ Дополнительные поля

Добавленные поля

Предыдущая
Сделки
Следующая
Добавление