Список
Примечание
Нужно помнить: позиции в списке будут выданы согласно уровня доступа собственника токена.
О правах права доступа
Список контрагентов с постраничной выдачей
POST https://do.freshoffice.ru/common/list/paging/1?columns=id,name
Path Parameters
| Name | Type | Description |
|---|---|---|
| /1* | Int | Код модуля |
Query Parameters
| Name | Type | Description |
|---|---|---|
| sorting_direction | Int | Сортировка 0 Asc 1 Desc |
| sorting_column | String | Колонка сортировки |
| page | int | Номер страницы |
| records_onpage | Int | Записей на странице, но не более 500 |
| columns* | String | Список колонок |
Headers
| Name | Type | Description |
|---|---|---|
| Authorization* | String | Bearer XXXXX-XXXXXXX-XXXXX |
| Content-Type | String | application/json |
200: OK Стандартный объект ответа
401: Unauthorized
{
"status": "success",
"error": "",
"code": null,
"rows": 1,
"pages": 1,
"page": 1,
"value": "[
{"id":1,"name":"Apple"}
]"
{
// Response
}
Пример
cURL
PHP
NodeJs(Request)
curl --location --request
POST 'https://do.freshoffice.ru/common/list/paging/1
?columns=id,name
&records_onpage=1000
&sorting_direction=0
&sorting_column=id
&user_ids=37' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXX.XXXXXXX.XXXXXX' \
--data-raw ''
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://do.freshoffice.ru/common/list/paging/1
?columns=id,name
&records_onpage=1000
&sorting_direction=0
&sorting_column=id&user_ids=37',
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 XXXXX.XXXXX.XXXXX'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://do.freshoffice.ru/common/list/paging/1
?columns=id,name
&records_onpage=1000
&sorting_direction=0
&sorting_column=id
&user_ids=37',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer XXXXXX.XXXXXX.XXXXXX'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
})
Columns
| Имя | Описание |
|---|---|
| id | Идентификатор контрагента |
| name | Наименование. Наименование контрагента |
| address | Адрес. Адрес контрагента |
| created | Дата и время внесения. Дата и время добавления контрагента |
| city | Город. Город контрагента |
| region | Регион. Регион контрагента |
| country | Страна. Страна контрагента |
| activity_type | Деятельность. Вид деятельности контрагента |
| property_form | Форма собственности. Форма собственности контрагента |
| type_id | Идентификатор типа контрагента |
| type | |
| created_by | Имя пользователя или способ добавления контрагента |
| info_source | Источник. Регион контрагента |
| first_name | Имя (физического лица) |
| middle_name | Отчество (физического лица) |
| last_name | Фамилия (физическое лица) |
| url | Сайт. Вебсайт контрагента |
| user_id | Ответственный. Идентификатор ответственного пользователя |
| user_name | Ответственный. Имя ответственного пользователя |
| person | Признак ЮР/ФИЗ |
| note | Примечание |
| external_code | Код 1С |
| category_id | Идентификатор категории контрагента |
| category | Категория контрагента |
| status_id | Идентификатор статуса контрагента |
| status | Статус контрагента |
| agent_id | Идентификатор агента |
| agent | Аген |
| tax_id | Код налогоплательщика по списку реквизитов компании |
| which_site_source | Web сайт источник лида |
| which_host_source | Web хост источник лида |
| which_link_source | Полная web ссылка источник лида |
| utm_campaign | UTM campaign |
| utm_source | UTM source |
| utm_medium | UTM medium |
| utm_content | UTM content |
| utm_term | UTM term |
| ADD_{name} | Дополнительные поля |
Фильтрация
Примечание
На заметку: можно использовать 2 метода фильтрации. Стандартная фильтрация по колонкам. По ID готового фильтра, который был создан внутри приложения, подробней: фильтры в приложении ⚡️
Колонки фильтрации
?id=1
?name=apple
?email=xxx@gmail.com
?phone=+1 890 745 66 89
?tax_id=7811505326
?user_ids=1 or ?user_ids=1,3,4
?page=1 - Номер страницы которую нужно получить
// id - Код компании
// name - Наименование, поиск по совпадению части символов
// email - Почта контрагента или контактных лиц
// phone - Телефон контрагента или контактных лиц
// tax_id - Код налогоплатильщика по списку реквизитов компании
// user_ids - Код отвественного за контрагента
// page - Номер страницы которую нужно получить
⚡️ tax_id
В списке реквизитов компании должна быть выбрана позиция по умолчанию: Карточка контрагента → Платёжные реквизиты
⚡️ user_ids
Коды пользователей можно найти в раздели - пользоватли
Готовые пользовательские фильтры
?user_filter_ids = 1
or
?user_filter_ids=1,2
// user_filter_ids - ID пользовательского фильтра
⚡️ user_filter_ids
Коды фильтров можно найти в раздели - фильтры
Предыдущая
Следующая