Группа методов Bill внешнего программного интерфейса менеджера сервиса предназначена для работы со счетами клиентам.
Сводка по методам
Метод | Описание |
---|---|
root | |
list | Список счетов на оплату |
info | Информация о счете на оплату |
create | Создать счет на оплату |
update | Изменить счет на оплату |
create_subscription | Создать подписки на тарифы сервиса на основании счета на оплату |
file_token | |
upload | Получить талон на загрузку файла, прикрепляемого к счету на оплату |
bill/list
Метод возвращает список счетов на оплату
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
seller_id * | Число (+12.0) | Код продавца | 1000 |
customer_id * | Число (+12.0) | Код покупателя | 2000 |
start_date * | Дата и время в строке формата ISO | Дата начала | 30.07.2020 0:00:00 |
end_date * | Дата и время в строке формата ISO | Дата окончания | 30.07.2020 0:00:00 |
Ответ: bill (0..*) | |||
id | Строка переменная (9) | Номер счета | 000000002 |
created | Дата и время в строке формата ISO | Дата оформления счета | 28.07.2020 0:00:00 |
modified | Дата и время в строке формата ISO | Дата последнего изменения счета | 30.07.2020 0:00:00 |
bill_id * | Строка фиксированная (36) | Идентификатор счета | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
seller_id | Число (+12.0) | Код продавца | 1000 |
customer_id | Число (+12.0) | Код покупателя | 2000 |
renewal * | Булево | Продление | true |
total_cost * | Число (+31.2) | Сумма счета | 4000 |
payment_link * | Строка неограниченной длины | Платежная ссылка | https://money.yandex.ru/api-pages/v2/payment-confirm/epl?orderId=26bcb3ac-000f-5000-8000-178abf269371 |
paid * | Булево | Оплачен | false |
add_info * | Строка неограниченной длины | Дополнительная информация | |
comment * | Строка неограниченной длины | Комментарий счета | Комментарий счета на оплату |
bill/info
Метод возвращает информацию о счете на оплату
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id * | Строка переменная (9) | Номер счета для поиска. Обязательно, если не указан идентификатор счета. | 000000002 |
bill_id * | Строка фиксированная (36) | Идентификатор счета для поиска. Обязательно, если не указан номер счета. | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
Ответ: bill (1) | |||
id | Строка переменная (9) | Номер счета | 000000002 |
created | Дата и время в строке формата ISO | Дата оформления счета | 28.07.2020 0:00:00 |
modified | Дата и время в строке формата ISO | Дата последнего изменения счета | 30.07.2020 0:00:00 |
bill_id | Строка фиксированная (36) | Идентификатор счета | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
seller_id | Число (+12.0) | Код продавца | 1000 |
customer_id | Число (+12.0) | Код покупателя | 2000 |
renewal * | Булево | Продление | true |
total_cost * | Число (+31.2) | Сумма счета | 4000 |
payment_link * | Строка неограниченной длины | Платежная ссылка | https://money.yandex.ru/api-pages/v2/payment-confirm/epl?orderId=26bcb3ac-000f-5000-8000-178abf269371 |
paid * | Булево | Оплачен | false |
add_info * | Строка неограниченной длины | Дополнительная информация | |
comment * | Строка неограниченной длины | Комментарий счета | Комментарий счета на оплату |
tariffs | Список (0..*) | Тарифы | |
- tariff_id | Строка переменная (9) | Код тарифа | 512 |
- servant_tariff_id * | Строка переменная (9) | Код тарифа обслуживающей организации | 00007 |
- period_id | Строка переменная (10) | Код периода действия | 1MN |
- basis_id * | Строка переменная (9) | Код основания | 000000077 |
- amount | Число (+12.0) | Количество (может быть больше 1 для подписок на расширения тарифов) | 1 |
- cost * | Число (+31.2) | Сумма | 2000 |
services | Список (0..*) | Услуги | |
- service | Строка переменная (1024) | Услуга | Консультации специалиста |
- cost * | Число (+31.2) | Сумма | 2000 |
files | Список (0..*) | Файлы | |
- id | Строка фиксированная (36) | Идентификатор файла | 710e7a50-25b5-45e1-ab8a-3a0d657816ae |
- name | Строка неограниченной длины | Описание файла | Счет.pdf |
fields | Список (0..*) | Дополнительные реквизиты | false |
- key | Строка переменная (100) | Имя реквизита | Требуется заполнение данных абонента |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type * | Строка неограниченной длины | Тип реквизита | boolean |
status * | Состояния счета на оплату | ||
- name * | Строка переменная (17) | Имя состояния:
| paid |
- error * | Булево | Признак ошибки | false |
- description * | Строка неограниченной длины | Описание состояния |
bill/create
Метод создает новый счет на оплату
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
bill_id * | Строка фиксированная (36) | Идентификатор счета | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
seller_id | Число (+12.0) | Код продавца | 1000 |
customer_id | Число (+12.0) | Код покупателя | 2000 |
renewal * | Булево | Продление | true |
total_cost * | Число (+31.2) | Сумма счета | 4000 |
payment_link * | Строка неограниченной длины | Платежная ссылка | https://money.yandex.ru/api-pages/v2/payment-confirm/epl?orderId=26bcb3ac-000f-5000-8000-178abf269371 |
paid * | Булево | Оплачен | false |
add_info * | Строка неограниченной длины | Дополнительная информация | |
comment * | Строка неограниченной длины | Комментарий счета | Комментарий счета на оплату |
tariffs * | Тарифы | ||
- tariff_id | Строка переменная (9) | Код тарифа | 512 |
- servant_tariff_id * | Строка переменная (9) | Код тарифа обслуживающей организации | 00007 |
- period_id | Строка переменная (10) | Код периода действия | 1MN |
- basis_id * | Строка переменная (9) | Код основания | 000000077 |
- amount | Число (+12.0) | Количество (может быть больше 1 для подписок на расширения тарифов) | 1 |
- cost * | Число (+31.2) | Сумма | 2000 |
services * | Услуги | ||
- service | Строка переменная (1024) | Услуга | Консультации специалиста |
- cost * | Число (+31.2) | Сумма | 2000 |
files * | Файлы | ||
- id | Строка фиксированная (36) | Идентификатор файла | 710e7a50-25b5-45e1-ab8a-3a0d657816ae |
- name | Строка неограниченной длины | Описание файла | Счет.pdf |
fields * | Дополнительные реквизиты | false | |
- key | Строка переменная (100) | Имя реквизита | Требуется заполнение данных абонента |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type * | Строка неограниченной длины | Тип реквизита | boolean |
Ответ | |||
id | Строка переменная (9) | Номер счета | 000000002 |
bill_id | Строка фиксированная (36) | Идентификатор счета | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
bill/update
Метод изменяет счет на оплату
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id * | Строка переменная (9) | Номер счета для поиска. Обязательно, если не указан идентификатор счета. | 000000002 |
bill_id * | Строка фиксированная (36) | Идентификатор счета для поиска. Обязательно, если не указан номер счета. | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
seller_id | Число (+12.0) | Код продавца | 1000 |
customer_id | Число (+12.0) | Код покупателя | 2000 |
renewal * | Булево | Продление | true |
total_cost * | Число (+31.2) | Сумма счета | 4000 |
payment_link * | Строка неограниченной длины | Платежная ссылка | https://money.yandex.ru/api-pages/v2/payment-confirm/epl?orderId=26bcb3ac-000f-5000-8000-178abf269371 |
paid * | Булево | Оплачен | false |
add_info * | Строка неограниченной длины | Дополнительная информация | |
comment * | Строка неограниченной длины | Комментарий счета | Комментарий счета на оплату |
tariffs * | Тарифы | ||
- tariff_id | Строка переменная (9) | Код тарифа | 512 |
- servant_tariff_id * | Строка переменная (9) | Код тарифа обслуживающей организации | 00007 |
- period_id | Строка переменная (10) | Код периода действия | 1MN |
- basis_id * | Строка переменная (9) | Код основания | 000000077 |
- amount | Число (+12.0) | Количество (может быть больше 1 для подписок на расширения тарифов) | 1 |
- cost * | Число (+31.2) | Сумма | 2000 |
services * | Услуги | ||
- service | Строка переменная (1024) | Услуга | Консультации специалиста |
- cost * | Число (+31.2) | Сумма | 2000 |
files * | Файлы | ||
- id | Строка фиксированная (36) | Идентификатор файла | 710e7a50-25b5-45e1-ab8a-3a0d657816ae |
- name | Строка неограниченной длины | Описание файла | Счет.pdf |
fields * | Дополнительные реквизиты | false | |
- key | Строка переменная (100) | Имя реквизита | Требуется заполнение данных абонента |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type * | Строка неограниченной длины | Тип реквизита | boolean |
Ответ | |||
id | Строка переменная (9) | Номер счета | 000000002 |
bill_id | Строка фиксированная (36) | Идентификатор счета | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
bill/create_subscription
Метод позволяет оформить подписки на тарифы сервиса на основании счета на оплату
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id * | Строка переменная (9) | Номер счета для поиска. Обязательно, если не указан идентификатор счета. | 000000002 |
bill_id * | Строка фиксированная (36) | Идентификатор счета для поиска. Обязательно, если не указан номер счета. | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
start * | Дата и время в строке формата ISO | Начало действия создаваемых подписок | 08.11.2022 0:00:00 |
Ответ: subscription (0..*) | |||
id | Строка переменная (9) | Номер созданной подписки | 000000002 |
В результате выполнения метода будут созданы подписки по данным счета на оплату
Порядок привязки к основному тарифу:
- В подписке указан основной тариф – все расширения привязываются к этому тарифу
- В подписке указано несколько основных тарифов:
- Можно привязать только к одному из тарифов – привязка осуществляется к этому тарифу
- Можно привязать к нескольким тарифам – привязывается к тому, который первый может содержать эти расширения в порядке тарифов в счете.
Возможные ошибки:
- Для тарифов-расширений не указаны основные подписки, к которым можно привязать расширения и не указан основной тариф.
- Стандартные ошибки проверок при оформлении подписок
bill/file_token/upload
Метод для получения талона на загрузку файла, прикрепляемого к счету на оплату.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id * | Строка переменная (9) | Номер счета для поиска. Обязательно, если не указан идентификатор счета. | 000000002 |
bill_id * | Строка фиксированная (36) | Идентификатор счета для поиска. Обязательно, если не указан номер счета. | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
name | Строка переменная (255) | Имя файла | bill.pdf |
size | Число (+15.0) | Размер файла (байт) | 52428800 |
Ответ | |||
id * | Строка переменная (9) | Номер счета | 000000002 |
bill_id * | Строка фиксированная (36) | Идентификатор счета | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
direction * | Строка переменная (8) | Направление передачи данных | upload |
token * | Строка переменная (64) | Талон на загрузку файла | bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb |
url * | Строка неограниченной длины | Адрес для загрузки (PUT) | http://example.com/sm/hs/dt/upload/bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb |
Важная особенность
При загрузке больших файлов (более 500 Мбайт) следует учитывать, что файл может быть доступен для использования лишь через некоторое время после его закачки и получения его идентификатора. Рекомендуется перед использованием файла проверить его фактическую регистрацию в данных менеджера сервиса.