К содержимому
Инвойсбокс

Получение счёта

Счета читаются одним запросом — списком или по идентификатору:

  • метод: 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 4217RUB, USD,EUR, GBP
customer *CustomerИнформация о плательщике
statusstring(50) enumСтатус оплаты счёта (paid, pending, canceled, partial)paid
paymentUrl *string(1000)Ссылка для перехода на платёжный шлюз на страницу счёта

Customer

СвойствоТипОписаниеПример значения
typestring(10) enumТип заказчикаlegal - юр. лицо, private - физ лицо
namestring(500)Наименование или имяООО «Ромашка»
phonestring(100)Номер телефона79001112233
emailstring(100)Электронная почтаbuh@example.invbox.ru
vatNumberstring(20)ИНН7701234560
registrationAddressstring(1000)Юр. адрес190000, Санкт-Петербург, Невский пр. 147, офис 321

Читайте также

Страница помогла?