POST api/frontol/document

Метод работы с документом

Request Information

URI Parameters

None.

Body Parameters

FrontolDocumentRequest
NameDescriptionTypeAdditional information
Action

Действие с документом

string

None.

DateTime

Дата и время формирования запроса

string

None.

Organization

Идентификатор организации

string

None.

BusinessUnit

Идентификатор магазина, подразделения и т.п.

string

None.

WorkPlace

Идентификатор рабочего места

string

None.

Payment

Данные по проводимой оплате

FrontolPaymentTypeRequest

None.

Client

Данные клиента для авторизации. Либо номер карты, либо номер телефона

FrontolClientTypeRequest

None.

Number

Программный номер документа

integer

None.

Shift

Программный номер смены

integer

None.

Uid

Уникальный идентификатор документа

string

None.

ReferenceUid

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

string

None.

Type

Тип документа

string

None.

Positions

Массив позиций документа

Collection of FrontolPositionsTypeRequest

None.

DiscardedAmount

Сумма отброшенных копеек в соответствии с механизмом, описанном в форматах фискальных документов

decimal number

None.

Payments

Массив оплат документа

Collection of FrontolPaymentsTypeRequest

None.

Request Formats

application/json, text/json

Sample:
{
  "Action": "sample string 1",
  "DateTime": "sample string 2",
  "Organization": "sample string 3",
  "BusinessUnit": "sample string 4",
  "WorkPlace": "sample string 5",
  "Payment": {
    "Mode": "sample string 1",
    "Amount": 1.0
  },
  "Client": {
    "MobilePhone": "sample string 1",
    "Card": "sample string 2"
  },
  "Number": 1,
  "Shift": 1,
  "Uid": "sample string 6",
  "ReferenceUid": "sample string 7",
  "Type": "sample string 8",
  "Positions": [
    {
      "Index": 1,
      "Id": "sample string 1",
      "Text": "sample string 2",
      "Price": 1.0,
      "MinimumPrice": 1.0,
      "Quantity": 1.0,
      "TotalAmount": 1.0
    },
    {
      "Index": 1,
      "Id": "sample string 1",
      "Text": "sample string 2",
      "Price": 1.0,
      "MinimumPrice": 1.0,
      "Quantity": 1.0,
      "TotalAmount": 1.0
    }
  ],
  "DiscardedAmount": 1.0,
  "Payments": [
    {
      "Type": "sample string 1",
      "Mode": "sample string 2",
      "Amount": 1.0
    },
    {
      "Type": "sample string 1",
      "Mode": "sample string 2",
      "Amount": 1.0
    }
  ]
}

application/xml, text/xml

Sample:
<FrontolDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Frontol">
  <Action>sample string 1</Action>
  <BusinessUnit>sample string 4</BusinessUnit>
  <Client>
    <Card>sample string 2</Card>
    <MobilePhone>sample string 1</MobilePhone>
  </Client>
  <DateTime>sample string 2</DateTime>
  <DiscardedAmount>1</DiscardedAmount>
  <Number>1</Number>
  <Organization>sample string 3</Organization>
  <Payment>
    <Amount>1</Amount>
    <Mode>sample string 1</Mode>
  </Payment>
  <Payments>
    <FrontolPaymentsTypeRequest>
      <Amount>1</Amount>
      <Mode>sample string 2</Mode>
      <Type>sample string 1</Type>
    </FrontolPaymentsTypeRequest>
    <FrontolPaymentsTypeRequest>
      <Amount>1</Amount>
      <Mode>sample string 2</Mode>
      <Type>sample string 1</Type>
    </FrontolPaymentsTypeRequest>
  </Payments>
  <Positions>
    <FrontolPositionsTypeRequest>
      <Id>sample string 1</Id>
      <Index>1</Index>
      <MinimumPrice>1</MinimumPrice>
      <Price>1</Price>
      <Quantity>1</Quantity>
      <Text>sample string 2</Text>
      <TotalAmount>1</TotalAmount>
    </FrontolPositionsTypeRequest>
    <FrontolPositionsTypeRequest>
      <Id>sample string 1</Id>
      <Index>1</Index>
      <MinimumPrice>1</MinimumPrice>
      <Price>1</Price>
      <Quantity>1</Quantity>
      <Text>sample string 2</Text>
      <TotalAmount>1</TotalAmount>
    </FrontolPositionsTypeRequest>
  </Positions>
  <ReferenceUid>sample string 7</ReferenceUid>
  <Shift>1</Shift>
  <Type>sample string 8</Type>
  <Uid>sample string 6</Uid>
  <WorkPlace>sample string 5</WorkPlace>
</FrontolDocumentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.