POST api/cheque/ChequesPagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

ChequesPagingInfoRequest
NameDescriptionTypeAdditional information
PosCode

Код торговой точки

string

None.

Report

Признак, что запрос идёт для скачивания отчёта

boolean

None.

Month

Месяц, за который нужно вернуть данные

byte

None.

Year

Год, за который нужно вернуть данные

integer

None.

FilterPartner

Входной фильтр: идентификатор партнера

integer

None.

FilterPos

Входной фильтр: идентификатор точки продаж

integer

None.

Client

Входной фильтр: идентификатор клиента

integer

None.

Card

Входной фильтр: номер карты

integer

None.

Phone

Входной фильтр: номер телефона

integer

None.

SertCard

Входной фильтр: номер подарочного сертификата

integer

None.

Coupon

Входной фильтр: купон

string

None.

PromoCode

Входной фильтр: промокод

string

None.

Date

Входной фильтр: дата операции

date

None.

BegDate

Входной фильтр: начальная дата анализируемого периода

date

None.

EndDate

Входной фильтр: конечная дата анализируемого периода

date

None.

OperationType

Входной фильтр: тип операции ("Покупка" или "Возврат")

string

None.

ChequeNumber

Входной фильтр: номер чека

string

None.

MinGain

Входной фильтр: минимальная сумма покупки

decimal number

None.

MaxGain

Входной фильтр: максимальная сумма покуки

decimal number

None.

MinAdded

Входной фильтр: минимальный размер начисленных бонусов

decimal number

None.

MaxAdded

Входной фильтр: максимальный размер начисленных бонусов

decimal number

None.

MinRedeemed

Входной фильтр: минимальный размер списанных бонусов

decimal number

None.

MaxRedeemed

Входной фильтр: максимальный размер списанных бонусов

decimal number

None.

MinDiscount

Входной фильтр: минимальный размер предоставленных скидок

decimal number

None.

MaxDiscount

Входной фильтр: максимальный размер предоставленных скидок

decimal number

None.

MinSertRedeemed

Входной фильтр: минимальный размер списанных средств с сертификата

decimal number

None.

MaxSertRedeemed

Входной фильтр: максимальный размер списанных средств с сертификата

decimal number

None.

Start

Пагинация: последовательный номер записи от которой нужно возвращать данные (1, 10, 20, 30 и т.д.)

integer

None.

Length

Пагинация: количество записей, которые нужно вернуть

integer

None.

WithCoupon

Входной фильтр: чеки с купонами

boolean

None.

WithSertCard

Входной фильтр: чеки с сертификатами

boolean

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

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

integer

None.

SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "Report": true,
  "Month": 64,
  "Year": 1,
  "FilterPartner": 1,
  "FilterPos": 1,
  "Client": 1,
  "Card": 1,
  "Phone": 1,
  "SertCard": 1,
  "Coupon": "sample string 2",
  "PromoCode": "sample string 3",
  "Date": "2024-06-16T13:14:56.5922165+03:00",
  "BegDate": "2024-06-16T13:14:56.5922165+03:00",
  "EndDate": "2024-06-16T13:14:56.5922165+03:00",
  "OperationType": "sample string 4",
  "ChequeNumber": "sample string 5",
  "MinGain": 1.0,
  "MaxGain": 1.0,
  "MinAdded": 1.0,
  "MaxAdded": 1.0,
  "MinRedeemed": 1.0,
  "MaxRedeemed": 1.0,
  "MinDiscount": 1.0,
  "MaxDiscount": 1.0,
  "MinSertRedeemed": 1.0,
  "MaxSertRedeemed": 1.0,
  "Start": 1,
  "Length": 1,
  "WithCoupon": true,
  "WithSertCard": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 6"
}

application/xml, text/xml

Sample:
<ChequesPagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.ChequeRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 6</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BegDate>2024-06-16T13:14:56.5922165+03:00</BegDate>
  <Card>1</Card>
  <ChequeNumber>sample string 5</ChequeNumber>
  <Client>1</Client>
  <Coupon>sample string 2</Coupon>
  <Date>2024-06-16T13:14:56.5922165+03:00</Date>
  <EndDate>2024-06-16T13:14:56.5922165+03:00</EndDate>
  <FilterPartner>1</FilterPartner>
  <FilterPos>1</FilterPos>
  <Length>1</Length>
  <MaxAdded>1</MaxAdded>
  <MaxDiscount>1</MaxDiscount>
  <MaxGain>1</MaxGain>
  <MaxRedeemed>1</MaxRedeemed>
  <MaxSertRedeemed>1</MaxSertRedeemed>
  <MinAdded>1</MinAdded>
  <MinDiscount>1</MinDiscount>
  <MinGain>1</MinGain>
  <MinRedeemed>1</MinRedeemed>
  <MinSertRedeemed>1</MinSertRedeemed>
  <Month>64</Month>
  <OperationType>sample string 4</OperationType>
  <Phone>1</Phone>
  <PosCode>sample string 1</PosCode>
  <PromoCode>sample string 3</PromoCode>
  <Report>true</Report>
  <SertCard>1</SertCard>
  <Start>1</Start>
  <WithCoupon>true</WithCoupon>
  <WithSertCard>true</WithSertCard>
  <Year>1</Year>
</ChequesPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ChequesPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

Количество записей, которые попали в выборку

integer

None.

TotalRowsSelect

Количество записей, которые вернулись в массиве ответа на запрос

integer

None.

Data

Список чеков

Collection of ChequesPagingInfoDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

Сообщение об ошибке

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "ChequeId": 1,
      "ProcTime": "2024-06-16T13:14:56.7640934+03:00",
      "ChequeTime": "2024-06-16T13:14:56.7640934+03:00",
      "Partner": 1,
      "PartnerName": "sample string 1",
      "Pos": 1,
      "PosName": "sample string 2",
      "Card": 1,
      "Phone": 1,
      "SertCard": 1,
      "Coupon": "sample string 3",
      "PromoCode": "sample string 4",
      "OperationType": "sample string 5",
      "Gain": 1.0,
      "Amount": 1.0,
      "BonusAdded": 1.0,
      "BonusRedeemed": 1.0,
      "SertRedeemed": 1.0,
      "SertAdded": 1.0,
      "Discount": 1.0,
      "RefundNotFull": true,
      "ChequeRefund": 1,
      "Terminal": "sample string 6",
      "Guid": "sample string 7"
    },
    {
      "Id": 1,
      "ChequeId": 1,
      "ProcTime": "2024-06-16T13:14:56.7640934+03:00",
      "ChequeTime": "2024-06-16T13:14:56.7640934+03:00",
      "Partner": 1,
      "PartnerName": "sample string 1",
      "Pos": 1,
      "PosName": "sample string 2",
      "Card": 1,
      "Phone": 1,
      "SertCard": 1,
      "Coupon": "sample string 3",
      "PromoCode": "sample string 4",
      "OperationType": "sample string 5",
      "Gain": 1.0,
      "Amount": 1.0,
      "BonusAdded": 1.0,
      "BonusRedeemed": 1.0,
      "SertRedeemed": 1.0,
      "SertAdded": 1.0,
      "Discount": 1.0,
      "RefundNotFull": true,
      "ChequeRefund": 1,
      "Terminal": "sample string 6",
      "Guid": "sample string 7"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ChequesPagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.ChequeResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <Data>
    <ChequesPagingInfoResponse.ChequesPagingInfoDataRow>
      <Amount>1</Amount>
      <BonusAdded>1</BonusAdded>
      <BonusRedeemed>1</BonusRedeemed>
      <Card>1</Card>
      <ChequeId>1</ChequeId>
      <ChequeRefund>1</ChequeRefund>
      <ChequeTime>2024-06-16T13:14:56.7640934+03:00</ChequeTime>
      <Coupon>sample string 3</Coupon>
      <Discount>1</Discount>
      <Gain>1</Gain>
      <Guid>sample string 7</Guid>
      <Id>1</Id>
      <OperationType>sample string 5</OperationType>
      <Partner>1</Partner>
      <PartnerName>sample string 1</PartnerName>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 2</PosName>
      <ProcTime>2024-06-16T13:14:56.7640934+03:00</ProcTime>
      <PromoCode>sample string 4</PromoCode>
      <RefundNotFull>true</RefundNotFull>
      <SertAdded>1</SertAdded>
      <SertCard>1</SertCard>
      <SertRedeemed>1</SertRedeemed>
      <Terminal>sample string 6</Terminal>
    </ChequesPagingInfoResponse.ChequesPagingInfoDataRow>
    <ChequesPagingInfoResponse.ChequesPagingInfoDataRow>
      <Amount>1</Amount>
      <BonusAdded>1</BonusAdded>
      <BonusRedeemed>1</BonusRedeemed>
      <Card>1</Card>
      <ChequeId>1</ChequeId>
      <ChequeRefund>1</ChequeRefund>
      <ChequeTime>2024-06-16T13:14:56.7640934+03:00</ChequeTime>
      <Coupon>sample string 3</Coupon>
      <Discount>1</Discount>
      <Gain>1</Gain>
      <Guid>sample string 7</Guid>
      <Id>1</Id>
      <OperationType>sample string 5</OperationType>
      <Partner>1</Partner>
      <PartnerName>sample string 1</PartnerName>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 2</PosName>
      <ProcTime>2024-06-16T13:14:56.7640934+03:00</ProcTime>
      <PromoCode>sample string 4</PromoCode>
      <RefundNotFull>true</RefundNotFull>
      <SertAdded>1</SertAdded>
      <SertCard>1</SertCard>
      <SertRedeemed>1</SertRedeemed>
      <Terminal>sample string 6</Terminal>
    </ChequesPagingInfoResponse.ChequesPagingInfoDataRow>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</ChequesPagingInfoResponse>