POST api/values/ChequeAdd

Расчёт и применение поощрений по чеку покупки, регистрация чека покупки и возврата на процессинге

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Card	Номер карты лояльности	integer	None.
ChequeTime	Дата и время проводимой операции во внешней системе	date	None.
Phone	Номер телефона клиента	integer	None.
Partner	Идентификатор Партнера	integer	None.
POS	Код торговой точки	string	None.
Amount	Cумма операции ДО списания бонусов и средств с сертификата, но ПОСЛЕ применения скидок	decimal number	None.
PaidByBonus	Cумма предоставляемой скидки по списания бонусов (всегда = Redeemed)	decimal number	None.
Redeemed	Сумма списываемых бонусов (всегда = PaidByBonus)	decimal number	None.
Number	Номер чека покупки/возврата или заказа	string	None.
ItemData	Список позиций чека	Collection of Item	None.
NoWrite	Признак работы метода: true = расчёт поощрений, false = фискализация операции	boolean	None.
BonusId	Идентификатор бонуса списания, из которого нужно вернуть бонусы на счёт перед операцией (старое холдирование)	integer	None.
NoAdd	Команда: не начислять бонусы за эту операцию	boolean	None.
NoRedeem	Команда: не списывать бонусы в эту операцию	boolean	None.
Coupon	Купон или Промокод, применённый к этой операции	string	None.
Refund	Признак чека возврата	boolean	None.
Purchasenumber	Номер чека покупки, по которому необходимо сделать возврат	string	None.
Purchasedate	Дата чека покупки, по которому необходимо сделать возврат	date	None.
Terminal	Терминал (наименование кассового терминала), с которого проходит операция	string	None.
Discount	Сумма скидки предоставляемая или предоставленная в чек (!!! не используется !!!)	decimal number	None.
Actionhold	Тип действия по холдированию бонусов, которое совершается (Hold, DeHold, CancelHold)	string	None.
Holdid	Идентификатор холдирования бонусов (после создания, для расхолдирования или отмены холдирования бонусов)	integer	None.
Holdamount	Сумма бонусов, которые необходимо захолдировать на карте лояльности	decimal number	None.
SertCard	Номер подарочного сертификата	integer	None.
SertRedeemed	Сумма списываемых или списанных средств с подарочного сертификата	decimal number	None.
SertSecretCode	Пинкод, с помощью которого списывали средства с электронного подарочного сертификата	string	None.
Guid	Уникальный идентификатор документа во внешней системе (приход или возврат)	string	None.
ReferenceGuid	Уникальный идентификатор документа типа "приход" для проведения возврата по нему	string	None.
RedeemSmsCode	Код подтверждения, которым подтверждался телефон для списания бонусов	string	None.
InvoiceGuid	Уникальный идентификатор накладной во внешней системе, по которой производится данная операция	string	None.
OrderId	Идентификатор заказа в процессинге по которому производится данная операция	integer	None.
PaymentType	Идентификатор типа оплаты в процессинге, которым оплачена данная операция (1 = наличные, 2 = безналичные, 3 = смешанная оплата)	byte	None.
InvoiceId	Идентификатор накладной в процессинге, по которой производится данная операция	integer	None.
ClientId	Идентификатор клиента в процессинге, на которого записывается данная операция (альтернатива номеру карты и номеру телефона)	integer	None.
Operator	Идентификатор оператора программы лояльности	integer	None.
Token	Токен пользователя, который инициирует данный запрос	integer	None.
SiteCode	Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Card": 1,
  "ChequeTime": "2024-05-08T07:03:12.513677+03:00",
  "Phone": 1,
  "Partner": 1,
  "POS": "sample string 1",
  "Amount": 1.0,
  "PaidByBonus": 1.0,
  "Redeemed": 1.0,
  "Number": "sample string 2",
  "ItemData": [
    {
      "Id": 1,
      "Position": 64,
      "Code": "sample string 3",
      "Price": 4.0,
      "Quantity": 5.0,
      "Amount": 6.0,
      "PaidByBonus": 7.0,
      "MinPrice": 8.0,
      "NoAdd": true,
      "NoRedeem": true,
      "MaxRedeem": 11.0,
      "Redeemed": 12.0,
      "Added": 13.0,
      "Discount": 14.0,
      "Size": "sample string 15",
      "Credit": true,
      "SertMaxRedeem": 1.0,
      "SertRedeemed": 1.0,
      "Discamount": 1.0,
      "SertAdded": 1.0,
      "NomenclatureType": "sample string 16",
      "NomenclatureSpecies": "sample string 17",
      "Name": "sample string 18",
      "CatalogPosition": "sample string 19",
      "GoodId": 1
    },
    {
      "Id": 1,
      "Position": 64,
      "Code": "sample string 3",
      "Price": 4.0,
      "Quantity": 5.0,
      "Amount": 6.0,
      "PaidByBonus": 7.0,
      "MinPrice": 8.0,
      "NoAdd": true,
      "NoRedeem": true,
      "MaxRedeem": 11.0,
      "Redeemed": 12.0,
      "Added": 13.0,
      "Discount": 14.0,
      "Size": "sample string 15",
      "Credit": true,
      "SertMaxRedeem": 1.0,
      "SertRedeemed": 1.0,
      "Discamount": 1.0,
      "SertAdded": 1.0,
      "NomenclatureType": "sample string 16",
      "NomenclatureSpecies": "sample string 17",
      "Name": "sample string 18",
      "CatalogPosition": "sample string 19",
      "GoodId": 1
    }
  ],
  "NoWrite": true,
  "BonusId": 1,
  "NoAdd": true,
  "NoRedeem": true,
  "Coupon": "sample string 3",
  "Refund": true,
  "Purchasenumber": "sample string 4",
  "Purchasedate": "2024-05-08T07:03:12.513677+03:00",
  "Terminal": "sample string 5",
  "Discount": 1.0,
  "Actionhold": "sample string 6",
  "Holdid": 1,
  "Holdamount": 1.0,
  "SertCard": 1,
  "SertRedeemed": 1.0,
  "SertSecretCode": "sample string 7",
  "Guid": "sample string 8",
  "ReferenceGuid": "sample string 9",
  "RedeemSmsCode": "sample string 10",
  "InvoiceGuid": "sample string 11",
  "OrderId": 1,
  "PaymentType": 64,
  "InvoiceId": 1,
  "ClientId": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 12"
}

application/xml, text/xml

Sample:

<ChequeAddRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models">
  <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 12</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Actionhold>sample string 6</Actionhold>
  <Amount>1</Amount>
  <BonusId>1</BonusId>
  <Card>1</Card>
  <ChequeTime>2024-05-08T07:03:12.513677+03:00</ChequeTime>
  <ClientId>1</ClientId>
  <Coupon>sample string 3</Coupon>
  <Discount>1</Discount>
  <Guid>sample string 8</Guid>
  <Holdamount>1</Holdamount>
  <Holdid>1</Holdid>
  <InvoiceGuid>sample string 11</InvoiceGuid>
  <InvoiceId>1</InvoiceId>
  <ItemData>
    <Item>
      <Added>13</Added>
      <Amount>6</Amount>
      <CatalogPosition>sample string 19</CatalogPosition>
      <Code>sample string 3</Code>
      <Credit>true</Credit>
      <Discamount>1</Discamount>
      <Discount>14</Discount>
      <GoodId>1</GoodId>
      <Id>1</Id>
      <MaxRedeem>11</MaxRedeem>
      <MinPrice>8</MinPrice>
      <Name>sample string 18</Name>
      <NoAdd>true</NoAdd>
      <NoRedeem>true</NoRedeem>
      <NomenclatureSpecies>sample string 17</NomenclatureSpecies>
      <NomenclatureType>sample string 16</NomenclatureType>
      <PaidByBonus>7</PaidByBonus>
      <Position>64</Position>
      <Price>4</Price>
      <Quantity>5</Quantity>
      <Redeemed>12</Redeemed>
      <SertAdded>1</SertAdded>
      <SertMaxRedeem>1</SertMaxRedeem>
      <SertRedeemed>1</SertRedeemed>
      <Size>sample string 15</Size>
    </Item>
    <Item>
      <Added>13</Added>
      <Amount>6</Amount>
      <CatalogPosition>sample string 19</CatalogPosition>
      <Code>sample string 3</Code>
      <Credit>true</Credit>
      <Discamount>1</Discamount>
      <Discount>14</Discount>
      <GoodId>1</GoodId>
      <Id>1</Id>
      <MaxRedeem>11</MaxRedeem>
      <MinPrice>8</MinPrice>
      <Name>sample string 18</Name>
      <NoAdd>true</NoAdd>
      <NoRedeem>true</NoRedeem>
      <NomenclatureSpecies>sample string 17</NomenclatureSpecies>
      <NomenclatureType>sample string 16</NomenclatureType>
      <PaidByBonus>7</PaidByBonus>
      <Position>64</Position>
      <Price>4</Price>
      <Quantity>5</Quantity>
      <Redeemed>12</Redeemed>
      <SertAdded>1</SertAdded>
      <SertMaxRedeem>1</SertMaxRedeem>
      <SertRedeemed>1</SertRedeemed>
      <Size>sample string 15</Size>
    </Item>
  </ItemData>
  <NoAdd>true</NoAdd>
  <NoRedeem>true</NoRedeem>
  <NoWrite>true</NoWrite>
  <Number>sample string 2</Number>
  <OrderId>1</OrderId>
  <POS>sample string 1</POS>
  <PaidByBonus>1</PaidByBonus>
  <Partner>1</Partner>
  <PaymentType>64</PaymentType>
  <Phone>1</Phone>
  <Purchasedate>2024-05-08T07:03:12.513677+03:00</Purchasedate>
  <Purchasenumber>sample string 4</Purchasenumber>
  <RedeemSmsCode>sample string 10</RedeemSmsCode>
  <Redeemed>1</Redeemed>
  <ReferenceGuid>sample string 9</ReferenceGuid>
  <Refund>true</Refund>
  <SertCard>1</SertCard>
  <SertRedeemed>1</SertRedeemed>
  <SertSecretCode>sample string 7</SertSecretCode>
  <Terminal>sample string 5</Terminal>
</ChequeAddRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ChequeAddResponse

Name	Description	Type	Additional information
ErrorCode	Код ошибки	integer	None.
Message	Текст ошибки	string	None.
Added	Сумма начисленных бонусов или тех, что будут начислены за операцию	decimal number	None.
Bonus	Дубль: сумма начисленных бонусов или тех, что будут начислены за операцию	decimal number	None.
Discount	Сумма скидки предоставленная или та которая может быть предоставлена за операцию	decimal number	None.
Balance	Активный для списания баланс бонусов на карте лояльности ПОСЛЕ проведения операции	decimal number	None.
Redeemed	Сумма списанных или списываемых бонусов в операцию	decimal number	None.
MaxRedeem	Максимальная сумма для списания бонусов в операцию	decimal number	None.
FullBalance	Полный баланс бонусов на карте лояльности ПОСЛЕ проведения операции (активные + неактивные бонусы)	decimal number	None.
PurchaseSum	Общая сумма покупок клиента ПОСЛЕ проведения операции	decimal number	None.
SertMaxRedeem	Максимальная сумма для списания средств с подарочного сертификата в операцию	decimal number	None.
SertBalance	Баланс подарочного сертификата ПОСЛЕ проведения операции	decimal number	None.
Holdid	Идентификатор бонуса холдирования или расхолдирования, в зависимости от типа операции	integer	None.
SertRedeemed	Сумма списанных средств с подарочного сертификата в операцию	decimal number	None.
SertAdded	Сумма начисленных средств на подарочный сертификат за операцию	decimal number	None.
Cheque	Идентификатор операции ПОСЛЕ её проведения в процессинге	integer	None.
ItemData	Список позиций чека	Collection of Item	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": 1,
  "Message": "sample string 2",
  "Added": 3.0,
  "Bonus": 4.0,
  "Discount": 5.0,
  "Balance": 6.0,
  "Redeemed": 7.0,
  "MaxRedeem": 8.0,
  "FullBalance": 9.0,
  "PurchaseSum": 10.0,
  "SertMaxRedeem": 1.0,
  "SertBalance": 1.0,
  "Holdid": 1,
  "SertRedeemed": 1.0,
  "SertAdded": 1.0,
  "Cheque": 1,
  "ItemData": [
    {
      "Id": 1,
      "Position": 64,
      "Code": "sample string 3",
      "Price": 4.0,
      "Quantity": 5.0,
      "Amount": 6.0,
      "PaidByBonus": 7.0,
      "MinPrice": 8.0,
      "NoAdd": true,
      "NoRedeem": true,
      "MaxRedeem": 11.0,
      "Redeemed": 12.0,
      "Added": 13.0,
      "Discount": 14.0,
      "Size": "sample string 15",
      "Credit": true,
      "SertMaxRedeem": 1.0,
      "SertRedeemed": 1.0,
      "Discamount": 1.0,
      "SertAdded": 1.0,
      "NomenclatureType": "sample string 16",
      "NomenclatureSpecies": "sample string 17",
      "Name": "sample string 18",
      "CatalogPosition": "sample string 19",
      "GoodId": 1
    },
    {
      "Id": 1,
      "Position": 64,
      "Code": "sample string 3",
      "Price": 4.0,
      "Quantity": 5.0,
      "Amount": 6.0,
      "PaidByBonus": 7.0,
      "MinPrice": 8.0,
      "NoAdd": true,
      "NoRedeem": true,
      "MaxRedeem": 11.0,
      "Redeemed": 12.0,
      "Added": 13.0,
      "Discount": 14.0,
      "Size": "sample string 15",
      "Credit": true,
      "SertMaxRedeem": 1.0,
      "SertRedeemed": 1.0,
      "Discamount": 1.0,
      "SertAdded": 1.0,
      "NomenclatureType": "sample string 16",
      "NomenclatureSpecies": "sample string 17",
      "Name": "sample string 18",
      "CatalogPosition": "sample string 19",
      "GoodId": 1
    }
  ]
}

application/xml, text/xml

Sample:

<ChequeAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models">
  <Added>3</Added>
  <Balance>6</Balance>
  <Bonus>4</Bonus>
  <Cheque>1</Cheque>
  <Discount>5</Discount>
  <ErrorCode>1</ErrorCode>
  <FullBalance>9</FullBalance>
  <Holdid>1</Holdid>
  <ItemData>
    <Item>
      <Added>13</Added>
      <Amount>6</Amount>
      <CatalogPosition>sample string 19</CatalogPosition>
      <Code>sample string 3</Code>
      <Credit>true</Credit>
      <Discamount>1</Discamount>
      <Discount>14</Discount>
      <GoodId>1</GoodId>
      <Id>1</Id>
      <MaxRedeem>11</MaxRedeem>
      <MinPrice>8</MinPrice>
      <Name>sample string 18</Name>
      <NoAdd>true</NoAdd>
      <NoRedeem>true</NoRedeem>
      <NomenclatureSpecies>sample string 17</NomenclatureSpecies>
      <NomenclatureType>sample string 16</NomenclatureType>
      <PaidByBonus>7</PaidByBonus>
      <Position>64</Position>
      <Price>4</Price>
      <Quantity>5</Quantity>
      <Redeemed>12</Redeemed>
      <SertAdded>1</SertAdded>
      <SertMaxRedeem>1</SertMaxRedeem>
      <SertRedeemed>1</SertRedeemed>
      <Size>sample string 15</Size>
    </Item>
    <Item>
      <Added>13</Added>
      <Amount>6</Amount>
      <CatalogPosition>sample string 19</CatalogPosition>
      <Code>sample string 3</Code>
      <Credit>true</Credit>
      <Discamount>1</Discamount>
      <Discount>14</Discount>
      <GoodId>1</GoodId>
      <Id>1</Id>
      <MaxRedeem>11</MaxRedeem>
      <MinPrice>8</MinPrice>
      <Name>sample string 18</Name>
      <NoAdd>true</NoAdd>
      <NoRedeem>true</NoRedeem>
      <NomenclatureSpecies>sample string 17</NomenclatureSpecies>
      <NomenclatureType>sample string 16</NomenclatureType>
      <PaidByBonus>7</PaidByBonus>
      <Position>64</Position>
      <Price>4</Price>
      <Quantity>5</Quantity>
      <Redeemed>12</Redeemed>
      <SertAdded>1</SertAdded>
      <SertMaxRedeem>1</SertMaxRedeem>
      <SertRedeemed>1</SertRedeemed>
      <Size>sample string 15</Size>
    </Item>
  </ItemData>
  <MaxRedeem>8</MaxRedeem>
  <Message>sample string 2</Message>
  <PurchaseSum>10</PurchaseSum>
  <Redeemed>7</Redeemed>
  <SertAdded>1</SertAdded>
  <SertBalance>1</SertBalance>
  <SertMaxRedeem>1</SertMaxRedeem>
  <SertRedeemed>1</SertRedeemed>
</ChequeAddResponse>