Группа методов Bill внешнего программного интерфейса менеджера сервиса предназначена для работы со счетами клиентам.
Сводка по методам
| Метод | Назначение |
|---|---|
| bill/create | Создать новый счет на оплату |
| bill/create_subscription | Создать подписки на тарифы на основании счета на оплату |
| bill/email_create | Создание письма с запросом на оплату услуг |
| bill/info | Счет на оплату |
| bill/list | Cписок счетов на оплату |
| bill/update | Изменить счет на оплату |
| bill/file_token/upload | Получить талон на загрузку файла в счет на оплату. |
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 |
| - amount * | Число (+10.0) | Количество | 1 |
| - cost * | Число (+31.2) | Сумма | 2000 |
| - basis_id * | Строка переменная (9) | Код основания | 000000077 |
| services * | Услуги | ||
| - service | Строка переменная (1024) | Услуга | Консультации специалиста |
| - cost * | Число (+31.2) | Сумма | 2000 |
| files * | Файлы | ||
| - id | Строка фиксированная (36) | Идентификатор файла | 710e7a50-25b5-45e1-ab8a-3a0d657816ae |
| - name | Строка неограниченной длины | Описание файла | Счет.pdf |
| fields * | Дополнительные реквизиты | ||
| - 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 | Начало действия создаваемых подписок | 03.09.2025 0:00:00 |
| Ответ: subscription (0..*) | |||
| id | Строка переменная (9) | Номер созданной подписки | 000000002 |
bill/email_create
Создание письма с запросом на оплату услуг
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| servant | Число (+12.0) | Код ведущего абонента | 1000 |
| account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
| comment * | Строка неограниченной длины | Комментарий абонента | Просьба перед выставлением счета связаться со мной по телефону. |
| copy | Булево | Добавлять в копию абонента | true |
| Ответ: subscription (0..*) | |||
| Нет параметров | |||
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 |
| - amount * | Число (+10.0) | Количество | 1 |
| - cost * | Число (+31.2) | Сумма | 2000 |
| - basis_id * | Строка переменная (9) | Код основания | 000000077 |
| services | Список (0..*) | Услуги | |
| - service | Строка переменная (1024) | Услуга | Консультации специалиста |
| - cost * | Число (+31.2) | Сумма | 2000 |
| files | Список (0..*) | Файлы | |
| - id | Строка фиксированная (36) | Идентификатор файла | 710e7a50-25b5-45e1-ab8a-3a0d657816ae |
| - name | Строка неограниченной длины | Описание файла | Счет.pdf |
| fields | Список (0..*) | Дополнительные реквизиты | |
| - key | Строка переменная (100) | Имя реквизита | ТребуетсяПроверка |
| - name * | Строка переменная (75) | Заголовок реквизита | Требуется проверка |
| - value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
| - type | Строка (перечисление) | Тип реквизита:
| boolean |
| status * | Состояния счета на оплату | ||
| - name * | Строка (перечисление) | Имя состояния:
| paid |
| - error * | Булево | Признак ошибки | false |
| - description * | Строка неограниченной длины | Описание состояния | |
bill/list
Cписок счетов на оплату
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| 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/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 |
| - amount * | Число (+10.0) | Количество | 1 |
| - cost * | Число (+31.2) | Сумма | 2000 |
| - basis_id * | Строка переменная (9) | Код основания | 000000077 |
| services * | Услуги | ||
| - service | Строка переменная (1024) | Услуга | Консультации специалиста |
| - cost * | Число (+31.2) | Сумма | 2000 |
| files * | Файлы | ||
| - id | Строка фиксированная (36) | Идентификатор файла | 710e7a50-25b5-45e1-ab8a-3a0d657816ae |
| - name | Строка неограниченной длины | Описание файла | Счет.pdf |
| fields * | Дополнительные реквизиты | ||
| - key | Строка переменная (100) | Имя реквизита | ТребуетсяПроверка |
| - value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
| - type * | Строка (перечисление) | Тип реквизита:
| boolean |
| Ответ | |||
| id | Строка переменная (9) | Номер счета | 000000002 |
| bill_id | Строка фиксированная (36) | Идентификатор счета | e6e123dd-10ac-4e43-ab02-6a2b2b36140d |
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 * | Строка (перечисление) | Направление передачи данных:
| upload |
| token * | Строка переменная (64) | Талон на загрузку файла | bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb |
| url * | Строка неограниченной длины | Адрес для загрузки (PUT) | http://example.com/sm/hs/dt/upload/bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb |