Counterparty - даний метод дозволяє керувати даними про контрагентів.
id (number) - Внутрішній ідентифікатор SaleApp
external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API
name (string) - І'мя контрагента
phone (string) - Номер телефону
mail (string) - Електронна пошта
addres (string) - Адреса
type (string) - id тегів контрагента (модель CounterpartyTags) вказані через кому (приклад 1,3,5)
lid (number) - Ознака чи являється клієнт лідом. 1 - являється лідом, 0 - не являється лідом
date_entered (datetime) - Дата та час створення
date_update (datetime) - Дата та час останнього редагування
id (number) - Внутрішній ідентифікатор SaleApp
external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API
page (number) - Порядковий номер сторінки для отримання посторінкового виводу всіх записів. На одну сторінку повертається 20 записів.
phone (string) - Фільтр за номером телефону
mail (string) - Фільтр за електронною поштою
lid (number) - Фільтр за ознакою лід. 1 - являється лідом, 0 - не являється лідом
Якщо вказано параметр page більше нуля, то параметри id та external_id будуть проігноровані та результатом обробки буде масив усіх записів вказаної сторінки виводу.
Якщо параметр page не вказано або він дорівнює нулю, то пошук буде проведено по параметрам id та external_id. Якщо вказані обидва параметри, то приорітет пошуку буде надано id. Результатом обробки буде об'єкт з даними одного запису.
Параметри phone, mail, lid Використовуються як додаткові фільтри при відборі. Якщо вказано один з них, то буде проведено перевірку збігу вказаних полів.
error - Наявність помилок при обробці запиту. true - наявні помилки, false - успішно оброблено
error_description - Опис наявних помилок в обробці запиту
response - Об'єкт або масив даних моделі при успішному виконанні запиту
all_rows_qty - Кількість усіх записів що зберігаються у системі
external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API
name (string) - І'мя контрагентаphonestringНомер телефону
mail (string) - Електронна пошта
addres (string) - Адреса
type (string) - id тегів контрагента (модель CounterpartyTags) вказані через кому (приклад 1,3,5) lidnumberОзнака чи являється клієнт лідом, 1 - являється лідом, 0 - не являється лідом
Всі поля обов`язкові при надсиланні запиту. За результатами успішності виконання запиту, буде створено нового контрагента та повернуто у відповіді ідентифікатор створеного запису create_id.
id (number) - Внутрішній ідентифікатор SaleApp
external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API
name (string) - Назва тегу
phone (string) - Номер телефону
mail (string) - Електронна пошта
addres (string) - Адреса
type (string) - id тегів контрагента (модель CounterpartyTags) вказані через кому (приклад 1,3,5)
lid (number) - Ознака чи являється клієнт лідом. 1 - являється лідом, 0 - не являється лідом
Пошук запису для оновлення проводиться по id або external_id тому для успішності виконання, повинен обов'язково бути вказаний один з цих параметрів. Якщо вказані обидва параметри, то приорітет пошуку буде надано id.
id (number) - Внутрішній ідентифікатор SaleApp
external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API
Пошук запису для видалення проводиться по id або external_id тому для успішності виконання, повинен обов'язково бути вказаний один з цих параметрів. Якщо вказані обидва параметри, то приорітет пошуку буде надано id.
error - Наявність помилок при обробці запиту. true - наявні помилки, false - успішно оброблено
error_description - Опис наявних помилок в обробці запиту
create_id - Ідентифікатор створеного запису (повертається лише при надсиланні POST запиту)
# Приклад php curl запиту з пошуком по id
$post = [
'method_type' => 'GET',
'id' => 40
];
$ch = curl_init(".../Counterparty?secret_key={Ключ}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$response = curl_exec($ch);
curl_close($ch);
# JSON відповідь
{
"error":"false",
"error_description":"",
"response":{
"id":"40",
"external_id":"0",
"name":"ФОП Рапенц Іван Петрович",
"phone":"0633803022",
"mail":"rapenc.a@gmail.com",
"addres":"г. Киев ул. Бажана 345, кв. 22",
"type":"1,6",
"lid":"0",
"date_entered":"2021-07-21 23:19:37",
"date_update":"2022-03-12 18:09:40"
}
}
# Приклад php curl запиту з посторінковим виводом
$post = [
'method_type' => 'GET',
'page' => 1
];
$ch = curl_init(".../Counterparty?secret_key={Ключ}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$response = curl_exec($ch);
curl_close($ch);
# JSON відповідь
{
"error":"false",
"error_description":"",
"response":[
{
"id":"5",
"external_id":"0",
"name":"ФОП Панров Антон Вікторович",
"phone":"0658907654",
"mail":"memane@mail.com",
"addres":"Запоріжжя, вул Примака 4",
"type":"2",
"lid":"0",
"date_entered":"2021-07-21 23:19:37",
"date_update":"2022-03-12 18:09:23"
},
{
"id":"40",
"external_id":"0",
"name":"ФОП Рапенц Іван Петрович",
"phone":"0633803022",
"mail":"rapenc.a@gmail.com",
"addres":"г. Киев ул. Бажана 345, кв. 22",
"type":"1,6",
"lid":"0",
"date_entered":"2021-07-21 23:19:37",
"date_update":"2022-03-12 18:09:40"
}
...........
],
"all_rows_qty":5
}