@companix/yookassa 0.0.2 → 0.0.4

package/dist/api/responses/payout.d.ts

@@ -1,65 +1,250 @@
 import type { CommonAmount, CommonDeal2 } from '../common';
 import { BankCardTypeEnum, BasicStatusEnum } from '../enums';
+/**
+ * Объект выплаты
+ *
+ * Объект выплаты (Payout) содержит всю информацию о выплате, актуальную на текущий момент времени. Он формируется при создании выплаты и приходит в ответ на любой запрос, связанный с выплатами.
+ *
+ * Набор возвращаемых параметров зависит от статуса объекта (значение параметра status) и того, какие параметры вы передали в запросе на создание выплаты.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Объект выплаты (Payout) — актуальная информация о выплате.
+ */
 export interface Payout {
+    /**
+     * Идентификатор выплаты.
+     */
     id: string;
+    /**
+     * Сумма выплаты.
+     */
     amount: CommonAmount;
+    /**
+     * Статус выплаты. Возможные значения:
+     *
+     * pending — выплата создана, но деньги еще не поступили на указанное платежное средство пользователя (например, ЮKassa ждет подтверждения от эквайера, что перевод успешен);
+     *
+     * succeeded — выплата успешно завершена, деньги переведены на платежное средство пользователя (финальный и неизменяемый статус);
+     *
+     * canceled — выплата отменена, инициатор и причина отмены указаны в объекте cancellation_details (финальный и неизменяемый статус).
+     */
     status: BasicStatusEnum;
+    /**
+     * Платежное средство, на которое ЮKassa зачисляет выплату.
+     */
     payout_destination: PayoutPayoutDestination;
+    /**
+     * Описание транзакции (не более 128 символов). Например: «Выплата по договору 37».
+     */
     description?: string;
+    /**
+     * Время создания выплаты. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
+     */
     created_at: string;
+    /**
+     * Время успешного проведения выплаты. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:42.312Z
+     *
+     * Обязательный параметр для выплат в статусе succeeded.
+     */
     succeeded_at?: string;
+    /**
+     * Сделка, в рамках которой нужно провести выплату. Присутствует, если вы проводите Безопасную сделку.
+     */
     deal?: CommonDeal2;
+    /**
+     * Данные самозанятого, который получит выплату.
+     *
+     * Устаревший параметр. Раньше возвращался при проведении выплат самозанятым. Сейчас функциональность недоступна. Параметр сохранен для поддержки обратной совместимости, в новых версиях API может быть удален.
+     */
     self_employed?: PayoutSelfEmployed;
+    /**
+     * Данные чека, зарегистрированного в ФНС.
+     *
+     * Устаревший параметр. Раньше возвращался при проведении выплат самозанятым. Сейчас функциональность недоступна. Параметр сохранен для поддержки обратной совместимости, в новых версиях API может быть удален.
+     */
     receipt?: PayoutReceipt;
+    /**
+     * Комментарий к статусу canceled: кто отменил выплату и по какой причине.
+     */
     cancellation_details?: PayoutCancellationDetails;
+    /**
+     * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
+     */
     metadata?: Record<string, unknown>;
+    /**
+     * Признак тестовой операции.
+     */
     test: boolean;
 }
+/**
+ * Выплаты на банковскую карту
+ */
 export interface PayoutPayoutDestinationBankCard {
+    /**
+     * Код способа получения выплаты.
+     */
     "type": "bank_card";
+    /**
+     * Данные банковской карты.
+     */
     card?: PayoutPayoutDestinationBankCardCard;
 }
+/**
+ * Выплаты на кошелек ЮMoney.
+ */
 export interface PayoutPayoutDestinationYooMoney {
+    /**
+     * Код способа получения выплаты.
+     */
     "type": "yoo_money";
+    /**
+     * Номер кошелька ЮMoney, например 41001614575714. Длина — от 11 до 33 цифр.
+     */
     account_number: string;
 }
+/**
+ * Данные для выплаты через СБП на счет в банке или платежном сервисе.
+ */
 export interface PayoutPayoutDestinationSbp {
+    /**
+     * Код способа получения выплаты.
+     */
     "type": "sbp";
+    /**
+     * Телефон, к которому привязан счет получателя выплаты в системе участника СБП. Указывается в формате ITU-T E.164, например 79000000000.
+     */
     phone: string;
+    /**
+     * Идентификатор участника СБП — банка или платежного сервиса, подключенного к сервису.
+     */
     bank_id: string;
+    /**
+     * Идентификатор операции в СБП (НСПК). Пример: 1027088AE4CB48CB81287833347A8777.
+     *
+     * Обязательный параметр для выплат в статусе succeeded. В остальных случаях может отсутствовать.
+     */
     sbp_operation_id?: string;
+    /**
+     * Проверка получателя выплаты: true — выплата проходила с проверкой получателя, false — выплата проходила без проверки получателя.
+     */
     recipient_checked: boolean;
 }
+/**
+ * Платежное средство, на которое ЮKassa зачисляет выплату.
+ *
+ * Способы получения выплаты
+ */
 export type PayoutPayoutDestination = PayoutPayoutDestinationBankCard | PayoutPayoutDestinationYooMoney | PayoutPayoutDestinationSbp;
+/**
+ * Данные самозанятого, который получит выплату.
+ *
+ * Устаревший параметр. Раньше возвращался при проведении выплат самозанятым. Сейчас функциональность недоступна. Параметр сохранен для поддержки обратной совместимости, в новых версиях API может быть удален.
+ */
 export interface PayoutSelfEmployed {
+    /**
+     * Идентификатор самозанятого в ЮKassa.
+     */
     id: string;
 }
+/**
+ * Данные чека, зарегистрированного в ФНС.
+ *
+ * Устаревший параметр. Раньше возвращался при проведении выплат самозанятым. Сейчас функциональность недоступна. Параметр сохранен для поддержки обратной совместимости, в новых версиях API может быть удален.
+ */
 export interface PayoutReceipt {
+    /**
+     * Описание услуги, оказанной получателем выплаты. Не более 50 символов.
+     */
     service_name: string;
+    /**
+     * Идентификатор чека в сервисе. Пример: 208jd98zqe
+     */
     npd_receipt_id?: string;
+    /**
+     * Ссылка на зарегистрированный чек. Пример: https://www.nalog.gov.ru/api/v1/receipt/<Идентификатор чека>/print
+     */
     url?: string;
+    /**
+     * Сумма, указанная в чеке. Присутствует, если в запросе передавалась сумма для печати в чеке.
+     */
     amount?: CommonAmount;
 }
+/**
+ * Комментарий к статусу canceled: кто отменил выплату и по какой причине.
+ */
 export interface PayoutCancellationDetails {
+    /**
+     * Участник процесса выплаты, который принял решение об отмене транзакции. Перечень инициаторов отмены выплаты: для обычных выплат, для выплат в рамках Безопасной сделки.
+     */
     party: string;
+    /**
+     * Причина отмены выплаты. Перечень и описание возможных значений: для обычных выплат, для выплат в рамках Безопасной сделки.
+     */
     reason: string;
 }
+/**
+ * Данные банковской карты.
+ */
 export interface PayoutPayoutDestinationBankCardCard {
+    /**
+     * Первые 6 цифр номера карты (BIN).
+     */
     first6: string;
+    /**
+     * Последние 4 цифры номера карты.
+     */
     last4: string;
+    /**
+     * Тип банковской карты. Возможные значения: MasterCard (для карт Mastercard и Maestro), Visa (для карт Visa и Visa Electron), Mir, UnionPay, JCB, AmericanExpress, DinersClub, DiscoverCard, InstaPayment, InstaPaymentTM, Laser, Dankort, Solo, Switch и Unknown.
+     */
     card_type: BankCardTypeEnum;
+    /**
+     * Код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2. Пример: RU.
+     */
     issuer_country?: string;
+    /**
+     * Наименование банка, выпустившего карту.
+     */
     issuer_name?: string;
 }
+/**
+ * Создание выплаты
+ *
+ * В ответ на запрос придет объект выплаты в актуальном статусе.
+ */
 export type CreatePayoutResponse = Payout;
+/**
+ * Список выплат
+ *
+ * В ответ на запрос придет список объектов выплат с учетом переданных параметров. В списке будет информация о выплатах, созданных за последние 3 года. Список будет отсортирован по времени создания выплат в порядке убывания.
+ *
+ * Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент.
+ *
+ * Подробнее о работе со списками
+ */
 export interface GetPayoutsListResponse {
     type: "list";
     items: Payout[];
     next_cursor?: string;
 }
+/**
+ * Поиск выплат
+ *
+ * В ответ на запрос придет список объектов выплат с учетом переданных параметров. В списке будет информация о выплатах, созданных за последние 3 месяца. Список будет отсортирован по времени создания выплат в порядке убывания.
+ *
+ * Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент.
+ *
+ * Подробнее о работе со списками
+ */
 export interface GetPayoutsSearchResponse {
     type: "list";
     items: Payout[];
     next_cursor?: string;
 }
+/**
+ * Информация о выплате
+ *
+ * В ответ на запрос придет объект выплаты в актуальном статусе.
+ */
 export type GetPayoutResponse = Payout;

package/dist/api/responses/personal-data.d.ts

@@ -1,16 +1,81 @@
 import { PersonalDataStatusEnum, PersonalDataTypeEnum } from '../enums';
+/**
+ * Объект персональных данных
+ *
+ * Объект персональных данных (PersonalData) содержит актуальную информацию о персональных данных пользователя, сохраненных в ЮKassa. Он формируется при создании персональных данных и приходит в ответ на любой запрос, связанный с персональными данными пользователя.
+ *
+ * Набор возвращаемых параметров зависит от статуса объекта (значение параметра status) и того, какие параметры вы передали в запросе на создание персональных данных.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Объект персональных данных (PersonalData) — актуальная информация о персональных данных пользователя, сохраненных в ЮKassa.
+ */
 export interface PersonalData {
+    /**
+     * Идентификатор персональных данных, сохраненных в ЮKassa.
+     */
     id: string;
+    /**
+     * Тип персональных данных — цель, для которой вы будете использовать данные.
+     *
+     * Возможные значение:
+     *
+     * sbp_payout_recipient — выплаты с проверкой получателя(только для выплат через СБП);
+     *
+     * payout_statement_recipient — выплаты с передачей данных получателя выплаты для выписок из реестра.
+     */
     "type": PersonalDataTypeEnum;
+    /**
+     * Статус персональных данных. Возможные значения:
+     *
+     * waiting_for_operation — данные сохранены, но не использованы при проведении выплаты;
+     *
+     * active — данные сохранены и использованы при проведении выплаты; данные можно использовать повторно до срока, указанного в параметре expires_at;
+     *
+     * canceled — хранение данных отменено, данные удалены, инициатор и причина отмены указаны в объекте cancellation_details (финальный и неизменяемый статус).
+     *
+     * Жизненный цикл персональных данных зависит от назначения данных: передача данных получателя выплаты для выписки из реестра или проверка получателя при выплатах через СБП.
+     */
     status: PersonalDataStatusEnum;
+    /**
+     * Комментарий к статусу canceled: кто и по какой причине аннулировал хранение данных.
+     */
     cancellation_details?: PersonalDataCancellationDetails;
+    /**
+     * Время создания персональных данных. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
+     */
     created_at: string;
+    /**
+     * Срок жизни объекта персональных данных — время, до которого вы можете использовать персональные данные при проведении операций. Указывается только для объекта в статусе active. Указывается по UTC и передается в формате ISO 8601. Пример: 2017-11-03T11:52:31.827Z
+     */
     expires_at?: string;
+    /**
+     * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
+     */
     metadata?: Record<string, unknown>;
 }
+/**
+ * Комментарий к статусу canceled: кто и по какой причине аннулировал хранение данных.
+ */
 export interface PersonalDataCancellationDetails {
+    /**
+     * Участник процесса, который принял решение о прекращении хранения персональных данных. Возможное значение: yoo_money — ЮKassa.
+     */
     party: string;
+    /**
+     * Причина прекращения хранения персональных данных. Возможное значение: expired_by_timeout — истек срок хранения или использования персональных данных.
+     */
     reason: string;
 }
+/**
+ * Создание персональных данных
+ *
+ * В ответ на запрос придет объект персональных данных в актуальном статусе.
+ */
 export type CreatePersonalDataResponse = PersonalData;
+/**
+ * Информация о персональных данных
+ *
+ * В ответ на запрос придет объект персональных данных в актуальном статусе.
+ */
 export type GetPersonalDataResponse = PersonalData;

package/dist/api/responses/receipt.d.ts

@@ -1,54 +1,299 @@
 import type { CommonAmount, CommonMarkCodeInfo, CommonMarkQuantity, CommonPaymentSubjectIndustryDetails, CommonReceiptOperationalDetails, CommonSettlements2 } from '../common';
 import { BasicStatusEnum } from '../enums';
+/**
+ * Объект чека
+ *
+ * Объект чека (Receipt) содержит актуальную информацию о чеке, созданном для платежа или возврата.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Объект чека (Receipt) — актуальная информация о чеке.
+ */
 export interface Receipt {
+    /**
+     * Идентификатор чека в ЮKassa.
+     */
     id: string;
+    /**
+     * Тип чека в онлайн-кассе: приход (payment) или возврат прихода (refund).
+     */
     "type": string;
+    /**
+     * Идентификатор платежа, для которого был сформирован чек.
+     */
     payment_id?: string;
+    /**
+     * Идентификатор возврата, для которого был сформирован чек. Отсутствует в чеке платежа.
+     */
     refund_id?: string;
+    /**
+     * Статус доставки данных для чека в онлайн-кассу. Возможные значения:
+     *
+     * pending — данные в обработке;
+     *
+     * succeeded — чек успешно зарегистрирован;
+     *
+     * canceled — чек зарегистрировать не удалось; если используете Чеки от ЮKassa, обратитесь в техническую поддержку, в остальных случаях сформируйте чек вручную.
+     */
     status: BasicStatusEnum;
+    /**
+     * Номер фискального документа.
+     */
     fiscal_document_number?: string;
+    /**
+     * Номер фискального накопителя в кассовом аппарате.
+     */
     fiscal_storage_number?: string;
+    /**
+     * Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека.
+     */
     fiscal_attribute?: string;
+    /**
+     * Дата и время формирования чека в фискальном накопителе. Указывается в формате ISO 8601.
+     */
     registered_at?: string;
+    /**
+     * Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать.
+     */
     fiscal_provider_id?: string;
+    /**
+     * Список товаров в чеке: для Чеков от ЮKassa — не более 80 товаров, для сторонних онлайн-касс — не более 100 товаров.
+     */
     items: ReceiptItemsItem[];
+    /**
+     * Признак проведения платежа в интернете (тег в 54 ФЗ — 1125) — указывает на оплату через интернет. Возможные значения:
+     *
+     * true — оплата прошла онлайн, через интернет (например, на вашем сайте или в приложении);
+     *
+     * false — оплата прошла офлайн, при личном взаимодействии (например, в торговой точке или при встрече с курьером).
+     *
+     * По умолчанию true. Если вы принимаете платежи офлайн, передайте в запросе значение false.
+     */
     internet?: boolean;
+    /**
+     * Перечень совершенных расчетов.
+     */
     settlements?: CommonSettlements2[];
+    /**
+     * Идентификатор магазина, от имени которого нужно отправить чек. Выдается ЮKassa. Присутствует, если вы используете Сплитование платежей.
+     */
     on_behalf_of?: string;
+    /**
+     * Система налогообложения магазина (тег в 54 ФЗ — 1055).
+     *
+     * Для сторонних онлайн-касс: обязательный параметр, если вы используете онлайн-кассу Атол Онлайн, обновленную до ФФД 1.2, или у вас несколько систем налогообложения, в остальных случаях не передается. Перечень возможных значений
+     *
+     * Для Чеков от ЮKassa: параметр передавать не нужно, ЮKassa его проигнорирует.
+     */
     tax_system_code?: number;
+    /**
+     * Номер часовой зоны для адреса, по которому вы принимаете платежи (тег в 54 ФЗ — 1011). Указывается, только если в чеке есть товары, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur).
+     *
+     * Перечень возможных значений:
+     *
+     * для Чеков от ЮKassa
+     *
+     * для сторонних онлайн-касс
+     */
     timezone?: number;
+    /**
+     * Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260).
+     */
     receipt_industry_details?: CommonPaymentSubjectIndustryDetails[];
+    /**
+     * Операционный реквизит чека (тег в 54 ФЗ — 1270).
+     */
     receipt_operational_details?: CommonReceiptOperationalDetails;
 }
+/**
+ * Список товаров в чеке: для Чеков от ЮKassa — не более 80 товаров, для сторонних онлайн-касс — не более 100 товаров.
+ */
 export interface ReceiptItemsItem {
+    /**
+     * Название товара (не более 128 символов). Тег в 54 ФЗ — 1030).
+     */
     description: string;
+    /**
+     * Количество товара (тег в 54 ФЗ — 1023). Формат: десятичное число, дробная часть — три знака или больше (количество знаков зависит от quantity в запросе). Разделитель дробной части — точка, разделитель тысяч отсутствует. Пример: 5.000
+     */
     quantity: number;
+    /**
+     * Цена товара (тег в 54 ФЗ — 1079).
+     */
     amount: CommonAmount;
+    /**
+     * Ставка НДС (тег в 54 ФЗ — 1199). Перечень возможных значений:
+     *
+     * для Чеков от ЮKassa
+     *
+     * для сторонних онлайн-касс
+     */
     vat_code: number;
+    /**
+     * Признак предмета расчета (тег в 54 ФЗ — 1212) — это то, за что принимается оплата, например товар, услуга.
+     *
+     * Перечень возможных значений:
+     *
+     * для Чеков от ЮKassa
+     *
+     * для сторонних онлайн-касс
+     */
     payment_subject?: string;
+    /**
+     * Признак способа расчета (тег в 54 ФЗ — 1214) — отражает тип оплаты и факт передачи товара. Пример: покупатель полностью оплачивает товар и сразу получает его. В этом случае нужно передать значение full_payment (полный расчет).
+     *
+     * Перечень возможных значений:
+     *
+     * для Чеков от ЮKassa
+     *
+     * для сторонних онлайн-касс
+     */
     payment_mode?: string;
+    /**
+     * Код страны происхождения товара по общероссийскому классификатору стран мира (OК (MК (ИСО 3166) 004-97) 025-2001). Тег в 54 ФЗ — 1230. Пример: RU.
+     *
+     * Онлайн-кассы, которые поддерживают этот параметр: Orange Data, Кит Инвест.
+     */
     country_of_origin_code?: string;
+    /**
+     * Номер таможенной декларации (от 1 до 32 символов). Тег в 54 ФЗ — 1231.
+     *
+     * Онлайн-кассы, которые поддерживают этот параметр: Orange Data, Кит Инвест.
+     */
     customs_declaration_number?: string;
+    /**
+     * Сумма акциза товара с учетом копеек (тег в 54 ФЗ — 1229). Десятичное число с точностью до 2 символов после точки.
+     *
+     * Онлайн-кассы, которые поддерживают этот параметр: Orange Data, Кит Инвест.
+     */
     excise?: string;
+    /**
+     * Информация о поставщике товара или услуги (тег в 54 ФЗ — 1224). Можно передавать, если вы отправляете данные для формирования чека по сценарию Сначала платеж, потом чек.
+     */
     supplier?: ReceiptItemsItemSupplier;
+    /**
+     * Тип посредника, реализующего товар или услугу. Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1. Перечень возможных значений. Можно передавать, если ваша онлайн-касса обновлена до ФФД 1.1 и вы отправляете данные для формирования чека по сценарию Сначала платеж, потом чек
+     */
     agent_type?: string;
+    /**
+     * Код товара (тег в 54 ФЗ — 1163).
+     *
+     * Обязательный параметр, если одновременно выполняются эти условия:
+     *
+     * вы используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2;
+     *
+     * товар нужно маркировать.
+     *
+     * Должно быть заполнено хотя бы одно поле.
+     */
     mark_code_info?: CommonMarkCodeInfo;
+    /**
+     * Мера количества предмета расчета (тег в 54 ФЗ — 2108) — единица измерения товара, например штуки, граммы.
+     *
+     * Обязательный параметр, если используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2.
+     *
+     * Перечень возможных значений:
+     *
+     * для Чеков от ЮKassa
+     *
+     * для сторонних онлайн-касс
+     */
     measure?: string;
+    /**
+     * Отраслевой реквизит предмета расчета (тег в 54 ФЗ — 1260). Обязателен при использовании ФФД 1.2.
+     */
     payment_subject_industry_details?: CommonPaymentSubjectIndustryDetails[];
+    /**
+     * Код товара (тег в 54 ФЗ — 1162) — уникальный номер, который присваивается экземпляру товара при маркировке.
+     *
+     * Формат: число в шестнадцатеричном представлении с пробелами. Максимальная длина — 32 байта. Пример: 00 00 00 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00.
+     *
+     * Обязательный параметр, если одновременно выполняются эти условия:
+     *
+     * вы используете онлайн-кассу, обновленную до ФФД 1.05 или 1.1;
+     *
+     * товар нужно маркировать.
+     *
+     * Параметр должен отсутствовать в запросе, если вы используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2.
+     */
     product_code?: string;
+    /**
+     * Планируемый статус товара. Тег в 54 ФЗ — 2003. Указывается только для товаров, которые подлежат обязательной маркировке (в items.mark_code_info передается параметр gs_1m, short или fur).
+     *
+     * Перечень возможных значений:
+     *
+     * для Чеков от ЮKassa
+     *
+     * для сторонних онлайн-касс
+     */
     planned_status?: number;
+    /**
+     * Режим обработки кода маркировки (тег в 54 ФЗ — 2102).
+     *
+     * Обязательный параметр, если одновременно выполняются эти условия:
+     *
+     * вы используете Чеки от ЮKassa или онлайн-кассу Атол Онлайн или BusinessRu, обновленную до ФФД 1.2;
+     *
+     * товар нужно маркировать.
+     *
+     * Должен принимать значение равное «0».
+     */
     mark_mode?: string;
+    /**
+     * Дробное количество маркированного товара (тег в 54 ФЗ — 1291).
+     *
+     * Обязательный параметр, если одновременно выполняются эти условия:
+     *
+     * вы используете Чеки от ЮKassa или онлайн-кассу, обновленную до ФФД 1.2;
+     *
+     * товар нужно маркировать;
+     *
+     * поле measure имеет значение piece.
+     *
+     * Пример: вы продаете поштучно карандаши. Они поставляются пачками по 100 штук с одним кодом маркировки. При продаже одного карандаша нужно в numerator передать 1, а в denominator — 100.
+     */
     mark_quantity?: CommonMarkQuantity;
 }
+/**
+ * Информация о поставщике товара или услуги (тег в 54 ФЗ — 1224). Можно передавать, если вы отправляете данные для формирования чека по сценарию Сначала платеж, потом чек.
+ */
 export interface ReceiptItemsItemSupplier {
+    /**
+     * Наименование поставщика (тег в 54 ФЗ — 1225). Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1.
+     */
     name?: string;
+    /**
+     * Телефон поставщика (тег в 54 ФЗ — 1171). Указывается в формате ITU-T E.164, например 79000000000. Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.1.
+     */
     phone?: string;
+    /**
+     * ИНН поставщика в маскированном виде (тег в 54 ФЗ — 1226). Пример: ***. Параметр предусмотрен форматом фискальных документов (ФФД) и является обязательным, начиная с версии 1.05.
+     */
     inn?: string;
 }
+/**
+ * Создание чека
+ *
+ * В ответ на запрос придет объект чека в актуальном статусе.
+ */
 export type CreateReceiptResponse = Receipt;
+/**
+ * Список чеков
+ *
+ * В ответ на запрос вернется список чеков с учетом переданных параметров. В списке будет информация о чеках, созданных за последние 3 года. Список будет отсортирован по времени создания чеков в порядке убывания.
+ *
+ * Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент.
+ *
+ * Подробнее о работе со списками
+ */
 export interface GetReceiptsListResponse {
     type: "list";
     items: Receipt[];
     next_cursor?: string;
 }
+/**
+ * Информация о чеке
+ *
+ * В ответ на запрос придет объект чека в актуальном статусе.
+ */
 export type GetReceiptResponse = Receipt;