createReceiptCorrection
Описание
Запрос на создание чека коррекции в OrangeData
POST (Уровень доступа: Базовый)
Заголовки запроса
| Параметр | Свойства | Описание |
|---|---|---|
Accept |
STRING OPTIONAL application/json | Заголовок, указывающий формат данных, которые клиент хочет получить от сервера. |
Content-Type |
STRING OPTIONAL application/json application/xml | Заголовок, указывающий формат данных в теле запроса. |
Authorization |
STRING REQUIRED Bearer {token} | Заголовок, используемый для аутентификации клиента с помощью Bearer токена. Подробнее об использование Bearer токена. |
Sign |
STRING REQUIRED | Заголовок с подписью для аутентификации запроса. Сигнатура подписи: `` |
Тело запроса
| Параметр | Свойства | Описание |
|---|---|---|
UserToken |
Ключ доступа STRING REQUIRED |
Ключ доступа клиента к API, запрашиваемый операцией аутентификации клиента GetUserToken |
InvoiceId |
Номер СКО INT 3********* REQUIRED |
Запрос информации только по одному СКО по его номеру |
DocumentId |
Идентификатор чека INT REQUIRED |
Идентификатор чека нужно получить из метода CreateReceipt. |
MerchantReceiptCorrection |
Параметры чека коррекции STRING REQUIRED |
Структура чека. |
Тело ответа
| Поле | Тип | Описание |
|---|---|---|
OperationState |
OperationState | Статус выполнения операции. |
OperationId |
GUID | Идентификатор операции. |
EshopId |
INT | Номер магазина. |
Result |
CashboxReceiptCorrectionResponseData | Результат выполнения запроса. |
Примеры кода
C#
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.intellectmoney.ru/personal/cashBox/createReceiptCorrection");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Content-Type", "application/json");
request.Headers.Add("Authorization", "Bearer e801b9fd828147f09c0699e4b831606e");
request.Headers.Add("Sign", "ee6b71c6c54ec9b3c02d1a8bceb535b846640e4164d758489d571ffe029070af");
var collection = new List<KeyValuePair<string, string>>();
collection.Add(new("UserToken", "YdUlqkFcVo62XmY6B9VLJWyeShIJieHm33dTjw04DnqmkdLcjekbDdSYFkk7RjrO"));
collection.Add(new("InvoiceId", "3440917295"));
collection.Add(new("DocumentId", "63ca44e02c204d8dbc09fa49c3131ea3"));
collection.Add(new("MerchantReceiptCorrection", "{ "inn": "7743736523", "group": "Main_2", "content": { "CorrectionType": 0, "Type": 1, "Description": "Коррекция прихода", "CauseDocumentDate": "2025-02-11T14:00:00", "CauseDocumentNumber": "№1", "TotalSum": 10.0, "TaxationSystem": 1 }}"));
var content = new FormUrlEncodedContent(collection);
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.intellectmoney.ru/personal/cashBox/createReceiptCorrection',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'UserToken=YdUlqkFcVo62XmY6B9VLJWyeShIJieHm33dTjw04DnqmkdLcjekbDdSYFkk7RjrO&InvoiceId=3440917295&DocumentId=63ca44e02c204d8dbc09fa49c3131ea3&MerchantReceiptCorrection={ "inn": "7743736523", "group": "Main_2", "content": { "CorrectionType": 0, "Type": 1, "Description": "Коррекция прихода", "CauseDocumentDate": "2025-02-11T14:00:00", "CauseDocumentNumber": "№1", "TotalSum": 10.0, "TaxationSystem": 1 }}',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Content-Type: application/json',
'Authorization: Bearer e801b9fd828147f09c0699e4b831606e',
'Sign: ee6b71c6c54ec9b3c02d1a8bceb535b846640e4164d758489d571ffe029070af',
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Пример ответов
JSON
{
"OperationState": {
"Code": 0,
"Desc": "Успешно обработана"
},
"Result": {
"State": {
"Code": 0,
"Desc": "Успешно обработан"
},
"CashboxReceiptResponseData": {
"ReceiptId": 5580144,
"Response": "{\n \"id\": \"7e1f3806b1e148fc886ff5518484fe80\",\n \"deviceSN\": \"0060610038023373\",\n \"deviceRN\": \"0007517388016570\",\n \"fsNumber\": \"7380440801375198\",\n \"ofdName\": \"Такском\",\n \"ofdWebsite\": \"www.taxcom.ru\",\n \"ofdinn\": \"7704211201\",\n \"fnsWebsite\": \"www.nalog.gov.ru\",\n \"companyINN\": \"7743736523\",\n \"companyName\": \"ООО \\\"ИНТЕЛЛЕКТМАНИ\\\"\",\n \"documentNumber\": 18214,\n \"shiftNumber\": 58,\n \"documentIndex\": 392,\n \"processedAt\": \"2025-02-11T12:14:00\",\n \"processedAtTz\": \"2025-02-11T12:14:00.0000000+03:00\",\n \"content\": {\n \"type\": 1,\n \"positions\": [\n {\n \"quantity\": 1.000,\n \"price\": 1.0,\n \"tax\": 6,\n \"text\": \"Булка\"\n }\n ],\n \"checkClose\": {\n \"payments\": [\n {\n \"type\": 2,\n \"amount\": 1.00\n }\n ],\n \"taxationSystem\": 0\n },\n \"customerContact\": \"foo@example.com\",\n \"ffdVersion\": 4\n },\n \"change\": 0.0,\n \"fp\": \"2396636946\"\n}",
"Id": "7e1f3806b1e148fc886ff5518484fe80",
"DeviceSN": "0060610038023373",
"DeviceRN": "0007517388016570",
"FSNumber": "7380440801375198",
"OFDName": "Такском",
"OFDInn": "7704211201",
"OFDWebsite": "www.taxcom.ru",
"FNSWebsite": "www.nalog.gov.ru",
"CompanyINN": "7743736523",
"CompanyName": "ООО \"ИНТЕЛЛЕКТМАНИ\"",
"DocumentNumber": "18214",
"ShiftNumber": 58,
"DocumentIndex": 392,
"ProcessedAt": "2025-02-11T12:14:00+03:00",
"Content": {
"FFDVersion": 4,
"Type": "In",
"Positions": [
{
"Quantity": 1.0,
"Price": 1.0,
"Tax": "None",
"Text": "Булка"
}
],
"CheckClose": {
"Payments": [
{
"Type": "Electronic",
"Amount": 1.0
}
],
"TaxationSystem": "Common"
},
"CustomerContact": "foo@example.com"
},
"Change": 0.0,
"FP": "2396636946",
"ResponseState": "Ok",
"Errors": []
}
}
}
JSON
{
"OperationState": {
"Code": 0,
"Desc": "Успешно обработана"
},
"Result": {
"State": {
"Code": 0,
"Desc": "Успешно обработан"
},
"DocumentId": "b35f2d979ee0488b96b2c6a9a9ed9f74",
"CashboxReceiptResponseData": {
"ReceiptId": 0,
"Response": "{\"errors\": [\"Сервер недоступен 500\"]}",
"ResponseState": "ServerErrorRetryLater",
"Errors": [
"Сервер недоступен 500"
]
}
}
}