Добавление налогов для Списаний в модели Постоплата
Метод Create Charges позволяет добавить налоги для Списания по модели Постоплата (см. Особенности списаний для модели Постоплата). Налоги можно добавить только для Списания со статусом Открыто или Заблокировано. Положительная величина налога добавляется к сумме Списания. Отрицательная величина налога означает возврат средств и вычитается из суммы Списания (см. Получение информации о Списании). При этом общая сумма Списания не может стать отрицательной. Если налог добавляется к Списанию со статусом Заблокировано, то Баланс Клиента сразу же изменяется на величину налога.
POST {base_url}/api/v3/resellers/{reseller_id}/taxes
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
Content-Type | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) |
Accept | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности |
reseller_id | path | integer | Обязательный | ID текущего Реселлера (см. Просмотр информации о реселлере) |
taxes | form | array of objects | Обязательный | Информация о Списаниях и налогах |
charge_id | path | integer | Обязательный | ID Списания, к которому нужно добавить налог |
name | form | string | Обязательный | Название налога. Название отображается в Панели управления Клиента при просмотре Истории баланса и при просмотре Акта (см. История баланса, Просмотр Акта), и в Панели управления Оператора при просмотре Акта (см. Просмотр акта для модели Постоплата) |
description | form | string | Опциональный | Описание и дополнительная информация о налоге |
value | form | float | Обязательный | Величина налога с точностью до сотых |
Модель ответа
Название | Тип данных | Описание | ||
---|---|---|---|---|
data | array of objects | Данные ответа | ||
id | integer | ID налога | ||
type | string | Тип данных | ||
attributes | object | Информация о налогах | ||
created_at | string | Дата и время создания налога | ||
updated_at | string | Дата и время последнего изменения налога | ||
charge_id | integer | ID Cписания для которого добавлен налог | ||
name | string | Название налога | ||
description | string | Описание и дополнительная информация о налоге | ||
value | float | Величина налога с точностью до сотых |
Код состояния:
- 201 — Запрос успешно обработан. Налоги созданы.
- 401 — Ошибка авторизации.
- 422 — Ошибка обработки запроса. Налоги не созданы.
Пример запроса
POST /api/v3/resellers/1/taxes
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetest3gJXZH5uHCw
Accept: application/vnd.api+json
{
"taxes": [
{
"charge_id": "77530",
"name": "VAT",
"description": "VAT",
"value": "11.23"
}
]
}
Пример ответа
{
"data": [
{
"id": "1",
"type": "taxes",
"attributes": {
"created_at": "2020-07-27T05:02:18.576061+0300",
"updated_at": "2020-07-27T05:02:18.576061+0300",
"charge_id": 77530,
"name": "VAT",
"description": "VAT",
"value": "11.23"
}
}
]
}