> For the complete documentation index, see [llms.txt](https://apidoc.myfreshcloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.myfreshcloud.com/reference/deals/list_of_deals.md).

# Список

{% hint style="info" %}
**Нужно помнить:** позиции в списке будут выданы согласно уровня доступа собственника токена. 

О правах <https://help.myfreshcloud.com/settings/users/access-rights>
{% endhint %}

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

<mark style="color:green;">`POST`</mark> `https://do.myfreshcloud.com/common/list/paging/20`

#### Path Parameters

| Name                                  | Type | Description |
| ------------------------------------- | ---- | ----------- |
| /20<mark style="color:red;">\*</mark> | Int  | Код модуля  |

#### Query Parameters

| Name                                      | Type   | Description                          |
| ----------------------------------------- | ------ | ------------------------------------ |
| columns<mark style="color:red;">\*</mark> | String | Список колонок                       |
| records\_onpage                           | Int    | Записей на странице, но не более 500 |
| page                                      | Int    | Номер страницы                       |
| sorting\_column                           | String | Колонка сортировки                   |
| sorting\_direction                        | Int    | Сортировка 0 Asc 1 Desc              |

#### Headers

| Name                                            | Type   | Description                |
| ----------------------------------------------- | ------ | -------------------------- |
| Authorization<mark style="color:red;">\*</mark> | String | Bearer XXXXX-XXXXXXX-XXXXX |
| Content-Type<mark style="color:red;">\*</mark>  | String | application/json           |

{% tabs %}
{% tab title="200: OK Стандартный объект ответа" %}

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

{% endtab %}

{% tab title="401: Unauthorized " %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## Пример

{% tabs %}
{% tab title="с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 ''
```

{% endtab %}

{% tab title="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;
```

{% endtab %}

{% tab title="NodeJs(Request)" %}

```
// Some code
```

{% endtab %}
{% endtabs %}

## Columns

{% hint style="info" %}
**На заметку:** колонки с префиксом **company\_**  содержат информацию о контрагенте, это может быть как юридическое лицо, так и физическое. В случае с юридическим лицом **company\_name** это название компании, а в случае с физическим лицом это ФИО физ лица.&#x20;
{% endhint %}

| Имя                   | Описние                                             |
| --------------------- | --------------------------------------------------- |
| **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}       | Дополнительные поля                                 |

{% content-ref url="/pages/fZsjhP1J1Ge2uwFxY6jU" %}
[Добавленные поля](/reference/dobavlennye-polya.md)
{% endcontent-ref %}

## Фильтрация

{% hint style="info" %}
**На заметку:** можно использовать 2 метода фильтрации. Стандартная фильтрация по колонкам. По ID готового фильтра, который был создан внутри приложения, подробней: <https://help.myfreshcloud.com/settings/filters> ⚡️
{% endhint %}

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

```
?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 - Номер страницы которую нужно получить

```

{% hint style="info" %}
⚡️**type\_id**  ⚡️**status\_id**

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

{% content-ref url="/pages/DiE2Qj4rWlKxztIaLzfD" %}
[Справочники](/reference/directory.md)
{% endcontent-ref %}

{% hint style="info" %}
⚡️**user\_ids**

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

{% content-ref url="/pages/AZqUPlTdpl1jAyZMvODJ" %}
[Пользователи](/reference/users.md)
{% endcontent-ref %}