Добавление налогов для списаний в модели Постоплата

Метод Add taxes позволяет добавить налоги для списания по модели Постоплата (см. Особенности списаний для модели Постоплата). Налоги можно добавить только для списания со статусом Открыто или Заблокировано. Положительная величина налога добавляется к сумме списания. Отрицательная величина налога означает возврат средств и вычитается из суммы списания (см. Получение информации о Списании). При этом общая сумма списания не может стать отрицательной. Если налог добавляется к списанию со статусом Заблокировано, то баланс клиента сразу же изменяется на величину налога.

Для авторизации требуется API-токен сотрудника. API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

POST {base_url}/api/v3/resellers/{reseller_id}/taxes

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID текущего реселлера (см. Просмотр информации о реселлере)
taxesformarray of objectsОбязательныйИнформация о списаниях и налогах
charge_idformintegerОбязательныйID списания, к которому нужно добавить налог

name

form

string

Обязательный

Название налога. Название отображается в Панели управления Клиента при просмотре истории баланса и при просмотре акта (см. История баланса, Просмотр Акта) и в Панели управления Оператора при просмотре акта (см. Просмотр акта для модели Постоплата)

descriptionformstringОпциональныйОписание и дополнительная информация о налоге
valueformfloatОбязательный

Величина налога с точностью до сотых

Модель ответа

НазваниеТип данныхОписание
dataarray of objectsДанные ответа

idintegerID налога

typestringТип данных

attributesobjectИнформация о налогах


created_atstringДата и время создания налога


updated_atstringДата и время последнего изменения налога


charge_idintegerID списания для которого добавлен налог


namestringНазвание налога


descriptionstringОписание и дополнительная информация о налоге


valuefloatВеличина налога с точностью до сотых

Код состояния:

  • 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"
            }
        }
    ]
}