Получить список счетов клиента

Обновлено 14 февраля 2025

GET

/invoices

Получить список счетов

Запрос

Query Parameters

user_id

object

Идентификатор пользователя, заполняется только если передается токен партнера, для фильтрации по пользователю. Если передается токен клиента, то данные автоматически фильтруются по пользователю

date_from

date

Начальная дата создания счета

date_to

date

Конечная дата создания счета

invoice_status

string

Список статусов счетов, которые нужно отдать в выборке. Если отсутствует, то отдаются только счета со статусом confirmed и paid. Возможные значения all,created,executed,cancelled,paid,confirmed,reversed,refunded

amount_from

integer

Сумма счета с, в копейках

amount_to

integer

Сумма счета по, в копейках

masked_pan

string

4 последних цифры номера карты

order_num

string

Номер заказа в системе магазина, для клиента

page

integer

Results page you want to retrieve (0..N)

size

integer

Number of records per page.

Ответы

200
400
401
default

Список счетов

application/json

Схема
Пример из схемы

Schema

error object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

invoices object[]

Array [

invoice_id

string

required

Идентификатор счета

invoice_date

string

Дата создания счета

invoice_status

string

Статус счета.

Возможные значения — в разделе Статусы счета

amount_create object

amount

integer

Сумма счета без разделителя, в копейках. Например, 1 рубль передается в этом поле как 100.

Если в запросе указывается корзина товаров, то это поле должно быть равно сумме стоимости всех товаров в корзине sum(order_bundle.item_amount).

amount_confirm object

amount

integer

Сумма счета без разделителя, в копейках. Например, 1 рубль передается в этом поле как 100.

amount_current object

amount

integer

Сумма счета без разделителя, в копейках. Например, 1 рубль передается в этом поле как 100.

order_number

string

Номер заказа

currency

string

Код валюты в ISO 4217.

description

string

Описание платежа для отображения клиенту или печати

language

string

Язык, текстовых полей, указанный с помощью BCP 47 кодирования. (Например, "en-US" для английского языка, используемого в США, "en-GB" для английского языка, используемого в Великобритании, и т.д.)

org_name

string

Наименование организации

org_inn

string

ИНН организации

trademarks

string

Перечисление торговых марок через точку с запятой

trade_name

string

Торговое наименование организации

visual_name

string

Наименование операции для отображения

visual_amount

string

Сумма для отображения

payment_info object

Данные банковской карты (связки)

payment_date

date-time

Дата и время оплаты счета, RFC 3339

payment_id

payment_id (string)

Идентификатор платежа

device_info object

Информация об устройстве

device_platform_type

string

Наименование операционной системы устройства

device_platform_version

string

Версия операционной системы устройства

device_model

string

Модель устройства

device_manufacturer

string

Производитель устройства

device_id

string

Серийный номер устройства

surface

string

Поверхность

surface_version

string

Версия ПО

loyalty_info object

Информация по бонусам после оплаты

service_code

string

required

Код бонусной программы

service_name

string

required

Наименование бонусной программы

change_rate

number

required

Коэффициент обмена баллов на рубли.

Например, 100 баллов / 1.25 (коэффициент) = 80 руб. Будет списано 100 баллов, сумма платежа уменьшена на 80 руб.

payment_bonus

integer

Сумма бонусных баллов, использованных при оплате счета.

Указывается в копейках. Например, 123 балла 50 копеек = 12350

award_bonus

integer

Сумма средств, использованных для начисления баллов при оплате заказа.

Указывается в копейках. Например, 123 балла 50 копеек = 12350

image

url

Ссылка на картинку

masked_pan

string

Маскированный номер карты

expiry_date

string

Срок истечения действия карты в формате YYYYMM

cardholder

string

Имя держателя карты, указанное при оплате

payment_system

string

Наименование платежной системы

payment_system_image

url

Логотип платежной системы

image

url

Логотип карты

paysys

string

Наименование платежного оператора

paysys_image

url

Логотип платежного оператора

payment_way

string

Наименование способа оплаты

payment_way_code

string

Код способа оплаты

payment_way_logo

url

Логотип способа оплаты

bank_info object

Данные банка-эмитента

bank_name

string

Наименование банка-эмитента

bank_country_code

string

Код страны банка-эмитента.

bank_country_name

string

Наименование страны банка-эмитента

bank_image

string

Ссылка на логотип банка

image

url

Ссылка на картинку

]

empty

boolean

first

boolean

last

boolean

number

int32

numberOfElements

int32

pageable object

offset

int64

pageNumber

int32

pageSize

int32

paged

boolean

sort object

empty

boolean

sorted

boolean

unsorted

boolean

unpaged

boolean

size

int32

sort object

empty

boolean

sorted

boolean

unsorted

boolean

totalElements

int64

totalPages

int32

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  },
  "invoices": [
    {
      "invoice_id": 1234567890,
      "invoice_date": "2020-04-29T08:18:03+03",
      "invoice_status": "created",
      "amount_create": {
        "amount": 11836
      },
      "amount_confirm": {
        "amount": 11836
      },
      "amount_current": {
        "amount": 11836
      },
      "order_number": 1234567,
      "currency": "RUB",
      "description": "Покупка внутриигрового контента в игре Маша и Медведь, салон красоты Чародейка.",
      "language": "ru-RU",
      "org_name": "ООО Ромашка",
      "org_inn": "1234567890",
      "trademarks": "Ромашка;Romashka;Romashka street",
      "trade_name": "Romashka",
      "visual_name": "Покупка/продление подписки",
      "visual_amount": "1 500,45 ₽",
      "payment_info": {
        "payment_date": "2024-07-29T15:51:28.071Z",
        "payment_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "device_info": {
          "device_platform_type": "iOS",
          "device_platform_version": "13.6.1",
          "device_model": "iPhone 7",
          "device_manufacturer": "Apple",
          "device_id": "83c3f257-46d8-41fe-951b-f79d04e288c2",
          "surface": "SBOL",
          "surface_version": "11.5.0"
        },
        "loyalty_info": {
          "service_code": "sbrf_spasibo",
          "service_name": "Сбербанк Спасибо",
          "change_rate": 1,
          "payment_bonus": 19800,
          "award_bonus": 21850,
          "image": "https://developers.sber.ru/docs/img/fork-page/assistant-salute-grey.png"
        },
        "masked_pan": "**1111",
        "expiry_date": "201912",
        "cardholder": "Ivan Petrov",
        "payment_system": "Visa",
        "payment_system_image": "https://smartmarket.online.sberbank.ru/icons/logo_visa.png",
        "image": "https://smartmarket.online.sberbank.ru/icons/sberbank_mastercard_league_legends.jpeg",
        "paysys": "Эквайринг Сбербанка",
        "paysys_image": "https://www.sberbank.ru/common/img/uploaded/redirected/s_m_business/acquiring/assets/images/intro@2x.png",
        "payment_way": "Sber Pay",
        "payment_way_code": "SberPay",
        "payment_way_logo": "https://cdn1.telegram.one/i/f7640dada78306b1c993e04001b8738d/828b1eb30921659e22e53a9edc92c4c4/24e01830d213d75deb99c22b9cd91ddd",
        "bank_info": {
          "bank_name": "ПАО Сбербанк",
          "bank_country_code": "RU",
          "bank_country_name": "Россия",
          "bank_image": "https://emoji.slack-edge.com/TKK9DHNCV/sber/ad2df81a6cd9812d.png"
        }
      },
      "image": "https://developers.sber.ru/docs/img/fork-page/assistant-salute-grey.png"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

bad input parameter

application/json

Схема
Пример из схемы

Schema

error object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

Unexpected error

application/json

Схема
Пример из схемы

Schema

error object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

Это полезный материал?

Получить список счетов клиента

Запрос﻿

Query Parameters

Ответы﻿

Запрос

Ответы