Skip to main content

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

GET 
/v5/orgs/:org_guid/fiscal-registrars/:registrar_guid/docs

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

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

Важная информация!​

Поиск по списку производится по полю "number".

Request​

Path Parameters

    org_guid uuidrequired

    Уникальный идентификатор организации

    registrar_guid anyrequired

    Уникальный идентификатор фискального регистратора

Query Parameters

    created_from date-time
    created_to date-time
    updated_from date-time
    updated_to date-time
    query string

    Possible values: non-empty and <= 64 characters

    Поиск производится по полям: number, meta, metadata

    order_by FiscalDocOrderings

    Possible values: [created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, fiscal_form_asc, fiscal_form_desc, number_asc, number_desc]

    page_token string
    selection SelectionModes

    Possible values: [alive_only, archived_only, all]

    presentation PresentationModes

    Possible values: [compact, full]

    fiscal_form FiscalDocumentForms[]

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

    Фильтр: Перечисление форм фискальных документов, которые должны быть возвращены

    number int32[]

    Поиск точного совпадения по номеру

    issued_at_from date-time

    Фильтр: Фискальный документ сформирован после этой даты (включительно)

    issued_at_to date-time

    Фильтр: Фискальный документ сформирован до этой даты

Header Parameters

    Accept-Language stringrequired

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

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

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

    Example: 72efb0a8-3f1d-4479-a63f-a95f45da60bf
    X-LP-Client-Type stringrequired

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

    Тип клиента

    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

  • Array [

    • fiscal_form FiscalDocumentForms (string)required

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

    fiscal_drive_number stringrequired

    Possible values: <= 16 characters, Value must match regular expression ^\d+$

    number int32required
    cashier_name stringnullable

    Possible values: <= 64 characters

    issued_at date-timerequired
    created_at date-time
    updated_at date-time
    deleted_at date-timenullable
    meta stringnullable

    Possible values: <= 128 characters

    meta_data

    object

    nullable

    property name* string
    guid uuid
    type_of stringnullable

  • ]

    • next_page_token stringnullable
    page_number int32
    pages_total int32
    items_per_page int32
    items_total int32
    type_of stringnullable
Loading...