Получение списка актов реселлера

Метод Get list of invoices используется для получения списка актов. Метод позволяет получить список актов для текущего реселлера и любого из его нижестоящих реселлеров.

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

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

GET {base_url}/api/v3/resellers/{reseller_id}/invoices

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
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	integer	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
filter[created_at]	query	date	Опциональный	Фильтрация списка по дате создания акта в формате RFC 3339 (например, 2019-05-29T15:12:01.558009+03:00 или 2019-05-29)
filter[updated_at]	query	date	Опциональный	Фильтрация списка по дате обновления акта в формате RFC 3339 (например, 2019-05-29T15:12:01.558009+03:00 или 2019-05-29)
filter[status]	query	string	Опциональный	Фильтрация списка по статусу акта (см. Просмотр списка актов)
filter[account_id]	query	string	Опциональный	Фильтрация списка по ID клиента
filter[from_date]	query	string	Опциональный	Фильтрация по дате начала периода, за который выставлен акт (ГГГГ-ММ-ДД)
filter[to_date]	query	string	Опциональный	Фильтрация по дате окончания периода, за который выставлен акт (ГГГГ-ММ-ДД)
filter[payment_model]	query	string	Опциональный	Фильтрация по модели оплаты акта. Возможные значения: prepay — Предоплата. postpay — Постоплата.
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		integer	ID акта
	type		string	Тип данных
	attributes		object	Информация об акте
		created_at	date	Дата и время создания акта
		updated_at	date	Дата и время последнего обновления акта
		document_id	string	Номер акта (см. Просмотр списка актов)
		status	string	Статус акта
		total	string	Общая сумма акта
		account_id	integer	ID клиента, которому выставлен акт
		from_date	date	Дата начала периода, за который выставлен акт, в формате ГГГГ-ММ-ДД
		to_date	date	Дата окончания периода, за который выставлен акт, в формате ГГГГ-ММ-ДД
		payment_model	string	Модель оплаты акта: Возможные значения: prepay — Предоплата. postpay — Постоплата.
links			object	Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации
	self		string	Ссылка на текущую страницу
	first		string	Ссылка на первую страницу
	prev		string	Ссылка на предыдущую страницу
	next		string	Ссылка на следующую страницу
	last		string	Ссылка на последнюю страницу

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

GET /api/v3/resellers/1/invoices?filter[from_date]=2019-01-01&filter[to_date]=2019-02-01&filter[status]=closed&filter[payment_model]=prepay&page[size]=2&page[number]=1
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "788",
            "type": "invoices",
            "attributes": {
                "created_at": "2019-02-02T01:02:04.357014+0300",
                "updated_at": "2019-02-02T01:02:04.773570+0300",
                "document_id": "000758",
                "status": "closed",
                "total": null,
                "account_id": 264,
                "from_date": "2019-01-01",
                "to_date": "2019-02-01",
                "payment_model": "prepay"
            }
        },
        {
            "id": "790",
            "type": "invoices",
            "attributes": {
                "created_at": "2019-02-02T01:02:05.062252+0300",
                "updated_at": "2019-02-02T01:02:05.799874+0300",
                "document_id": "000760",
                "status": "closed",
                "total": null,
                "account_id": 109,
                "from_date": "2019-01-01",
                "to_date": "2019-02-01",
                "payment_model": "prepay"
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/invoices?filter%5Bfrom_date%5D=2019-01-01&filter%5Bstatus%5D=closed&filter%5Bto_date%5D=2019-02-01&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/invoices?filter%5Bfrom_date%5D=2019-01-01&filter%5Bstatus%5D=closed&filter%5Bto_date%5D=2019-02-01&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/api/v3/resellers/1/invoices?filter%5Bfrom_date%5D=2019-01-01&filter%5Bstatus%5D=closed&filter%5Bto_date%5D=2019-02-01&page%5Bnumber%5D=1&page%5Bsize%5D=2"
    }
}