Шаблон накладной
Настройки печатной накладной A4 компании: поля информационного блока, часы работы и таблицы «Баланс клиента» и «Долг клиента». Одна запись на компанию.
| Метод | Адрес | Назначение |
|---|---|---|
| GET | /company/trade/invoice-template | Настройки накладной |
| PUT | /company/trade/invoice-template | Сохранить настройки накладной |
Настройки накладной
GET
/company/trade/invoice-templateНастройки накладной компании пользователя: сохранённые значения поверх значений по умолчанию (поля шапки выключены, таблица долга включена, таблица баланса выключена).
Заголовки
| Заголовок | Значение | Описание |
|---|---|---|
Authorization | Bearer {token} | Токен из POST /common/auth/login |
Accept | application/json | Ответ в JSON |
Accept-Language | ru | Язык сообщений и названий: ru, uz, oz |
Ответ · 200
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id | integer | ID |
company_id | integer | Компания |
settings | object | Настройки |
settings.header | object | |
settings.header.store_name | boolean | |
settings.header.working_hours | boolean | |
settings.header.cashier | boolean | |
settings.header.contacts | boolean | |
settings.header.legal_name | boolean | |
settings.header.client_phone | boolean | |
settings.header.date | boolean | Дата |
settings.header.seller | boolean | |
settings.header.client | boolean | |
settings.header.tin | boolean | |
settings.header.address | boolean | Адрес |
settings.working_hours | null | |
settings.balance | object | Баланс |
settings.balance.enabled | boolean | |
settings.balance.before | boolean | |
settings.balance.added | boolean | |
settings.balance.written_off | boolean | |
settings.balance.after | boolean | |
settings.debt | object | Долг |
settings.debt.enabled | boolean | |
settings.debt.before | boolean | |
settings.debt.added | boolean | |
settings.debt.written_off | boolean | |
settings.debt.after | boolean |
json
{
"id": 1,
"company_id": 1,
"settings": {
"header": {
"store_name": false,
"working_hours": false,
"cashier": false,
"contacts": false,
"legal_name": false,
"client_phone": false,
"date": false,
"seller": false,
"client": false,
"tin": false,
"address": false
},
"working_hours": null,
"balance": {
"enabled": false,
"before": true,
"added": true,
"written_off": true,
"after": true
},
"debt": {
"enabled": true,
"before": true,
"added": true,
"written_off": true,
"after": true
}
}
}Сохранить настройки накладной
PUT
/company/trade/invoice-templateСливает переданные settings с сохранёнными: можно прислать только изменённые блоки. Неизвестные ключи отклоняются ошибкой валидации. Возвращает итоговые настройки.
Из формы (
multipart/form-data) методPUTотправляется какPOSTс параметром?_method=PUT.
Заголовки
| Заголовок | Значение | Описание |
|---|---|---|
Authorization | Bearer {token} | Токен из POST /common/auth/login |
Accept | application/json | Ответ в JSON |
Accept-Language | ru | Язык сообщений и названий: ru, uz, oz |
Тело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
settings | array | Да | Настройки |
settings.header | array | Нет | Поля информационного блока: store_name, working_hours, cashier, contacts, legal_name, client_phone, date, seller, client, tin, address |
settings.header[] | boolean | Нет | Показывать поле в шапке накладной |
settings.working_hours | string | Нет | Часы работы, печатаются в шапке. Макс. 100 символов |
settings.balance | array | Нет | Таблица «Баланс клиента»: enabled и строки before, added, written_off, after |
settings.balance[] | boolean | Нет | Включить таблицу или строку баланса |
settings.debt | array | Нет | Таблица «Долг клиента»: enabled и строки before, added, written_off, after |
settings.debt[] | boolean | Нет | Включить таблицу или строку долга |
json
{
"settings": {
"header": {
"store_name": 1,
"working_hours": 1,
"client": 1
},
"working_hours": " 09:00 – 21:00 ",
"balance": {
"enabled": 1,
"added": null
},
"debt": {
"enabled": null,
"written_off": null
}
}
}bash
curl -X PUT "https://api.wasyt.uz/company/trade/invoice-template" \
-H "Accept: application/json" \
-H "Accept-Language: ru" \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{"settings":{"header":{"store_name":1,"working_hours":1,"client":1},"working_hours":" 09:00 – 21:00 ","balance":{"enabled":1,"added":null},"debt":{"enabled":null,"written_off":null}}}'Ответ · 200
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id | integer | ID |
company_id | integer | Компания |
settings | object | Настройки |
settings.header | object | |
settings.header.store_name | boolean | |
settings.header.working_hours | boolean | |
settings.header.cashier | boolean | |
settings.header.contacts | boolean | |
settings.header.legal_name | boolean | |
settings.header.client_phone | boolean | |
settings.header.date | boolean | Дата |
settings.header.seller | boolean | |
settings.header.client | boolean | |
settings.header.tin | boolean | |
settings.header.address | boolean | Адрес |
settings.working_hours | string | |
settings.balance | object | Баланс |
settings.balance.enabled | boolean | |
settings.balance.before | boolean | |
settings.balance.added | boolean | |
settings.balance.written_off | boolean | |
settings.balance.after | boolean | |
settings.debt | object | Долг |
settings.debt.enabled | boolean | |
settings.debt.before | boolean | |
settings.debt.added | boolean | |
settings.debt.written_off | boolean | |
settings.debt.after | boolean |
json
{
"id": 2,
"company_id": 1,
"settings": {
"header": {
"store_name": true,
"working_hours": true,
"cashier": false,
"contacts": false,
"legal_name": false,
"client_phone": false,
"date": false,
"seller": false,
"client": true,
"tin": false,
"address": false
},
"working_hours": "09:00 – 21:00",
"balance": {
"enabled": true,
"before": true,
"added": false,
"written_off": true,
"after": true
},
"debt": {
"enabled": false,
"before": true,
"added": true,
"written_off": false,
"after": true
}
}
}
