GetDocuments

Метод для получения списка документов.

Входные параметры

Название Тип данных Обязательность Описание
ids Array of String Необязательный Массив ID
limit Int64 Необязательный Количество возвращаемых элементов выборки
offset Int64 Необязательный Смещение от начала выборки

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

{
    "action": "GetDocuments",
    "token": "example",
    "data": {
        "ids": [
            "1"
            ],
        "limit": 1,
        "offset": 1
    }
}

Выходные параметры

Название Тип данных Описание
total Int32 Количество документов в ответе
_documents Array of Documents Массив документов
Documents

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

Название Тип данных Описание
id String ID счёт-фактры
name String Наименование счёт-фактры
partner Partner Контрагент
amount Decimal Сумма документа
date Int64 Дата выставления счёт-фактры в формате Unix time в секундах
code String Номер счёт-фактры
contact Contact Договор
firm Firm Предприятие
roamingUuid String UUID в налоговой
Partner

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

Название Тип данных Описание
inn String ИНН контрагента
name String Наименование контрагента
Contact

Модель, описывающая договор.

Название Тип данных Описание
code String Код договора
date Int64 Дата договора в формате Unix time в секундах
Firm

Модель, описывающая предприятие.

Название Тип данных Описание
inn String ИНН Предприятия
name String Наименование Предприятия

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

{
    "ok": true,
    "result": {
        "total": 1,
        "_documents": [
            {
                "id": "1",
                "name": "example",
                "partner": {
                    "inn": "example",
                    "name": "example"
                },
                "amount": 1000.00,
                "date": 1712345678,
                "code": "example",
                "contact": {
                    "inn": "example",
                    "name": "example"
                },
                "firm": {
                    "inn": "example",
                    "name": "example"
                },
                "roamingUuid": "0df7c0a3-485f-405e-a5d2-1c01347e909f" 
            }
        ]
    }
}