CreateCorrection

https://{Environment}.payture.com/apicheque/CreateCorrection/

Запрос CreateCorrection используется для создания чека коррекции без платежа.

Создание чека коррекции — асинхронный запрос, после которого чек оказывается в очереди на обработку. Помимо данных чека Продавец передает уникальный идентификатор документа, используя который, он сможет запросить статус чека. Данный идентификатор должен быть уникальным в пределах организации. Для передачи чека необходимо сформировать структуру данных в виде JSON.

Внимание!

Онлайн-касса Бухта KZ не поддерживает функционал создания чека коррекции.

Запрос

Параметр	Описание	Формат
Key	Наименование Терминала Предоставляется с параметрами тестового/рабочего доступа	String Mandatory
Password	Пароль для выполнения запросов apiecheque Предоставляется с параметрами тестового/рабочего доступа	String Mandatory
Body	Контейнер с информацией о чеке Описание структуры Body см. ниже	Object Mandatory

Пример тела запроса (минимальный набор параметров) [JSON]:

{
  "Key":"Merchant",
  "Password":"1234",
  "Body":{
    "Id":"pprcrnyf236wc4bu38uw",
    "Inn":"7710140679",
    "Content":{
      "Type":1,
      "Description":"Описание коррекции",
      "CauseDocumentDate":"2019-09-17T00:00:00",
      "CauseDocumentNumber":"22000070248",
      "TotalSum":100,
      "CashSum":0,
      "ECashSum":100
    }
  }
}

Пример тела запроса (максимальный набор параметров) [JSON]:

{
  "Key":"Merchant",
  "Password":"1234",
  "Body":{
    "Id":"tf73q69ft3rfs4ep2yld3v",
    "Inn":"7710140679",
    "Group":"main",
    "Content":{
      "Type":1,
      "TaxationSystem":1,
      "Description":"Описание коррекции",
      "CauseDocumentDate":"2019-09-17T00:00:00",
      "CauseDocumentNumber":"22000070249",
      "CorrectionType":0,
      "TotalSum":100,
      "CashSum":0,
      "ECashSum":100,
      "PrepaymentSum":0,
      "PostpaymentSum":0,
      "OtherPaymentTypeSum":0,
      "Tax1Sum":22
    }
  }
}

Состав Body

Параметр	Описание	Формат
Id	Уникальный идентификатор чека	String [1..64] Mandatory
INN	ИНН организации, для которой формируется чек	String [10..12] Mandatory
Content	Данные чека Описание структуры Content см. ниже	Object Mandatory
Group	Группа устройств, с помощью которых будет сформирован чек По умолчанию «main»	String [1..32] Optional
CustomerContact	Электронная почта или номер телефона покупателя (должен передаваться с кодом страны и начинаться c «+»)	String [1..32] Mandatory только для Атол

Состав Body.Content

Параметр	Описание (тег)	Формат
Type	Тип документа (1054). Принимает значения: `1` — Приход `3` — Расход	Integer Mandatory
TaxationSystem	Номер системы налогообложения (1055). Принимает значения от 0 до 5: `0` — Общая, ОСН `1` — Упрощенная доход, УСН доход `2` — Упрощенная доход минус расход, УСН `3` — Единый налог на вмененный доход, ЕНВД `4` — Единый сельскохозяйственный налог, ЕСН `5` — Патентная система налогообложения	Integer Optional
Description	Описание коррекции (1177)	String [1..244] Mandatory
CauseDocumentDate	Дата документа основания для коррекции (1178) Строка в формате ISO8601. Время должно быть указано 00:00:00	String Mandatory
CauseDocumentNumber	Номер документа основания для коррекции (1179)	String [1..32] Mandatory
CorrectionType	Тип коррекции (1173). Принимает значения от 0 до 1: `0` — Самостоятельно `1` — По предписанию По умолчанию `0`	Integer Optional
TotalSum	Сумма расчета в рублях, указанного в чеке (1020) Десятичное число с точностью до 2 цифр после точки	Float Mandatory
Формы расчета	Нужно указать хотя бы одно из значений ниже. Десятичное число с точностью до 2 цифр после точки	Float Mandatory
CashSum	Сумма по чеку наличными в рублях (1031)	Float
ECashSum	Сумма по чеку безналичными в рублях (1081)	Float
PrepaymentSum	Сумма по чеку в рублях предоплатой (зачетом аванса и (или) предыдущих платежей) (1215)	Float
PostpaymentSum	Сумма по чеку в рублях постоплатой (в кредит) (1216)	Float
OtherPaymentTypeSum	Сумма по чеку в рублях встречным предоставлением (1217)	Float
TaxNSum	Сумма НДС, где N — число от 1 до 12 (например, `Tax6Sum`). Нужно указать хотя бы одно из значений ниже. Десятичное число с точностью до 2 цифр после точки	Float Mandatory
Tax1Sum	Сумма НДС чека в рублях по ставке 22% (1102)	Float
Tax2Sum	Сумма НДС чека в рублях по ставке 10% (1103)	Float
Tax3Sum	Сумма расчета в рублях по чеку с НДС по ставке 0% (1104)	Float
Tax4Sum	Сумма расчета в рублях по чеку без НДС (1105)	Float
Tax5Sum	Сумма НДС чека в рублях по расч. ставке 22/122 (1106)	Float
Tax6Sum	Сумма НДС чека в рублях по расч. ставке 10/110 (1107)	Float
Tax7Sum	Сумма НДС чека в рублях по ставке 5%	Float
Tax8Sum	Сумма НДС чека в рублях по ставке 7%	Float
Tax9Sum	Сумма НДС чека в рублях по расч. ставке 5/105	Float
Tax10Sum	Сумма НДС чека в рублях по расч. ставке 7/107	Float
Tax11Sum	Сумма НДС чека в рублях по расч. ставке 20	Float
Tax12Sum	Сумма НДС чека в рублях по расч. ставке 20/120	Float

Ответ

Параметр	Описание	Формат
Success	Признак успешности выполнения операции в платежном шлюзе. Принимает значения: `true` — операция успешна `false` — операция неуспешна	Boolean Mandatory
ErrCode	Код ошибки платежного шлюза	String Mandatory
Status	Статус чека. См. статусы чеков	String Mandatory
ErrMessages	Сообщения об ошибках, полученные от сервиса онлайн-касс Передаются, если получены от сервиса онлайн-касс	Array of strings Optional

Пример успешного ответа [JSON]:

{ 
  "Success":true,
  "ErrCode":"NONE",
  "ErrMessages":null,
  "Status":"Accepted"
}

Пример ответа при получении ошибки от сервиса онлайн-касс [JSON]:

{
  "Success":true,
  "ErrCode":"NONE",
  "ErrMessages":[
    "Отсутсвует поле 'CauseDocumentNumber'"
  ],
  "Status":"BadRequest"
}

CreateCorrection

Запрос

Состав Body

Состав Body.Content

Ответ

Содержание