Get

[POST] …/v1/DocInvoice/Get

Возвращает счёт-фактуру.

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

Название Тип данных Обязательность Описание
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
ids Array of Int64 Необязательный Массив ID документов установки цен
contract_ids Array of Int64 Необязательный Массив ID договоров
firm_ids Array of Int64 Необязательный Массив ID пердприятий
partner_ids Array of Int64 Необязательный Массив ID контрагентов
attached_user_ids Array of Int64 Необязательный Массив ID ответственных пользователей
performed Boolean Необязательный Проведён ли документ: true - Проведён, false - Не проведён
blocked Boolean Необязательный Заблокирован ли документ: true - Заблокирован, false - Не заблокирован
deleted_mark Boolean Необязательный Помечен ли документ на удаление: true - Помечен на удаление, false - Не помечен на удаление
vat_calculation_type Enum Необязательный Расчет НДС: <No | 1> - Не начислять, <Exclude | 2> - В сумме, <Include | 3> - Сверху
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
search String Необязательный Строка поиска по полям: code - Код счёт-фактуры, Partner/name - ФИО контрагента, Firm/name - Наименование предприятия, Contract/name - Наименование договора, User/name - ФИО ответственного пользователя
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
SortOrders

Модель сортировки выходных параметров.

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Id | 1> - ID счёт-фактуры, <Date | 2> - Дата, <Code | 3> - Код счёт-фактуры, <PartnerName | 4> - ФИО контрагента, <FirmName | 5> - Наименование предприятия, <CurrencyName | 6> - Наименование валюты, <ContractName | 7> - Наименование договора, <Amount | 8> - Сумма, <VatCalculationType | 9> - Расчет НДС, <AttacheUserName | 10> - ФИО ответственного пользователя, <PriceTypeName | 11> - Вид цены, <Blocked | 12> - Заблокирован, <Performed | 13> - Проведён, <DeletedMark | 14> - Помечен на удаление, <LastUpdate | 15> - Последнее изменение в unix time
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

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

{
    "start_date":1534153454,
    "end_date":1534157896,
    "ids":[1],
    "contract_ids":[1],
    "firm_ids":[1],
    "partner_ids":[1],
    "attached_user_ids":[1],
    "performed": false,
    "blocked": false,
    "deleted_mark": false,
    "vat_calculation_type": "No",
    "sort_orders": [
        {
            "column": "Code",
          "direction": "ASC"
        }
    ],
    "search": "example",
    "limit":1,
    "offset":1
}

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

Название Тип данных Описание
result Array of DocInvoice Массив счёт-фактур
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "date": 1583816956,
            "code": "SCF-0000041",
            "corrected_date": 1583816956,
            "corrected_code": "DOC-0000041",
            "contract": {
                "id": 1,
                "code": "example",
                "name": "example",
                "date": 1533619909,
                "start_date": 1533619909,
                "end_date": 1533619909,
                "partner_id": 1,
                "firm_id": 1,
                "direction": "Income",
                "currency_id": 1,
                "amount": 1.1,
                "details": "example",
                "description": "example",
                "attached_user_id": 1,
                "active": false,
                "deleted_mark": false,
                "last_update": 1533619909
            },
            "firm": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Предприятия",
                    "child_count": 0,
                    "last_update": 1715233269
                },
                "deleted_mark": false,
                "last_update": 1715863600,
                "name": "REGOS",
                "fullname": "ООО \"REGOS Software\"",
                "boss_name": "Андрей",
                "address": "Мукими, 8А",
                "phones": "+998987654321",
                "description": "EasyTrade successor",
                "inn": "305930137",
                "bank_name": "Ипак Йули",
                "mfo": "01101",
                "rs": "22125489632541254782",
                "oked": "62090",
                "vat_index": "1325489654785"
            },
            "partner": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Поставщики",
                    "child_count": 1,
                    "last_update": 1693395102
                },
                "legal_status": "Legal",
                "name": "Coca-cola company",
                "fullname": "Eric George Blair",
                "boss_name": "Arthur",
                "address": "100017, A.Qodiriy ko’chasi 981 uy",
                "phones": "+998987654321",
                "description": "Book Shop",
                "inn": "123456789",
                "bank_name": "Ipak Yo'li Banki",
                "mfo": "00450",
                "rs": "29802000600000444085",
                "oked": "62.03.0",
                "vat_index": "12",
                "deleted_mark": false,
                "last_update": 1728627216
            },
            "currency": {
                "id": 1,
                "code_num": 123,
                "code_chr": "UZS",
                "name": "Узбекский сум",
                "exchange_rate": 1.1,
                "is_base": false,
                "deleted": false,
                "last_update": 1533619909
            },
            "exchange_rate": 1.1,
            "amount": 123000.1,
            "vat_calculation_type": "No",
            "attached_user": {
                "id": 1,
                "full_name": "John Fitzgerald Kennedy",
                "main_phone": "998123456789",
                "user_group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Administrators",
                    "child_count": 1,
                    "last_update": 1529755889
                },
                "enable_hints": true,
                "system": true,
                "last_update": 1532276019,
                "first_name": "John",
                "last_name": "Kennedy",
                "middle_name": "Fitzgerald",
                "sex": "Male",
                "date_of_birth": "1993-12-21",
                "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
                "phones": "998123456789",
                "email": "example@example.com",
                "description": "example",
                "login": "Admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS"
            },
            "base_document_id": 1,
            "document_type": 1,
            "positive": true,
            "description": "example",
            "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "external_code": "example",
            "error": "example",
            "blocked": false,
            "current_user_blocked": false,
            "performed": true,
            "sent": true,
            "deleted_mark": false,
            "last_update": 1583819447
        }
    ],
    "next_offset": 1,
    "total": 1
}