CounterpartyTags - даний метод дозволяє керувати даними про теги контрагентів.
id (number) - Внутрішній ідентифікатор APPS
external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API
name (string) - Назва тегу
color (string) - Колір тегу
id (number) - Внутрішній ідентифікатор SaleApp
external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API
page (number) - Порядковий номер сторінки для отримання посторінкового виводу всіх записів.
На одну сторінку повертається 20 записів.
Якщо вказано параметр page більше нуля, то параметри id та external_id будуть проігноровані та результатом обробки буде масив усіх записів вказаної сторінки виводу.
Якщо параметр page не вказано або він дорівнює нулю, то пошук буде проведено по параметрам id та external_id. Якщо вказані обидва параметри, то приорітет пошуку буде надано id. Результатом обробки буде об'єкт з даними одного запису.
error - Наявність помилок при обробці запиту. true - наявні помилки. false - успішно оброблено.
error_description - Опис наявних помилок в обробці запиту.
response - Об'єкт або масив даних моделі при успішному виконанні запиту.
all_rows_qty - Кількість усіх записів що зберігаються у системі.
external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API
name (string) - Назва тегу
color (string) - Колір тегу у форматі HEX (#000000)
Всі поля обов`язкові при надсиланні запиту. За результатами успішності виконання запиту, буде створено новий тег контрагента та повернуто у відповіді ідентифікатор створеного запису create_id
id (number) - Внутрішній ідентифікатор SaleApp
external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API
name (string) - Назва тегуcolorstringКолір тегу у форматі HEX (#000000)
Пошук запису для оновлення проводиться по 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' => 22
];
$ch = curl_init(".../CounterpartyTags?secret_key={Ключ}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$response = curl_exec($ch);
curl_close($ch);
# Приклад php curl запиту з посторінковим виводом
$post = [
'method_type' => 'GET',
'page' => 1
];
$ch = curl_init(".../CounterpartyTags?secret_key={Ключ}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$response = curl_exec($ch);
curl_close($ch);
# JSON відповідьз пошуком по id
{
"error":"false",
"error_description":"",
"response":{
"id":"22",
"external_id":"0",
"name":"Клієнт",
"color":"#0b8e06"
},
"all_rows_qty":3
}
# JSON відповідь з посторінковим виводом
{
"error":"false",
"error_description":"",
"response":[
{
"id":"1",
"external_id":"0",
"name":"Постачальник",
"color":"#e43a5d"
},
{
"id":"18",
"external_id":"0",
"name":"Клиєнт-Постачальник",
"color":"#a0bcd4"
},
{
"id":"22",
"external_id":"0",
"name":"Клієнт",
"color":"#0b8e06"
}
],
"all_rows_qty":3
}