Общие

Response

Поле	Тип	Описание
OperationState	OperationState	Статус выполнения операции.
OperationId	GUID	Идентификатор операции.
EshopId	INT	Номер магазина.
Result	OBJECT	Результат выполнения запроса. Зависит от типа запроса.

OperationState

Поле	Тип	Описание
Code	INT	Код статуса выполнения операции.
Desc	STRING	Описание кода статуса выполнения запроса.

CodeState

Код ошибки	Описание
0	Успешно обработан.
1	В процессе выполнения.
2	Ошибка.

UserTokenData

Поле	Тип	Описание
State	RequestState	Статусы выполнения запросов.
UserToken	STRING	Ключ доступа клиента к API.

AccountInfoData

Поле	Тип	Описание
AccountId	LONG	Номер счета.
Balance	DECIMAL	Состояние баланса.
Currency	Currency	Валюта.

Currency

Название	Описание
RUB и RUR	Валюта для тестовых платежей.
USD	Американский доллар.
EUR	Валюта Евросоюза.

Статусы запросов (RequestState)

Код ошибки	Описание
0	Успешно обработан.
1	Обработан с предупреждениями.
2	Аутентификация не пройдена.

Тип сортировки счетов (SortOrderList)

OrderList	Числовое представление	Описание	Пояснение
Amount	4	По сумме	Сортирует счета по сумме, сортировка по возрастанию.
ChangeDate	2	По дате изменения	Сортирует счета по дате изменения, сортировка по возрастанию.
CreationDate	1	По дате создания	Сортирует счета по дате создания, сортировка по возрастанию.
InvoiceState	3	По состоянию счета	Сортирует счета по состоянию счета.
None	0	Не задан	Сортировка по умолчанию, равносильно не передаче параметра , сортирует по дате создания.

InvoicesHistoryList

Поле	Тип	Описание
State	RequestState	Статусы выполнения запросов.
InvoicesHistoryList	List<InvoiceData>	Список (реестр) платежей.

InvoiceData

Поле	Тип	Описание
Id	LONG	Номер СКО.
State	InvoiceState	Статус состояния СКО.
CreationDate	DateTime	Дата создания СКО
ChangeDate	DateTime	Дата последних изменений СКО.
Amount	Money	Сумма СКО с учётом комиссии.
CurrentAmount	Money	Внесенная частично на СКО сумма. Имеет положительное значение для статусов "Частично оплачен" и "В процессе обработки". Для оплаченного или захолдированного счета значение равно 0.
SurchargeAmount	Money	Сумма СКО, которую осталось оплатить. Имеет положительное значение для статуса "Частично оплачен". Для оплаченного или захолдированного счета значение равно 0.
Comment	STRING	Комментарий к платежу.
EshopId	LONG	Номер магазина.
PurchaseOrderId	STRING	Номер покупки.
HistoryList	List<HistoryData>	Список транзакций по СКО.

Статусы состояния СКО (InvoiceState)

InvoiceState	Числовое представление	Описание	Пояснение
Created	0	Создан	Счёт к оплате создан и теперь его состояние можно отслеживать методом getPurchaseInfo(). Никаких платёжных операций не производилось.
PartPaid	1	Частично оплачен	Пользователь (Покупатель), внес часть средств. Пользователю (Покупателю) надо внести оставшуюся часть суммы.
Paid	2	Полностью оплачен	Пользователь внес всю сумму.
ToPaid	3	В процессе обработки	Над денежными средствами производятся действия.
Refund	4	Возврат	Средства будут возвращены Пользователю (Покупателю).
Held	6	Захолдирован	Средства заморожены (захолдированы/ holded) на счёте Пользователя (Покупателя). Данные средства будут зачислены или расхолдированы (вернуться Пользователю) по истечению времени заморозки (холдирования) или пока не будут зачислены вручную. Поведение денежных средств определяется в настройках магазина на вкладке "Приём платежей" в разделе "Расширенные настройки".

HistoryData

Поле	Тип	Описание
Id	long	Идентификатор транзакции в системе ИнтеллектМани (для внутреннего использования).
PaymentNumber	long	Номер транзакции.
State	TransactionState	Статус транзакции.
CreationDate	DateTime	Дата создания транзакции.
PaymentAmount	Money	Сумма списания по транзакции.
RecipientAmount	Money	Сумма зачисления по транзакции.
PaymentAccount	STRING	Счет списания по транзакции.
RecipientAccount	STRING	Счет зачисления по транзакции.
Comment	STRING	Комментарий к транзакции.
Description	STRING	Описание транзакции.
InvoicePaymentType	PaymentType	Тип осуществляемой транзакции: пополнение, зачисление или возврат.
RcCode	STRING	Код ответа банка, принимающего платеж.
RcCodeUserDescription	STRING	Описание ответа банка, принимающего платеж.

PaymentType

PaymentType	Описание	Пояснение
Entry	Входная транзакция	Транзакция пополнения СКО.
Purchase	Транзакция зачисления	Транзакция пополнения счета магазина.
Refund	Транзакция возврата	Транзакция возврата со счета магазина на счет плательщика.

Статусы платежной транзакции

TransactionState	Числовое представление	Описание	Пояснение
Created	0	Создана	Платежная транзакция создана и еще не проведена.
Confirm	1	Подтверждена	Платежная транзакция подтверждена.
Canceled	2	Отменена	Платежная транзакция отменена.

PaymentsHistoryList

Поле	Тип	Описание
State	RequestState	Статусы выполнения запросов.
InvoicesHistoryList	List<HistoryData>	Список транзакций.

EshopInfoDataList

Поле	Тип	Описание
State	RequestState	Статусы выполнения запросов.
EshopInfoDatas	EshopInfoData	Информация по магазину.

EshopInfoData

Поле	Тип	Описание
Organization	OrganizationInfo	Краткая информация об организации
Eshop	EshopInfo	Информация по магазину.
Bank	BankInfo	Информация о банке.

OrganizationInfo

Поле	Тип	Описание
OrganizationName	STRING	Название организации.
OrganizationLogin	STRING	Логин для входа в организацию.
OrganizationId	INT	Уникальный идентификатор организации.
Email	STRING	Email контактного лица.

EshopInfo

Поле	Тип	Описание
EshopId	INT	Номер магазина.
EshopName	STRING	Название магазина.
Protocol	STRING	Протокол интеграции (IMProtocol).
SecretKey	STRING	Логин для входа в организацию.
ResultUrl	STRING	URL для уведомлений о смене статуса платежа.

BankInfo

Поле	Тип	Описание
AccountNumber	STRING	Номер расчётного счёта.
RecipientName	STRING	Наименование получателя.
Name	STRING	Название банка.
OKPO	STRING	ОКПО банка.
CorrespondentAccountNumber	STRING	Корреспондентский счет банка.
City	STRING	Город банка.
Address	STRING	Адрес банка.
BIK	STRING	БИК банка.

InvoiceInfoData

Поле	Тип	Описание
State	RequestState	Статусы выполнения запросов.
Eshop	EshopInfo	Информация по магазину.
Organization	OrganizaitonInfo	Краткая информация об организации.
ListNotificationParams	NotificationParamsData	Список параметров, переданный на ResultURL.
InvoiceId	INT	Номер СКО.

OrganizaitonInfo

Поле	Тип	Описание
OrganizationId	INT	Номер организации.
OrganizationName	STRING	Название организации.
Email	STRING	Email контактного лица.
OrganizationLogin	STRING	Логин для входа в организацию.

NotificationParamsData

Поле	Тип	Описание
CreationDate	DateTime	Дата создания запроса.
NotificationParams	STRING	Список переданных параметров.

CashboxReceiptCreateData

Поле	Тип	Описание
DocumentId	STRING	Идентификатор чека.
CashBoxReceiptResponseData	CashBoxReceiptResponseData	Ответ от OrangeData.

CashBoxReceiptResponseData

Поле	Тип	Описание
ReceiptResponseId	INT	Идентификатор ответа в системе IntellectMoney.
ReceiptId	INT	Идентификатор чека в системе IntellectMoney.
Response	STRING	Ответ от OrangeData.
Id	STRING	Идентификатор документа.
DeviceSN	STRING	Заводской номер устройства пробившего чек.
DeviceRN	STRING	Регистрационный номер устройства пробившего чек.
FSNumber	STRING	Номер фискального накопителя.
OFDName	STRING	Наименование ОФД.
OFDInn	STRING	ИНН ОФД.
OFDWebsite	STRING	Web-сайт ОФД.
FNSWebsite	STRING	Web-сайт ФНС.
CompanyInn	STRING	ИНН пользователя.
CompanyName	STRING	Наименование пользователя.
DocumentNumber	INT	Номер ФД.
ShiftNumber	INT	Номер смены.
DocumentIndex	INT	Номер чека за смену.
ProcessedAt	DateTime	Время регистрации фискального документа в ФН.
Content	CashboxReceiptContentData	Содержимое документа.
Change	DECIMAL	Сдача.
FP	STRING	Фискальный признак.
ResponseState	ReceiptResponseStateEnum	Статус чека.
Errors	List	Список ошибок.

CashboxReceiptContentData

Поле	Тип	Описание
Type	ReceiptDocTypeEnum	Тип документа.
Positions	List<CashboxReceiptPositionData>	Список позиций в чеке
CheckClose	CashboxReceiptCheckCloseData	Параметры закрытия чека
CustomerContact	TEXT	Телефон или e-mail покупателя.
AgentType	TEXT	Признак агента.

Статус чека (ReceiptResponseStateEnum)

ReceiptResponseStateEnum	Числовое представление	Описание
None	0	Нет статуса.
Created	1	Чек создан и добавлен в очередь на обработку, пустое тело ответа.
Ok	2	Чек обработан, есть тело.
BadRequest	3	Клиентский сертификат не прошел проверку.
Conflict	4	Чек с данным идентификатором уже был создан в системе, пустое тело ответа.
Accepted	5	Чек создан и добавлен в очередь на обработку, но еще не обработан, пустое тело ответа.
NotFound	6	Чек с указанным идентификатором не найден в системе, пустое тело ответа.
Unauthorized	7	Клиентский сертификат не прошел проверку.
ServerErrorRetryLater	8	Сервер недоступен или внутренняя ошибка сервера.
ServiceUnavailable	9	Очередь документов переполнена.
UnsupportedResponseFormat	10	Ответ сервера не удалось распознать.
HttpRequestError	11	Ошибка отправки http запроса (например разрыв соединения).

CashboxReceiptPositionData

Поле	Тип	Описание
ReceiptPositionId	INT	Идентификатор позиции в чеке в системе IntellectMoney.
ReceiptId	INT	Идентификатор чека в системе IntellectMoney.
Quantity	DECIMAL	Количество товара.
Price	DECIMAL	Цена товара с учетом всех скидок и наценок.
Tax	ReceiptVatRateEnum	Ставка НДС.
PaymentSubjectType	ReceiptPaymentSubjectTypeEnum	Предмет расчета.
PaymentMethodType	ReceiptPaymentMethodTypeEnum	Способ расчета.
TEXT	STRING	Текст позиции.

CashboxReceiptCheckCloseData

Поле	Тип	Описание
Payments	CashboxReceiptPaymentData	Оплаты.
TaxationSystem	ReceiptTaxationSystemEnum	Система налогообложения.

Оплата(CashboxReceiptPaymentData)

Поле	Тип	Описание
ReceiptPaymentId	INT	Идентификатор оплаты в системе IntellectMoney.
ReceiptId	INT	Идентификатор чека в системе IntellectMoney.
Type	ReceiptPaymentTypeEnum	Тип оплаты
Amount	DECIMAL	Сумма оплаты.

Тип оплаты (ReceiptPaymentTypeEnum)

ReceiptPaymentTypeEnum	Числовое представление	Описание
Cash	1	Сумма по чеку наличными.
Electronic	2	Сумма по чеку электронными.
Advance	14	Сумма по чеку предоплатой.
Credit	15	Сумма по чеку постоплатой.
Other	16	Сумма по чеку встречным предоставлением.

Система налогообложения (ReceiptTaxationSystemEnum)

ReceiptTaxationSystemEnum	Числовое представление	Описание
Common	0	Общая.
Simplified	1	Упрощенная доход, УСН доход. Автоматизированная упрощённая, АУСН
SimplifiedMinusOutlay	2	Упрощенная доход минус расход, УСН доход - расход.
UnifiedImputedIncome	3	Единый налог на вмененный доход.
UnifiedAgricultural	4	Единый сельскохозяйственный налог.
Patent	5	Патентная система налогообложения.
SelfEmployed	6	Налог на профессиональный доход.

Ставка НДС (ReceiptVatRateEnum)

ReceiptVatRateEnum	Числовое представление	Описание
Vat20	1	Ставка НДС 20%.
Vat10	2	Ставка НДС 10%.
Vat120	3	Ставка НДС расч. 20/120.
Vat110	4	Ставка НДС расч. 10/110.
Vat0	5	Ставка НДС 0%.
None	6	НДС не облагается.
Vat5	7	Ставка НДС 5%.
Vat7	8	Ставка НДС 7% .
Vat105	9	Ставка НДС расч. 5/105.
Vat107	10	Ставка НДС расч. 7/107.

Предмет расчёта (ReceiptPaymentSubjectTypeEnum)

ReceiptPaymentSubjectTypeEnum	Числовое представление	Описание
Product	1	Товар.
Excisable	2	Подакцизный товар.
Job	3	Работа.
Service	4	Услуга.
GamblingBet	5	Ставка азартной игры.
GamblingGain	6	Выигрыш азартной игры.
LotteryTicket	7	Лотерейный билет.
LotteryWinnings	8	Выигрыш лотереи.
Rid	9	Предоставление РИД.
Payment	10	Платёж.
AgentComission	11	Агентское вознаграждение.
Composite	12	Составной предмет расчета.
Other	13	Иной предмет расчета.
PropertyRight	14	Имущественное право.
NonOperatingGain	15	Внереализационный доход.
InsurancePremium	16	Иные платежи и взносы.
SalesTax	17	Торговый сбор.
ResortFee	18	Курортный сбор.
Pledge	19	Залог.
Expense	20	Расход.
PensionInsuranceIndividualEntrepreneurs	21	Взносы на обязательное пенсионное страхование ИП.
PensionInsurance	22	Взносы на обязательное пенсионное страхование.
MedicalInsuranceIndividualEntrepreneurs	23	Взносы на обязательное медицинское страхование ИП.
MedicalInsurance	24	Взносы на обязательное медицинское страхование.
SocialInsurance	25	Взносы на обязательное социальное страхование.
CasinoPayment	26	Платеж казино.
DisbursementOfFunds	27	Выдача денежных средств.
ATNM	30	АТНМ (не имеющем кода маркировки).
ATM	31	АТМ (имеющем код маркировки).
TNM	32	ТНМ.
TM	33	ТМ.

Способ расчета (ReceiptPaymentMethodTypeEnum)

ReceiptPaymentMethodTypeEnum	Числовое представление	Описание
Prepay	1	Предоплата 100%.
PartialPrepay	2	Частичная предоплата.
Advance	3	Аванс.
Full	4	Полный расчёт.
PartialAndCredit	5	Частичный расчёт и кредит.
CreditTransfer	6	Передача в кредит.
CreditPayment	7	Оплата кредита.

Система налогообложения (ReceiptTaxationSystemEnum)

ReceiptTaxationSystemEnum	Числовое представление	Описание
Common	0	Общая.
Simplified	1	Упрощенная доход, УСН доход. Автоматизированная упрощённая, АУСН.
SimplifiedMinusOutlay	2	Упрощенная доход минус расход, УСН доход - расход.
UnifiedImputedIncome	3	Единый налог на вмененный доход.
UnifiedAgricultural	4	Единый сельскохозяйственный налог.
Patent	5	Патентная система налогообложения.
SelfEmployed	6	Налог на профессиональный доход.

CashboxReceiptCorrectionResponseData

Поле	Тип	Описание
id	Идентификатор документа	Строка от 1 до 64 символов.
deviceSN	Заводской номер устройства пробившего чек	Строка до 20 символов.
deviceRN	Регистрационный номер устройства пробившего чек	Строка до 20 символов.
fsNumber	Номер фискального накопителя	Строка 16 символов.
ofdName	Наименование ОФД	Строка до 256 символов.
odfWebsite	Web-сайт ОФД	Строка до 58 символов.
odfINN	ИНН ОФД	Строка 12 символов.
fnsWebsite	Web-сайт ФНС	Строка до 256 символов.
companyINN	ИНН пользователя	Строка 12 символов.
companyName	Наименование пользователя	Строка до 256 символов.
documentNumber	Номер ФД	Число.
shiftNumber	Номер смены	Число.
documentIndex	Номер чека за смену	Число.
processedAt	Время регистрации фискального документа в ФН	Время в виде строки в формате ISO8601.
content	Содержимое документа	Структура п.2.1.1.1.
fp	Фискальный признак	Строка 10 символов.
callbackUrl	URL для отправки результатов обработки чека POST запросом	Строка от 1 до 1024 символов или null.

TransactionInfoData

Поле	Тип	Описание
TransactionId	long	Номер транзакции.
PaymentState	PaymentTransactionState	Статус транзакции
Amount	DECIMAL	Сумма транзакции.
Currency	Currency	Валюта операции.

Статусы платежной транзакции(PaymentTransactionState)

TransactionState	Числовое представление	Описание	Пояснение
Created	0	Создана	Платежная транзакция создана и еще не проведена.
Confirm	1	Подтверждена	Платежная транзакция подтверждена.
Canceled	2	Отменена	Платежная транзакция отменена.

RegisterOrganizationData

Поле	Тип	Описание
RequestId	STRING	ID заявки на регистрацию (в системе поставщика).
FirstName	STRING	Имя владельца организации.
ContactPhone	STRING	Контактный номер.
Email	STRING	Контактный e-mail.
LeadSource	STRING	Источник регистрации.
Inn	STRING	ИНН.
InviteCode	STRING	Промо-код.
UTMParams	UTMParamsData	UTM-метки.
LeadComment	STRING	Комментарий поставщика.
LeadAttractor	STRING	Привлеченец (ФИО менеджера).
Password	STRING	Пароль от личного кабинета.

UTMParamsData

Поле	Тип	Описание
utm_source	STRING	Сайт, с которого направляется трафик.
utm_medium	STRING	Рекламная модель.
utm_campaign	STRING	Рекламная кампания.
utm_term	STRING	Ключевая фраза из рекламной кампании.
utm_content	STRING	Конкретный элемент, на который кликнул пользователь.

SetScheduledOperationData

Поле	Тип	Описание
State	RequestState	Статусы выполнения запросов.
ScheduledOperationList	List<ScheduledOperationData>	Список операций, подходящих под заданный фильтр.

ScheduledOperationData

Поле	Тип	Описание
CronOperationId	GUID	Номер операции. Используется для редактирования операции, если не передать — создается новая операция (GUID).
ObjectId	LONG	Объект источник, например: SourceInvoiceId - для операции рекарринга (Номер Счёта К Оплате).
CronOperationType	TINYINT	Тип регулярной операции (1 - Recurring).
Params	TEXT	Дополнительные параметры в формате JSON, например: { "Amount": 10 }.
CreationDate	DateTime	Дата создания операции.
ChangeDate	DateTime	Дата последнего внесения изменений.
EndExecDate	DateTime	Дата окончания выполнения операции.
LastExecDate	DateTime	Дата последнего выполнения операции.
NextExecDate	DateTime	Дата следующего выполнения операции.
RepeatPlan	TEXT	Периодичность (регулярность) выполнения операции. Может указываться в двух вариантах: - Cron expressions: Например, запуск каждый день в 12 часов: 0 0 12 1/1 * ? *. - JSON: Пример: { "StartAt": "2023-11-22T18:50:00+03:00", "PeriodLength": 30, "PeriodType": "Day" }. Допустимые значения PeriodType: Day, Week, Month.
RetryOnFailPlan	TEXT	Периодичность повторных попыток выполнения операции при ошибке. Может указываться в двух вариантах: - Cron expressions: Например, каждые 5 минут: 0 0/5 * 1/1 * ? *. - JSON: Пример: { "PeriodLength": 5, "PeriodType": "Minute" }. Допустимые значения PeriodType: Minute, Hour, Day, Week, Month.
RetryOnFailCount	TEXT	Количество повторных попыток выполнения (целое число). Если операцию не удалось выполнить с первого раза, она будет повторяться с периодичностью, указанной в параметре RetryOnFailPlan, но не более RetryOnFailCount раз.
IsSingle	BOOL	Флаг, указывающий возможность запуска параллельных тасков: - 0: Один поток, операция не будет запущена пока не закончена предыдущая. - 1: Неограниченное количество потоков, операции запускаются независимо от статуса предыдущей.
FireOnSkip	BOOL	Флаг, указывающий необходимость создания всех запланированных задач в случае их непредвиденного пропуска (0 или 1).
CronOperationState	CronOperationState	Флаг, указывающий статус активности: - Active: Активен. - Disable: Выключен.

GetScheduledOperationData

Поле	Тип	Описание
State	RequestState	Статусы выполнения запросов.
ScheduledOperationList	List<ScheduledOperationData>	Список операций, подходящих под заданный фильтр.

DeactivateData

DeactivateData

В качестве ответа возвращается тип Boolean: true или false

Money

Поле	Тип	Описание
Amount	DECIMAL	Сумма.
Currency	Currency	Валюта.

Currency

Название	Описание
RUB и RUR	Валюта для тестовых платежей.
USD	Американский доллар.
EUR	Валюта Евросоюза.