Список

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

О правах https://help.myfreshcloud.com/settings/users/access-rights

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

POST https://do.myfreshcloud.com/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

200: OK Стандартный объект ответа

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 1,
  "pages": 1,
  "page": 1,
  "value": "[
       {"id":1,"name":"Sale"}
  ]"

401: Unauthorized

{
    // Response
}

Пример

сURL

curl --location --request 
POST 'https://do.myfreshcloud.com/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

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://do.myfreshcloud.com/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;

NodeJs(Request)

// Some code

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_{name}	Дополнительные поля

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

Фильтрация

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

Колонки фильтрации

?id=1
?segment=1 
?user_ids=1  0r ?user_ids=1,3,5
?date1=2021-12-01
?date2=2021-12-31
?company_id=1
?type_id=1
?status_id=1
?page=1

// id - Код сделки 
// user_ids - Код пользователя чьи сделки нужно получить
// date1 - С даты (формат YYYY.MM.DD)
// date2 - По дату (формат YYYY.MM.DD)
// company_id - Код контрагента (все сделки по компании)
// type_id - Код типа сделки
// status_id - Код статуса сделки
// page - Номер страницы которую нужно получить

⚡️type_id ⚡️status_id

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

pageСправочники

⚡️user_ids

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

pageПользователи