Link Поиск Меню Развернуть Документ

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

Для получения списка счетов, необходимо вызвать следующий метод API:

  • метод: GET
  • ресурс: /v3/business/api/invoice или /v3/business/api/invoice/{invoiceId}
  • тело ответа - array of InvoiceResponse

Пример запроса с идентификатором счёта

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

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 4217RUB, 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)ИмяPeter
phoneнетstring(100)Номер телефона79001112233
emailнетstring(100)Электронная почтаpeter@domain.com
vatNumberнетstring(20)ИНН7710044140
registrationAddressнетstring(1000)Юр. адресс190000, Санкт-Петербург, Невский пр. 147, офис 321

Читать далее »