Перейти к основному содержимому

Объединенный отчет

GET 
/v5/orgs/:org_guid/reports/operation/combined

Коды возможных ошибок:​

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [404]: "NotFound" - запрашиваемый объект или его родительский объект не найдены [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию

Request​

Path Parameters

    org_guid uuidrequired

    GUID организации

Query Parameters

    date_from date-time

    Starting date

    date_to date-time

    End date

    page_token string

    Токен (курсор, ссылка) запрашиваемой страницы результатов списка. Если он не задан, то возвращается первая страница результатов. Размер страницы списка регулируется сервером.

    presentation PresentationModes

    Possible values: [compact, full]

    Режим представления результатов запроса

Header Parameters

    Accept-Language stringrequired

    Язык используемый для ответов

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

    Идентификатор клиента

    Example: 8f37e6ed-d634-44b2-bec2-847318c97cee
    X-LP-Client-Type stringrequired

    Possible values: [Unknown, App, WebApp, Service, Android]

    Тип клиента

    Example: App
    X-LP-Client-Name string

    Имя клиента

    Example: Swagger
    X-LP-Client-OS-Name string

    ОС клиента

    Example: SwaggerDoc
    X-LP-Client-OS-Version string

    Версия ОС клиента

    Example: 1.0
    X-LP-Client-Screen-Resolution string

    Разрешение экрана ОС клиента

    Example: 1280x0900
    X-LP-Client-Model string

    Модель оборудования клиента

    Example: Chrome 75
    X-LP-Organization-Alias string

    Организация по умолчанию

    X-LP-Client-Extensions csv

    Поддерживаемые клиентом расширения моделей

Responses​

Success

Schema

    items

    object[]

    nullable

    Список лементов типа <typeparamref name="T" />

  • Array [

    • legal_entity

    object

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    brand

    object

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    outlet

    object

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    workplace

    object

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    employee

    object

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    customer_name stringnullable

    Покупатель

    customer_contacts stringnullable

    Контактны покупателя

    deal_comment stringnullable

    Комментарий

    deal_number stringnullable

    Номер продажи

    processed_at date-timenullable

    Дата и время платежа или возврата

    opened_at date-timenullable

    Дата и время открытия продажи

    issued_at date-time

    Дата фискализации

    operation_status stringnullable

    Статус операции

    shipment_status stringnullable

    Статус отгрузки

    sale_status stringnullable

    Статус продажи

    operation TransactionOperationTypes (string)

    Possible values: [Payment, Cancellation, Refund]

    Типы транзакционных операций

    positions

    object[]

    nullable

    Позиции

  • Array [

    • good_type GoodTypes (string)required

    Possible values: [Product, ExciseProduct, Work, Service, GamblingBet, GamblingWinning, LotteryBet, LotteryWinning, IntellectualProperty, Payment, AgentFee, Composite, Other, PropertyRights, NonRealizationIncome, InsuranceFee, TradeFee, ResortFee]

    Типы товаров

    name stringrequired

    Possible values: <= 128 characters

    Наименование

    uom

    object

    required

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    tax ValueAddedTaxRates (string)required

    Possible values: [Tax20, Tax10, Tax0, TaxFree, Tax5, Tax7]

    Перечисление ставок НДС

    sale_price

    object

    required

    Цена

    value int64

    Значение

    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    Коды валют (ISO 4217)

    type_of stringnullable

    Тип объекта

    quantity doublerequired

    Количество

    made_in CountryCodes (string)

    Possible values: [AFG, ALB, ATA, DZA, ASM, AND, AGO, ATG, AZE, ARG, AUS, AUT, BHS, BHR, BGD, ARM, BRB, BEL, BMU, BTN, BOL, BIH, BWA, BVT, BRA, BLZ, IOT, SLB, VGB, BRN, BGR, MMR, BDI, BLR, KHM, CMR, CAN, CPV, CYM, CAF, LKA, TCD, CHL, CHN, TWN, CXR, CCK, COL, COM, MYT, COG, COD, COK, CRI, HRV, CUB, CYP, CZE, BEN, DNK, DMA, DOM, ECU, SLV, GNQ, ETH, ERI, EST, FRO, FLK, SGS, FJI, FIN, ALA, FRA, GUF, PYF, ATF, DJI, GAB, GEO, GMB, PSE, DEU, GHA, GIB, KIR, GRC, GRL, GRD, GLP, GUM, GTM, GIN, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, ISR, ITA, CIV, JAM, JPN, KAZ, JOR, KEN, PRK, KOR, KWT, KGZ, LAO, LBN, LSO, LVA, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MTQ, MRT, MUS, MEX, MCO, MNG, MDA, MNE, MSR, MAR, MOZ, OMN, NAM, NRU, NPL, NLD, CUW, ABW, SXM, BES, NCL, VUT, NZL, NIC, NER, NGA, NIU, NFK, NOR, MNP, UMI, FSM, MHL, PLW, PAK, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, GNB, TLS, PRI, QAT, REU, ROU, RUS, RWA, BLM, SHN, KNA, AIA, LCA, MAF, SPM, VCT, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SVK, VNM, SVN, SOM, ZAF, ZWE, ESP, SSD, SDN, ESH, SUR, SJM, SWZ, SWE, CHE, SYR, TJK, THA, TGO, TKL, TON, TTO, ARE, TUN, TUR, TKM, TCA, TUV, UGA, UKR, MKD, EGY, GBR, GGY, JEY, IMN, TZA, USA, VIR, BFA, URY, UZB, VEN, WLF, WSM, YEM, ZMB]

    Коды стран ISO 3166-1 alpha-3 / ISO 3166-1 numeric

    total_sum

    object

    required

    Цена

    value int64

    Значение

    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    Коды валют (ISO 4217)

    type_of stringnullable

    Тип объекта

    additional_attributes

    object

    Дополнительные атрибуты позиции продажи

    as_agent_type_of FEAgentTypes (string)

    Possible values: [BankPayingAgent, BankPayingSubagent, PayingAgent, PayingSubagent, Attorney, Consignee, Agent]

    Список признаков агента

    transfer_operator_name stringnullable

    Possible values: <= 64 characters

    Наименование оператора перевода

    transfer_operator_phones string[]nullable

    Телефоны оператора перевода

    transfer_operator_address stringnullable

    Possible values: <= 256 characters

    Адрес оператора перевода

    transfer_operator_inn stringnullable

    Possible values: <= 12 characters

    ИНН оператора перевода

    paying_agent_operation stringnullable

    Possible values: <= 24 characters

    Операция платежного агента

    paying_agent_phones string[]nullable

    Телефоны платежного агента

    payment_operator_phones string[]nullable

    Телефоны оператора по приему платежей.

    supplier_name stringnullable

    Possible values: <= 256 characters

    Наименование поставщика

    supplier_inn stringnullable

    Possible values: <= 12 characters

    ИНН поставщика

    supplier_phones string[]nullable

    Телефоны поставщика

    code bytenullable

    Код товарной номенклатуры

    mark stringnullable

    Possible values: <= 1024 characters

    Уникальная марка конкретной единицы товара

    declaration_number stringnullable

    Possible values: <= 32 characters

    Номер таможенной декларации

    excise_fee int32nullable

    Акциз. Форма: печатная, электронная. Заголовок в печатной форме: «АКЦИЗ».

    meta stringnullable

    Метаданные позиции

    meta_data

    object

    nullable

    Метаданные объекта в формате ключ-значение

    property name* stringnullable

    permissions

    object[]

    nullable

    Список разрешений на определенные операции в кассовом приложении для

    конкретных ролей

  • Array [

    • role

    object

    required

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    can_edit_name boolean

    Разрешено ли редактировать наименование

    can_edit_good_type boolean

    Разрешено ли редактировать предмет рассчета

    can_edit_uom boolean

    Разрешено ли редактировать единицу измерения

    can_edit_tax boolean

    Разрешено ли редактировать НДС

    can_edit_quantity boolean

    Разрещено ли редактировать количество за единицу измерения

    can_edit_sale_price boolean

    Разрешено ли редактировать цену за единицу измерения

    can_delete boolean

    Разрешено ли удалять данную позицию

    allowed_max_quantity doublenullable

    Разрешенное максимальное количество (включительно)

    allowed_min_quantity doublenullable

    Разрещенное минимальное количество (включительно)

    allowed_max_sale_price

    object

    Цена

    value int64

    Значение

    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    Коды валют (ISO 4217)

    type_of stringnullable

    Тип объекта

    allowed_min_sale_price

    object

    Цена

    value int64

    Значение

    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    Коды валют (ISO 4217)

    type_of stringnullable

    Тип объекта

    type_of stringnullable

    Тип объекта

  • ]

    • type_of stringnullable

    Тип объекта

  • ]

    • cash_part_amount int64nullable

    Сумма наличными

    card_part_amount int64nullable

    Сумма картой

    sbp_part_amount int64nullable

    Сумма СБП

    other_part_amount int64nullable

    Сумма электронными (электронная)

    sum_by_prepayment int64nullable

    Сумма предоплаты

    amount_otherwise int64nullable

    Сумма иным способом

    total_sum int64nullable

    Итоговая сумма

    card_number stringnullable

    Маска карты

    rrn stringnullable

    RRN

    authorization_code stringnullable

    Код авторизации

    term_id stringnullable

    Идентификатор устройства

    fiscalization_flag boolean

    Признак фискализации

    fiscal_form FiscalDocumentForms (string)

    Possible values: [RegistrationReport, ShiftOpeningReport, Receipt, StrictForm, ShiftClosingReport, FiscalDriveClosingReport, OperatorConfirmation, ReRegistrationReport, SettlementReport, ReceiptOfCorrection, StrictFormOfCorrection]

    Перечисление форм фискальных документов

    operation_type V5FEOperationTypes (string)

    Possible values: [Inflow, InflowRefund, Outflow, OutflowRefund]

    Типы операций (кассовых чеков, БСО)

    serial_number stringnullable

    Заводской номер

    shift_number int32nullable

    Номер смены

    receipt_number int32nullable

    Номер документа в смене

    number int32nullable

    Номер фискального документа

    registration_number stringnullable

    Рег. номер ККТ

    fiscal_drive_number stringnullable

    ФН

    fiscal_sign int64nullable

    ФП/ФПД

    tax_system TaxSystems (string)

    Possible values: [Osn, Usn, UsnMinus, Envd, Esn, Patent]

    Перечисление систем налогообложения

    fiscal_document_format FiscalDataFormats (string)

    Possible values: [Version1, Version2, Version3, Version4]

    Версии ФФД

    results_of_checking_marked_positions stringnullable

    Маркированный товар

    type_of stringnullable

    Тип объекта

  • ]

    • next_page_token stringnullable

    Токен следующей страницы результатов списка

    page_number int32

    Номер текущей страницы. Если нумерация страниц не поддерживается, принимает значение -1 либо отсутствует. В остальных случаях принимает значения от 1 до total_pages включительно.

    pages_total int32

    общее кол-во страниц (>= 0)

    items_per_page int32

    кол-во элементов на странице (постоянное значение с сервера)

    items_total int32

    общее кол-во элементов списка

    type_of stringnullable

    Тип объекта

Loading...