Удаление информации о закрывающем документе
Метод Delete closing document используется для удаления из платформы информации о закрывающем документе клиента текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
DELETE {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices/{external_invoice_id}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json |
Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json |
base_url | path | string | Обязательный | URL ActivePlatform |
reseller_id | path | number | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) |
account_id | path | number | Обязательный | ID клиента |
external_invoice_id | path | number | Обязательный | ID закрывающего документа в платформе |
Модель ответа
В случае отсутствия ошибок метод возвращает информацию о закрывающем документе, за исключением аргумента file
(см. модель ответа в Получение информации о закрывающем документе).
Пример запроса
DELETE /api/v3/resellers/1/accounts/505/external_invoices/277
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Пример ответа
{
"data": {
"id": "277",
"type": "external_invoices",
"attributes": {
"created_at": "2022-08-29T10:30:35.541209+0000",
"updated_at": "2022-08-29T11:04:44.315677+0000",
"type": "invoice",
"key": "0493e78a-e8ef-11e9-81b4-2a2ae2dbcce4",
"name": "Invoice ext",
"start_date": "2019-11-01",
"end_date": "2019-11-30",
"amount": {
"currency": "EUR",
"total": "123.45"
}
}
}
}