Skip to main content

Получить список операций с деньгами по сделке продажи

GET 
/v5/orgs/:org_guid/deals/sales/:deal_guid/docs/money

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

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

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

Поиск по списку организаций производится по полям: "name" и "address".

Request​

Path Parameters

    org_guid uuidrequired

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

    deal_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

    Поисковый запрос (1-64 символа)

    order_by SaleMoneyOrderings

    Possible values: [created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, processed_at_asc, processed_at_desc]

    Вариант сортировки результатов запроса

    page_token string

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

    selection SelectionModes

    Possible values: [alive_only, archived_only, all]

    Режим выборки объектов из списка

    presentation PresentationModes

    Possible values: [compact, full]

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

    processed_at_from date-time

    Фильтр: Операция оплачена/возвращена после этой даты (включительно)

    processed_at_to date-time

    Фильтр: Операция оплачена/возвращена до этой даты (включительно)

    total_sum_from int64

    Фильтр: Итоговая сумма сделки больше или равна указанному значению

    total_sum_to int64

    Фильтр: Итоговая сумма сделки меньше или равна указанному значению. Если указанное значение сопадает с LifePay.Api.Public.Models.QueryParameters.Filters.SaleActionFilters.total_sum_from то возвращаются сделки с итоговой суммой совпадающей с этими двумя значениями

    type string

    Фильтр: тип операции (SalePayment | SaleRefund)

    outlet_guid uuid[]

    Фильтр: Сделки для указанных торговых точек

    opened_by_guid uuid[]

    Фильтр: Сделки открыты указанными сотрудниками

    transaction_guid uuid[]

    Фильтр: Сделки проведены с указанными транзакциями

    workplace_guid uuid[]

    Фильтр: Сделки проведены на указанных рабочих местах

    fiscal_document_guid uuid[]

    Фильтр: Сделки проведены с указанными фискальными документами

    method MoneyOperationPaymentType

    Possible values: [card, cash]

    Фильтр: Сделки проведены с указанным методом оплаты

Header Parameters

    Accept-Language stringrequired

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

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

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

    Example: 19e4ee1b-8293-41e8-a6eb-9620abb85f88
    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

  • Array [

    • processed_at date-timenullable

    Дата оплаты

    sum_by_card

    object

    Цена

    value int64

    Значение

    currency CurrencyCodes (string)required

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

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

    type_of stringnullable

    Тип объекта

    sum_by_cash

    object

    Цена

    value int64

    Значение

    currency CurrencyCodes (string)required

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

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

    type_of stringnullable

    Тип объекта

    total_sum

    object

    Цена

    value int64

    Значение

    currency CurrencyCodes (string)required

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

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

    type_of stringnullable

    Тип объекта

    positions

    object[]

    nullable

    Цели

  • Array [

    • paid_quantity doublerequired

    Оплаченное количество

    paid_amount

    object

    required

    Цена

    value int64

    Значение

    currency CurrencyCodes (string)required

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

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

    type_of stringnullable

    Тип объекта

    position

    object

    required

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

    типа

    guid uuid

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

    type_of stringnullable

    Тип объекта

    type_of stringnullable

    Тип объекта

  • ]

    • fiscal_document

    object

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

    типа

    guid uuid

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

    type_of stringnullable

    Тип объекта

    transactions

    object[]

    nullable

    Транзакции

  • Array [

    • guid uuid

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

    type_of stringnullable

    Тип объекта

  • ]

    • 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

    Тип объекта

  • ]

Loading...