Получение списка СКО
Описание
Используется для получения списка СКО.
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::Skip::Take::EshopId::InvoiceId::DateFrom::DateTo::ChangeDateFrom::ChangeDateTo::IncludePaymentTransactions::IsHoldingSearch::OrganizationId::OwnerEmail::WithRefunds::SignSecretKey |
Тело запроса
| Параметр | Свойства | Описание |
|---|---|---|
UserToken |
STRING REQUIRED | Токен-пользователя. Для получения использовать метод GetUserToken. |
Skip |
STRING OPTIONAL number | Количество пропускаемых объектов. Для значения 10, пропустит первые 10 записей и начнет вывод с 11-й записи (нумерация начинается с 0). |
Take |
STRING REQUIRED number | Количество возвращаемых объектов. Для значения 10, пропустит первые Skip записей и выведет 10 элементов. |
EshopId |
STRING OPTIONAL max 6 | Номер магазина. Можно найти в личном кабинете, в разделе магазины. |
State |
STRING OPTIONAL const | Статус СКО. Допустимые значения:
|
InvoiceId |
STRING OPTIONAL 3xxxxxxxxx | Номер СКО. |
DateFrom |
STRING OPTIONAL yyyy-MM-dd HH:mm:ss |
Дата начала выборки. |
DateTo |
STRING OPTIONAL yyyy-MM-dd HH:mm:ss |
Дата окончания выборки. |
ChangeDateFrom |
STRING OPTIONAL yyyy-MM-dd HH:mm:ss |
Дата начала выборки на основании даты изменения СКО. |
ChangeDateTo |
STRING OPTIONAL yyyy-MM-dd HH:mm:ss |
Дата окончания выборки на основании даты изменения СКО. |
IncludePaymentTransactions |
STRING OPTIONAL boolean | Флаг, добавляющий транзакции в выборку. Допустимые значения:
|
SortOrder |
INT OPTIONAL 0-4 | Порядок сортировки. Допустимые значения:
|
IsHoldingSearch |
STRING OPTIONAL boolean | Флаг, указывающий поиск по организациям холдинга. Допустимые значения:
|
OrganizationId |
STRING OPTIONAL max 5 | Номер организации. Можно найти в личном кабинете на главной странице. |
OwnerEmail |
STRING OPTIONAL max 100 | Электронная почта покупателя. |
WithRefunds |
STRING OPTIONAL boolean | Флаг, фильтрации по возвратам. Допустимые значения:
|
Тело ответа
| Поле | Тип | Описание |
|---|---|---|
OperationState |
OperationState | Статус выполнения операции. |
OperationId |
GUID | Идентификатор операции. |
EshopId |
INT | Номер магазина. |
Result |
InvoicesHistoryList | Результат выполнения запроса. |
Примеры кода
C#
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.intellectmoney.ru/personal/payment/getInvoicesHistory");
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", "YdUlqkFcVo62XmY6B9VLJfwUODqE9ODk8/q/s1uXguWmiiPUo+R8YpiYt6g/s/IM"));
collection.Add(new("Take", "5"));
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/payment/getInvoicesHistory',
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=YdUlqkFcVo62XmY6B9VLJfwUODqE9ODk8/q/s1uXguWmiiPUo+R8YpiYt6g/s/IM&Take=5',
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": "Успешно обработан"
},
"InvoicesHistoryList": [
{
"Id": 3000000000,
"State": "Paid",
"HoldModeFlag": false,
"ChangeDate": "2025-01-01T12:00:00.00+03:00",
"CreationDate": "2025-01-01T12:00:00.00+03:00",
"ExpirationDate": "2025-01-01T12:00:00.00+03:00",
"Amount": {
"Amount": 1.0,
"Currency": "RUB"
},
"CurrentAmount": {
"Amount": 0.0,
"Currency": "RUB"
},
"SurchargeAmount": {
"Amount": 0.0,
"Currency": "RUB"
},
"AdditionalInfo": [
{
"Key": "Магазин",
"Value": "Test"
},
{
"Key": "Url",
"Value": "https://test.ru"
}
],
"HistoryList": [
{
"Id": 30000000,
"PaymentNumber": "2000000000",
"State": "Confirm",
"CreationDate": "2025-01-01T12:00:00.00+00:00",
"PaymentAmount": {
"Amount": 1.0,
"Currency": "RUB"
},
"RecipientAmount": {
"Amount": 0.96,
"Currency": "RUB"
},
"PaymentAccount": "Счет к оплате 3000000000",
"RecipientAccount": "6000000000",
"Account": "3000000000",
"Description": "Зачисление на счет магазина \"Магазин\" со счета \"3000000000\"",
"Direction": "Withdraw",
"PurchaseOrderId": "Номер заказа",
"AdditionalInfo": [],
"InvoicePaymentType": "Purchase",
"InvoiceId": 3000000000,
"IsElectedPayment": false,
"CatalogPaymentId": 0,
"InputType": "Acquiring",
"ShortPan": "",
"Country": "",
"Bank": "",
"IPAdress": "",
"UserEmail": "test@mail.ru",
"CardHolder": "",
"Comission": 0.035,
"EshopName": "Магазин (450000)"
}
],
"OwnerEmail": "test@mail.ru",
"OwnerFIO": " ",
"PurchaseOrderId": "Test",
"UserId": 0,
"PassthroughModeFlag": false,
"EShopId": 450000,
"HttpRequestErrorCount": 0,
"HttpRequests": [],
"Rrn": "5000000000",
"PurchaseData": {
"Id": 900000,
"PurchaseMoney": {
"Amount": 1.0,
"Currency": "RUB"
},
"OrderId": "2025-01-01T12:00:00.00+00:00",
"BackUrl": "https://test.ru",
"UserFields": "",
"Invoice": {
"Id": 3000000000,
"State": "Created",
"HoldModeFlag": false,
"ChangeDate": "2025-01-01T12:00:00.00+03:00",
"CreationDate": "2025-01-01T12:00:00.00+03:00",
"ExpirationDate": "2025-01-01T12:00:00.00+03:00",
"AdditionalInfo": [],
"HistoryList": [],
"PaymentTransactions": [],
"UserId": 0,
"PassthroughModeFlag": false,
"EShopId": 0,
"HttpRequestErrorCount": 0,
"HttpRequests": [],
"PurchaseData": {
"Id": 0,
"EshopId": 0,
"SMSEnable": true,
"IsHeldByEshop": false
},
"IsCanEnrollmentByDisabledMethod": false,
"InvoiceChangeAmountHistoryData": [],
"IsHaveCashboxReceipts": false,
"ReceiptVatRate": [],
"IsRecurrent": false
},
"EshopId": 450000,
"EshopUrl": "https://test.ru",
"EshopName": "Магазин",
"SMSEnable": true,
"UserEmail": "test@mail.ru",
"IsHeldByEshop": false,
"ParseUserFields": []
},
"IsCanEnrollmentByDisabledMethod": false,
"InvoiceChangeAmountHistoryData": [],
"OriginalAmount": {
"Amount": 1.0,
"Currency": "RUB"
},
"FormType": "None",
"OrganizationName": "Test",
"MerchantReceipt": "{\"Inn\":\"5000000000\",\"ReceiptState\":0,\"Content\":{\"Type\":1,\"Positions\":[{\"Quantity\":1.00,\"Price\":1.00,\"Tax\":9,\"Text\":\"Товар\"}],\"CheckClose\":{\"Payments\":[],\"TaxationSystem\":255},\"CustomerContact\":\"test@mail.ru\"}}",
"IsHaveCashboxReceipts": true,
"ReceiptVatRate": [
{
"Key": "1",
"Value": "20%"
},
{
"Key": "2",
"Value": "10%"
},
{
"Key": "3",
"Value": "расч 20/120"
},
{
"Key": "4",
"Value": "расч 10/110"
},
{
"Key": "5",
"Value": "0%"
},
{
"Key": "6",
"Value": "Не облагается"
},
{
"Key": "7",
"Value": "5%"
},
{
"Key": "8",
"Value": "7%"
},
{
"Key": "9",
"Value": "расч 5/105"
},
{
"Key": "10",
"Value": "расч 7/107"
}
],
"IsRecurrent": false
}
]
}
}