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

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

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

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

GET {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices?filter[key]=key

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
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 клиента
key	query	string	Обязательный	GUID закрывающего документа во внешней системе

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

Название			Тип данных	Описание
data			object	Данные ответа
	id		string	ID закрывающего документа в платформе
	type		string	Тип данных
	attributes		object	Информация о закрывающем документе
		created_at	string	Дата и время создания закрывающего документа
		updated_at	string	Дата и время последнего обновления закрывающего документа
		key	string	GUID закрывающего документа во внешней системе
		name	string	Название закрывающего документа
		start_date	string	Дата начала финансового периода, за который выставлен закрывающий документ, в формате ГГГГ-ММ-ДД
		end_date	string	Дата окончания финансового периода, за который выставлен закрывающий документ, в формате ГГГГ-ММ-ДД
		file	string	Закрывающий документ в кодировке base64
		type	string	Тип закрывающего документа. Возможные значения: invoice — счет. invoice_vat — счет-фактура. act — акт.

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

GET/api/v3/resellers/1/accounts/505/external_invoices?filter[key]=0493e78a-e8ef-11e9-81b4-2a2ae2dbcce4
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"
		}
    }
}