# Инвойсбокс API — Инвойсбокс.Бизнес > Раздел документации целиком. Полное оглавление: https://docs.invoicebox.ru/llms.txt ## Инвойсбокс.Бизнес - [Схема взаимодействия](https://docs.invoicebox.ru/raw/business/schema.md) (раздел «Инвойсбокс.Бизнес») - [Получение счёта](https://docs.invoicebox.ru/raw/business/get.md) (раздел «Инвойсбокс.Бизнес») - [Подтверждение оплаты счёта](https://docs.invoicebox.ru/raw/business/confirm_payment.md) (раздел «Инвойсбокс.Бизнес») - [Инвойсбокс.Бизнес](https://docs.invoicebox.ru/raw/business/business.md) --- # Схема взаимодействия Предложенная схема описывает взаимодействие, позволяющее системе организации получать информацию по счёту и подтверждать его оплату с использованием гарантийного фонда. sequenceDiagram autonumber participant Организация participant Инвойсбокс rect rgba(43, 170, 93, 0.13) Организация->>Инвойсбокс: Вызов метода получения информации по счёту Организация->>Инвойсбокс: Вызов метода подтверждения оплаты счёта Инвойсбокс->>Организация: Изменение размера гарантийного фонда end 1. Система организации получает информацию по счёту из системы Инвойсбокс.Бизнес [через метод API](/docs/business/get/). 1. Система организации подтверждает оплату счёта в системе Инвойсбокс.Бизнес [через метод API](/docs/business/confirm_payment/). 1. Система Инвойсбокс изменяет размер гарантийного фонда партнёра. # Схема взаимодействия для систем программ лояльности Предложенная схема описывает взаимодействие, позволяющие интегрировать систему программы лояльности в качестве платёжного инструмента Инвойсбокс. Например, у покупателя есть счёт (баланс) внутри программы лояльности, кафетерия льгот или иной системы, с помощью которой, он хочет приобрести товары или услуги используя систему Инвойсбокс. Оператор системы программы лояльности регистрируется в системе Инвойсбокс и размещает гарантийный фонд. sequenceDiagram autonumber participant Покупатель participant Партнёр participant Инвойсбокс rect rgba(43, 170, 93, 0.13) Покупатель->>Партнёр: Выбор способа оплаты и переход на страницу партнёра Партнёр->>Инвойсбокс: Вызов метода получения информации по счёту Покупатель->>Партнёр: Подтверждение оплаты счёта Партнёр->>Инвойсбокс: Вызов метода подтверждения оплаты счёта Инвойсбокс->>Партнёр: Изменение размера гарантийного фонда Партнёр->>Покупатель: Перенаправление на платёжную страницу end 1. Покупатель оформляет заказ и выбирает способ оплаты через систему партнёра. Покупатель перенаправляется на страницу авторизации партнёра с идентификатором счёта. Ссылка на страницу авторизации предоставляется платёжным инструментом. Также могут быть переданы ссылки возврата на случай обработки негативных сценариев при работе с API. 1. Система партнёра получает информацию по счёту из системы Инвойсбокс.Бизнес [через метод API](/docs/business/get/). 1. Покупатель подтверждает оплату счёта. 1. Система партнёра подтверждает оплату счёта в системе Инвойсбокс.Бизнес [через метод API](/docs/business/confirm_payment/). 1. Система Инвойсбокс изменяет размер гарантийного фонда партнёра. 1. Партнёр перенаправляет покупателя по полученной ссылке (в запросе информации по счёту) на платёжную страницу системы Инвойсбокс. --- --- # Получение счёта Счета читаются одним запросом — списком или по идентификатору: - метод: `GET` - ресурс: `/v3/business/api/invoice` или `/v3/business/api/invoice/{invoiceId}` - тело ответа - коллекция объектов [InvoiceResponse](/docs/business/get/#invoiceresponse) в свойстве `data`, постраничность — в `metaData` (см. [формат ответа выборки](/docs/api/filters/#формат-ответа-выборки)) #### Пример запроса и ответа ```http GET /v3/business/api/invoice/01771534-196a-1105-839a-82422289d6d9 ``` В запросе возможно применения фильтров и сортировок. Пример запроса с фильтром по идентификатору счёта ```http GET /v3/business/api/invoice?id=01771534-196a-1105-839a-82422289d6d9 ``` Пример запроса с фильтром по идентификатору заказа Магазина ```http GET /v3/business/api/invoice?merchantOrderId=ABCDE ``` или по номеру заказа, который видит плательщик ```http GET /v3/business/api/invoice?merchantOrderIdVisible=ABCDE ``` Пример запроса с фильтром по статусу ```http GET /v3/business/api/invoice?status=paid ``` Ответ: ``` json { "data": [ { "id": "01771534-1a57-f184-dee3-ebeb91dded76", "number": "123-123212", "createdAt": "2026-08-01T10:00:00+03:00", "expirationDate": "2026-08-04T10:00:00+03:00", "description": "Оплата номера в отеле", "amount": 19658.45, "currencyId": "RUB", "status": "created" } ] } ``` ## InvoiceResponse | Свойство | Обязательное | Тип | Описание | Пример значения | |----------------|--------------|---------------------------|-------------------------------------------------------------------------|----------------------------------------| | id | да | string(36) | Идентификатор счёта | `01771534-1a57-f184-dee3-ebeb91dded76` | | number | да | string(50) | Номер счёта | `123-123212` | | createdAt | да | datetime | Дата создания счёта | `2023-12-22T00:00:00+00:00` | | expirationDate | да | datetime | Срок оплаты счёта | `2023-12-25T00:00:00+00:00` | | description | да | string(1000) | Описание счёта | `Оплата номера в отеле` | | amount | да | float | Сумма счёта (к оплате) | `19658.45` | | vatAmount | да | float | Сумма НДС в счёте | `156.56` | | currencyId | да | string(3) enum | Код валюты счёта в соответствии с [ISO 4217](/docs/dictionary/iso4217/) | `RUB`, `USD`,`EUR`, `GBP` | | customer | да | [Customer](#customer) | Информация о плательщике | | | status | нет | string(50) enum | Статус оплаты счёта (paid, pending, canceled, partial) | `paid` | | paymentUrl | да | string(1000) | Ссылка для перехода на платёжный шлюз на страницу счёта | | ## Customer | Свойство | Обязательное | Тип | Описание | Пример значения | |---------------------|--------------|-----------------|-------------------|------------------------------------------------------| | type | нет | string(10) enum | Тип заказчика | `legal` - юр. лицо, `private` - физ лицо | | name | нет | string(500) | Наименование или имя | `ООО «Ромашка»` | | phone | нет | string(100) | Номер телефона | `79001112233` | | email | нет | string(100) | Электронная почта | `buh@example.invbox.ru` | | vatNumber | нет | string(20) | ИНН | `7701234560` | | registrationAddress | нет | string(1000) | Юр. адрес | `190000, Санкт-Петербург, Невский пр. 147, офис 321` | ## Читайте также - [Полный синтаксис операторов, сортировки и постраничного вывода](/docs/api/filters/) --- --- # Подтверждение оплаты счёта Оплата счёта из гарантийного фонда подтверждается одним вызовом: - метод: `POST` - ресурс: `/v3/business/api/invoice/{invoiceId}/confirm` - тело запроса - объект [CreateInvoicePaymentRequest](#createinvoicepaymentrequest) - тело ответа - объект [InvoicePaymentResponse](#invoicepaymentresponse) - Возможные [ошибки](/docs/dictionary/error/) #### Пример запроса ``` json POST /v3/business/api/invoice/{invoiceId}/confirm Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e Content-Type: application/json User-Agent: MyApp 1.0 Accept: application/json { "partnerOperationId" : "117a58b0-7dc9-424c-8f07-b8a865e8bcc7" } ``` Ответ: ``` json { "data": { "id": "8c0e116d-31a5-4210-b62e-6b6917851f69", "invoiceId": "01771534-1a57-f184-dee3-ebeb91dded75", "partnerOperationId": "117a58b0-7dc9-424c-8f07-b8a865e8bcc7", "amount": 19658.45, "currencyId": "RUB", "status": "paid" } } ``` ## Параметры запроса | Свойство | Обязательное | Тип | Описание | Пример значения | |-----------------|--------------|------------|----------------|----------------------------------------| | invoiceId | да | string(36) | Id счёта | `01771534-1a57-f184-dee3-ebeb91dded75` | ## CreateInvoicePaymentRequest | Свойство | Обязательное | Тип | Описание | Пример значения | |--------------------|--------------|------------|----------------------|----------------------------------------| | partnerOperationId | да | string(36) | Id операции партнёра | `117a58b0-7dc9-424c-8f07-b8a865e8bcc7` | ## InvoicePaymentResponse Повторяет свойства объекта [CreateInvoicePaymentRequest](#createinvoicepaymentrequest) с дополнительными свойствами: | Свойство | Обязательное | Тип | Описание | Пример значения | |------------|--------------|------------|-----------------------------------------------|-----------------------------------------| | id | да | string(36) | Идентификатор транзакции в системе Инвойсбокс | `8c0e116d-31a5-4210-b62e-6b6917851f69` | --- --- # Инвойсбокс.Бизнес Инвойсбокс.Бизнес — сервис для постоянных покупателей, заключивших договор. Покупатель перечисляет сумму гарантийного фонда и в её пределах мгновенно подтверждает оплату покупок, не дожидаясь банковского перевода. Отсрочка даётся сверх фонда: если на балансе 10 000 ₽, а покупка стоит 15 000 ₽, система подтвердит оплату и даст отсрочку на недостающие 5 000 ₽. Лимит рассчитывается индивидуально, условия — в договоре. Подробнее об инструментах — на странице [платёжных инструментов](/docs/merchant/payment-instruments/). API для работы с Инвойсбокс.Бизнес позволяет получать информацию по заказам, а также подтверждать оплату счёта с использованием гарантийного фонда.