Документація API/Товари і склад/Довідники

Довідники

Id, які потрібні для запису: статуси, валюти, склади, статті. Довідники змінюються рідко, тому кешуйте їх у себе на кілька годин.

Маршрути

GET/currency

Валюти: char_code (UAH, USD), text_symbol, курс value, MinorUnit (кількість знаків після коми).

2 очк.

GET/lookup?type=…

Статуси, типи, джерела, одиниці: до 20 записів типу, value= шукає за назвою. Типи наведено в таблиці нижче.

2 очк.

GET/stock

Склади.

2 очк.

GET/product-category

Категорії товарів.

2 очк.

GET/price-book

Прайс-листи.

2 очк.

GET/extra-fields?entity=contact

Доп. поля сутності: id, назва, тип, обов’язковість. Поля, закриті роллю, не видно.

2 очк.

GET/extra-fields/option?field_id=7

Варіанти поля-списку: ids=12,15 повертає назви за id (до 200), q= шукає за назвою, limit ≤ 200.

2 очк.

GET/lead/funnel

Воронки лідів і угод (filter[entity_type;eq]=opportunity); етапи віддає /lead/funnel/lead-funnel-items.

2 очк.

GET/account/our

Ваші юрособи (ФОП/ТОВ), тобто provider_id документів.

2 очк.

GET/balance

Каси й рахунки, тобто balance_id платежів.

право: balance_update.update2 очк.

GET/fin-account/search?type=revenue

Статті доходів (revenue) і витрат (expense), тобто category_id платежів.

право: payment.view2 очк.

GET/department

Підрозділи.

2 очк.

GET/user

Користувачі, тобто owner_id записів.

право: user.view2 очк.

Більшість довідників мають і картку GET /…/{id}. Довідники віддають увесь перелік у items; total є лише в тих, що мають пагінацію (валюти, склади, категорії, прайси, підрозділи, користувачі, воронки). Змінювати довідники через API не можна.

Типи lookup

type	Що це	Де використовується
`ord_status`	Статуси замовлень	`order.status_id`
`inv_status`	Статуси рахунків	`invoice.status_id`
`task_status`	Статуси завдань	`task.status_id`
`task_type`	Типи завдань	`task.type_id`
`ct_type`	Типи контактів	`contact.type_id`
`acc_type`	Типи контрагентів	`account.type_id`
`source`	Джерела	`lead.source_id`, `order.source_id`
`unit`	Одиниці виміру	`product.unit_id`
`tax`	Ставки ПДВ	`vat_id`

GET /api/v1/lookup?type=ord_status

{ "items": [ { "id": 12, "name": "Нове", "value": "new", "order": 1, ... }, ... ] }

Назви статусів компанія може перейменовувати. Прив’язуйтесь до id (або системного value), а не до назви.