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

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

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

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
AcceptheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
reseller_idpathintegerОбязательныйID текущего Реселлера (см. Просмотр информации о реселлере)
taxesformarray of objectsОбязательныйИнформация о Списаниях и налогах
charge_idpathintegerОбязательныйID Списания

name

form

string

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

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

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

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

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

НазваниеТип данныхОписание
errorinteger

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

  • 200 - Запрос успешно обработан. Налоги созданы;
  • 401 - Ошибка авторизации;
  • 422 - Ошибка обработки запроса. Налоги не созданы.
dataobjectДанные ответа
idintegerID налога
charge_idintegerID Cписания для которого добавлен налог
namestringНазвание налога
descriptionstringОписание и дополнительная информация о налоге
valuefloatВеличина налога с точностью до сотых
created_atdataДата и время создания налога

Пример запроса

POST https://reseller.activeplatform.com/api/v3/resellers/3/taxes

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
X-Api-Token:qQwW12


JSON

{
    "taxes": [
  {
    "charge_id": "60278",
    "name": "VAT",
    "description": "VAT",
    "value": "-11.12"
  },
  {
    "charge_id": "60277",
    "name": "VAT",
    "description": "VAT",
    "value": "18.05"
  }
]
}

Пример ответа

{
    "data": [
        {
            "id": "70",
            "type": "taxes",
            "attributes": {
                "created-at": "2019-08-02T11:51:28.833624+0300",
                "updated-at": "2019-08-02T11:51:28.833624+0300",
                "charge-id": 60278,
                "name": "VAT",
                "description": "VAT",
                "value": "-11.12"
            }
        },
        {
            "id": "71",
            "type": "taxes",
            "attributes": {
                "created-at": "2019-08-02T11:51:28.833624+0300",
                "updated-at": "2019-08-02T11:51:28.833624+0300",
                "charge-id": 60277,
                "name": "VAT",
                "description": "VAT",
                "value": "18.05"
            }
        }
    ]
}