Получение списка закрывающих документов

Метод используется для получения многостраничного списка закрывающих документов аккаунта, к которому есть доступ у текущего пользователя.

GET {reseller_domain}/internal_api/accounts/{account_id}/external_invoices

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, для которого запрашивается список закрывающих документов
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)
filter[type]	query	string	Опциональный	Предназначен для фильтрации списка по типу закрывающего документа. Можно указать несколько значений через запятую. Доступные значения: invoice — счет. invoice_vat — счет-фактура. act — акт.
filter[start_date]	query	string	Опциональный	Предназначен для фильтрации списка по дате начала периода, за который выставлен закрывающий документ, в формате ГГГГ-ММ-ДД. Для указания диапазона используются следующие фильтры: filter[start_date][gt] — дата больше, чем указанная. filter[start_date][lt] — дата меньше, чем указанная. filter[start_date][gteq] — дата больше, чем указанная, или равна. filter[start_date][lteq] — дата меньше, чем указанная, или равна.
filter[end_date]	query	string	Опциональный	Предназначен для фильтрации списка по дате конца периода, за который выставлен закрывающий документ, в формате ГГГГ-ММ-ДД. Для указания диапазона используются следующие фильтры: filter[end_date][gt] — дата больше, чем указанная. filter[end_date][lt] — дата меньше, чем указанная. filter[end_date][gteq] — дата больше, чем указанная, или равна. filter[end_date][lteq] — дата меньше, чем указанная, или равна.
filter[name][like]	query	string	Опциональный	Предназначен для фильтрации списка по части названия закрывающего документа
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`. sort=updated_at — сортировка по возрастанию значений `updated_at`. sort=-updated_at — сортировка по убыванию значений `updated_at`.

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID закрывающего документа
	type		string	Тип данных
	attributes		object	Информация о закрывающем документе
		created_at	string	Дата и время создания закрывающего документа
		updated_at	string	Дата и время последнего изменения закрывающего документа
		type	string	Тип закрывающего документа: invoice — счет. invoice_vat — счет-фактура. act — акт.
		name	string	Название закрывающего документа
		start_date	string	Дата начала периода, за который выставлен закрывающий документ, в формате ГГГГ-ММ-ДД
		end_date	string	Дата конца периода, за который выставлен закрывающий документ, в формате ГГГГ-ММ-ДД
		url_for_download	string	Ссылка для скачивания файла закрывающего документа
		total	string	Сумма закрывающего документа с указанием валюты
links			object	Ссылки для постраничной навигации
	self		string	Текущая страница
	first		string	Первая страница
	prev		string	Предыдущая страница (при наличии)
	next		string	Следующая страница (при наличии)
	last		string	Последняя страница
meta			object	Дополнительная информация
	current_page		integer	Номер текущей страницы
	page_count		integer	Общее число страниц
	server_current_time		string	Текущие дата и время сервера

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1707/external_invoices' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "data": [
        {
            "id": "335",
            "type": "external_invoices",
            "attributes": {
                "created_at": "2022-03-17T15:08:46.079280+0300",
                "updated_at": "2022-03-17T15:08:46.079280+0300",
                "type": "invoice",
                "name": "Test_invoice_78",
                "start_date": "2021-06-01",
                "end_date": "2021-07-01",
                "url_for_download": "https://storage.test.activeplatform.com/private/external_invoice/335/invoice_20210601_20210701.pdf?expires=1674806093&hash=3e-zx3&filename=invoice_20210601_20210701.pdf",
                "total": "$1,100.80"
            }
        },
        {
            "id": "336",
            "type": "external_invoices",
            "attributes": {
                "created_at": "2022-03-17T15:08:59.951251+0300",
                "updated_at": "2022-03-17T15:08:59.951251+0300",
                "type": "invoice",
                "name": "Test_invoice_79",
                "start_date": "2021-07-01",
                "end_date": "2021-08-01",
                "url_for_download": "https://storage.test.activeplatform.com/private/external_invoice/336/invoice_20210701_20210801.pdf?expires=1674806093&hash=evIns&filename=invoice_20210701_20210801.pdf",
                "total": "$1,862.22"
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/accounts/1707/external_invoices?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/accounts/1707/external_invoices?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/accounts/1707/external_invoices?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    },
    "meta": {
        "current_page": 1,
        "page_count": 1,
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}