Удаление информации о закрывающем документе

Метод Delete closing document используется для удаления из платформы информации о закрывающем документе клиента текущего реселлера или любого из его нижестоящих реселлеров.

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

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

DELETE {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices/{external_invoice_id}

Аргументы

Название

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

Тип данных

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

Описание

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

external_invoice_id

pathnumberОбязательныйID закрывающего документа в платформе

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

В случае отсутствия ошибок метод возвращает информацию о закрывающем документе (см. модель ответа в Получение информации о закрывающем документе).

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

DELETE /api/v3/resellers/1/accounts/505/external_invoices/11
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "11",
		"type": "external_invoices",
		"attributes": {
			"created_at": "2019-10-18T13:45:38.333297+0300",
			"updated_at": "2019-10-18T15:10:48.595281+0300",
			"key": "0493e78a-e8ef-11e9-81b4-2a2ae2dbcce4",
			"name": "New invoice",
			"start_date": "2019-10-01",
			"end_date": "2019-10-01",
			"file": "data:application/pdf;base64,SSBob2xkIHRoZSBwb3NpdGlvbiBvZiBhIHFhIGVuZ2luZWVyLiBRQSBlbmdp\nbmVlciByZXNwb25zaWJpbGl0aWVzIGluY2x1ZGUgZGVzaWduaW5nIGFuZCBp\nbXBsZW1lbnRpbmcgdGVzdHMsIGRlYnVnZ2luZyBhbmQgZGVmaW5pbmcgY29y\ncmVjdGl2ZSBhY3Rpb25zLiBJIGFsc28gcmV2aWV3IHN5c3RlbSByZXF1aXJl\nbWVudHMgYW5kIHRyYWNrIHF1YWxpdHkgYXNzdXJhbmNlIG1ldHJpY3MgKGUu\nZy4gZGVmZWN0IGRlbnNpdGllcyBhbmQgb3BlbiBkZWZlY3QgY291bnRzLikg\nVGhlIFFBIHRlY2huaWNpYW4gcm9sZSBwbGF5cyBhbiBpbXBvcnRhbnQgcGFy\ndCBpbiBvdXIgY29tcGFueeKAmXMgcHJvZHVjdCBkZXZlbG9wbWVudCBwcm9j\nZXNzLg==\n",
			"type": "invoice"
		}
    }
}