get

[POST] …/v1/DocPurchase/get

Возвращает информацию о документе закупки

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

Название Тип данных Обязательность Описание параметра
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах
ids array of int64 Необязательный Массив id документов закупки
firm_ids array of int64 Необязательный Массив id предприятий
stock_ids array of int64 Необязательный Массив id складов
partner_ids array of int64 Необязательный Массив id контрагентов
contract_ids array of int64 Необязательный Массив id договоров
attached_user_ids array of int64 Необязательный Массив id ответственных пользователей
vat_calculation_type enum Необязательный Расчет НДС: no (не начислять), exclude (НДС включен в стоимость), include (НДС не включен в стоимость)
performed bool Необязательный Метка о проведении документа
blocked bool Необязательный Метка о блокировке документа
deleted_mark bool Необязательный Метка об удалении
search string Необязательный Поиск: код, контрагент(partner: name, inn), отв лицо, договор, склад, предприятие(firm: name, inn); отв лицо - это фио, контрагент - это название, договор - код
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Sort_orders
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

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

Название Тип данных Описание параметра
column enum Значение для сортировки: Id ( Id документа), Date (Дата), Code (Код документа), PartnerName (Контрагент), StockName (Склад), CurrencyName (Валюта), ContractName (Договор), Amount (Количество), VatCalculationType (Тип НДС), AttacheUserName (Ответственный пользователь), PriceTypeName (Тип цены), Blocked (Блокировка), Performed (Проведен), DeletedMark (Метка на удаление), LastUpdate (Дата изменения)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
    "start_date":1534153454,
    "end_date":1534157896,
    "ids":[1,2,3],
    "firm_ids":[1,2,3],
    "stock_ids":[1,2,3],
    "partner_ids":[1,2,3],
    "contract_ids":[1,2,3],
    "attached_user_ids":[1,2],
    "vat_calculation_type": "no",
    "performed": true,
    "blocked": true,
    "deleted_mark": true,
    "search": "000001",
    "sort_orders":
    [
        {
        "column":"date",
        "direction":"desc"
        }
    ],
    "limit":1,
    "offset":1
}

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

Название Тип данных Обязательность Описание параметра
Result Array of DocPurchase Обязательный Массив объектов DocPurchase

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

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "date": 1693396138,
      "code": "2023-0000001",
      "partner": {
        "id": 1,
        "group": {
          "id": 1,
          "parent_id": 0,
          "name": "Поставщики",
          "child_count": 0,
          "last_update": 1693395102
        },
        "deleted_mark": false,
        "last_update": 1693396154,
        "legal_status": "Legal",
        "name": "Поставщик № 1",
        "fullname": null,
        "boss_name": null,
        "address": null,
        "phones": null,
        "description": null,
        "inn": null,
        "bank_name": null,
        "mfo": null,
        "rs": null,
        "oked": null,
        "vat_index": null
      },
      "stock": {
        "id": 1,
        "name": "Новомосковская",
        "firm": {
          "id": 1,
          "group": {
            "id": 1,
            "parent_id": 0,
            "name": "Предприятие",
            "child_count": 0,
            "last_update": 1693395102
          },
          "deleted_mark": false,
          "last_update": 1693395102,
          "name": "Предприятие",
          "fullname": null,
          "boss_name": null,
          "address": null,
          "phones": null,
          "description": null,
          "inn": null,
          "bank_name": null,
          "mfo": null,
          "rs": null,
          "oked": null,
          "vat_index": null
        },
        "deleted_mark": false,
        "last_update": 1705583155
      },
      "currency": {
        "id": 1,
        "code_num": 860,
        "code_chr": "UZS",
        "name": "Узбекский сум",
        "exchange_rate": 1,
        "is_base": true,
        "deleted": false,
        "last_update": 1664715017
      },
      "contract": null,
      "description": null,
      "amount": 21500000,
      "exchange_rate": 1,
      "additional_expenses_amount": 0,
      "vat_calculation_type": "No",
      "attached_user": {
        "id": 1,
        "full_name": null,
        "main_phone": "998951778930",
        "user_group": {
          "id": 1,
          "parent_id": 0,
          "name": "Admins",
          "child_count": 0,
          "last_update": 1552326674
        },
        "enable_hints": true,
        "system": true,
        "first_name": "OOO REGOS SOFTWARE",
        "last_name": null,
        "middle_name": null,
        "sex": "none",
        "date_of_birth": "1900-01-01",
        "address": null,
        "phones": null,
        "email": null,
        "description": null,
        "login": "admin",
        "can_authorize": true,
        "active": true,
        "language_code": "RUS",
        "last_update": 1693395113
      },
      "price_type": {
        "id": 1,
        "name": "Розничная цена",
        "round_to": 0.01,
        "markup": 0,
        "max_discount": 100,
        "currency": {
          "id": 1,
          "code_num": 860,
          "code_chr": "UZS",
          "name": "Узбекский сум",
          "exchange_rate": 1,
          "is_base": true,
          "deleted": false,
          "last_update": 1664715017
        },
        "currency_additional": {
          "id": 1,
          "code_num": 860,
          "code_chr": "UZS",
          "name": "Узбекский сум",
          "exchange_rate": 1,
          "is_base": true,
          "deleted": false,
          "last_update": 1664715017
        },
        "last_update": 1693395102
      },
      "blocked": true,
      "current_user_blocked": false,
      "performed": true,
      "deleted_mark": false,
      "last_update": 1693396301
    }
  ],
  "next_offset": 1,
  "total": 28
}