Получение счёта
Счета читаются одним запросом — списком или по идентификатору:
- метод:
GET - ресурс:
/v3/business/api/invoiceили/v3/business/api/invoice/{invoiceId} - тело ответа - коллекция объектов InvoiceResponse в свойстве
data, постраничность — вmetaData(см. формат ответа выборки)
Пример запроса и ответа
GET /v3/business/api/invoice/01771534-196a-1105-839a-82422289d6d9
В запросе возможно применения фильтров и сортировок.
Пример запроса с фильтром по идентификатору счёта
GET /v3/business/api/invoice?id=01771534-196a-1105-839a-82422289d6d9
Пример запроса с фильтром по идентификатору заказа Магазина
GET /v3/business/api/invoice?merchantOrderId=ABCDE
или по номеру заказа, который видит плательщик
GET /v3/business/api/invoice?merchantOrderIdVisible=ABCDE
Пример запроса с фильтром по статусу
GET /v3/business/api/invoice?status=paid
Ответ:
{
"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 | Дата создания счёта | 2026-08-12T00:00:00+00:00 |
| expirationDate * | datetime | Срок оплаты счёта | 2026-08-12T00:00:00+00:00 |
| description * | string(1000) | Описание счёта | Оплата номера в отеле |
| amount * | float | Сумма счёта (к оплате) | 19658.45 |
| vatAmount * | float | Сумма НДС в счёте | 156.56 |
| currencyId * | string(3) enum | Код валюты счёта в соответствии с ISO 4217 | RUB, USD,EUR, GBP |
| 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 |
| string(100) | Электронная почта | buh@example.invbox.ru | |
| vatNumber | string(20) | ИНН | 7701234560 |
| registrationAddress | string(1000) | Юр. адрес | 190000, Санкт-Петербург, Невский пр. 147, офис 321 |