Bill — cчета клиентам

Группа методов Bill внешнего программного интерфейса менеджера сервиса предназначена для работы со счетами клиентам.

Сводка по методам

Метод	Назначение
bill/create	Создать новый счет на оплату
bill/create_subscription	Создать подписки на тарифы на основании счета на оплату
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)	Имя реквизита	Требуется заполнение данных абонента
- name *	Строка переменная (75)	Заголовок реквизита	Требуется заполнение данных абонента
- value *	Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево	Значение реквизита	true
- type	Строка (перечисление)	Тип реквизита: additional_value (Дополнительное значение) additional_value_group (Дополнительное значение (иерархия)) boolean (Строка) date (Строка) decimal (Строка) service (Строка) service_provider_tariff (Строка) string (Строка) subscriber (Строка) subscription (Строка) tariff (Строка) tariff_period (Строка) user (Строка)	boolean
Ответ
id	Строка переменная (9)	Номер счета	000000002
bill_id	Строка фиксированная (36)	Идентификатор счета	e6e123dd-10ac-4e43-ab02-6a2b2b36140d

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/bill/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
  "seller_id": 1000,
  "customer_id": 2000,
  "renewal": true,
  "total_cost": 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": "512",
      "servant_tariff_id": "00007",
      "period_id": "1MN",
      "amount": 1,
      "cost": 2000,
      "basis_id": "000000077"
    }
  ],
  "services": [
    {
      "service": "Консультации специалиста",
      "cost": 2000
    }
  ],
  "files": [
    {
      "id": "710e7a50-25b5-45e1-ab8a-3a0d657816ae",
      "name": "Счет.pdf"
    }
  ],
  "fields": [
    {
      "key": "Требуется заполнение данных абонента",
      "name": "Требуется заполнение данных абонента",
      "value": true,
      "type": "boolean"
    }
  ],
  "auth": {
    "account": 1000
  }
}

Пример ответа Развернуть

{
  "id": "000000002",
  "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

bill/create_subscription

Создать подписки на тарифы на основании счета на оплату

Параметр	Тип	Описание	Пример
Запрос
id *	Строка переменная (9)	Номер счета для поиска. Обязательно, если не указан идентификатор счета.	000000002
bill_id *	Строка фиксированная (36)	Идентификатор счета для поиска. Обязательно, если не указан номер счета.	e6e123dd-10ac-4e43-ab02-6a2b2b36140d
start *	Дата и время в строке формата ISO	Начало действия создаваемых подписок	20.09.2024 0:00:00
Ответ: subscription (0..*)
id	Строка переменная (9)	Номер созданной подписки	000000002

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/bill/create_subscription
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000002",
  "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
  "start": "2024-09-20T00:00:00",
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "subscription": [
    {
      "id": "000000002"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

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	Строка (перечисление)	Тип реквизита: additional_value (Дополнительное значение) additional_value_group (Дополнительное значение (иерархия)) boolean (Строка) date (Строка) decimal (Строка) service (Строка) service_provider_tariff (Строка) string (Строка) subscriber (Строка) subscription (Строка) tariff (Строка) tariff_period (Строка) user (Строка)	boolean
status *		Состояния счета на оплату
- name *	Строка (перечисление)	Имя состояния: billing_error (Ошибка выставления счета) created (Создан) paid (Оплачено) wait_payment (Ожидание оплаты) wait_registration (Ожидание оформления) wait_sending (Ожидание отправки)	paid
- error *	Булево	Признак ошибки	false
- description *	Строка неограниченной длины	Описание состояния

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/bill/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000002",
  "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "bill": {
    "id": "000000002",
    "created": "2020-07-28T00:00:00",
    "modified": "2020-07-30T00:00:00",
    "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
    "seller_id": 1000,
    "customer_id": 2000,
    "renewal": true,
    "total_cost": 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": "512",
        "servant_tariff_id": "00007",
        "period_id": "1MN",
        "amount": 1,
        "cost": 2000,
        "basis_id": "000000077"
      }
    ],
    "services": [
      {
        "service": "Консультации специалиста",
        "cost": 2000
      }
    ],
    "files": [
      {
        "id": "710e7a50-25b5-45e1-ab8a-3a0d657816ae",
        "name": "Счет.pdf"
      }
    ],
    "fields": [
      {
        "key": "Требуется заполнение данных абонента",
        "name": "Требуется заполнение данных абонента",
        "value": true,
        "type": "boolean"
      }
    ],
    "status": {
      "name": "paid",
      "error": false,
      "description": ""
    }
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

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 *	Строка неограниченной длины	Комментарий счета	Комментарий счета на оплату

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/bill/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "bill": [
    {
      "id": "000000002",
      "created": "2020-07-28T00:00:00",
      "modified": "2020-07-30T00:00:00",
      "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
      "seller_id": 1000,
      "customer_id": 2000,
      "renewal": true,
      "total_cost": 4000,
      "payment_link": "https://money.yandex.ru/api-pages/v2/payment-confirm/epl?orderId=26bcb3ac-000f-5000-8000-178abf269371",
      "paid": false,
      "add_info": "",
      "comment": "Комментарий счета на оплату"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

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)	Имя реквизита	Требуется заполнение данных абонента
- name *	Строка переменная (75)	Заголовок реквизита	Требуется заполнение данных абонента
- value *	Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево	Значение реквизита	true
- type	Строка (перечисление)	Тип реквизита: additional_value (Дополнительное значение) additional_value_group (Дополнительное значение (иерархия)) boolean (Строка) date (Строка) decimal (Строка) service (Строка) service_provider_tariff (Строка) string (Строка) subscriber (Строка) subscription (Строка) tariff (Строка) tariff_period (Строка) user (Строка)	boolean
Ответ
id	Строка переменная (9)	Номер счета	000000002
bill_id	Строка фиксированная (36)	Идентификатор счета	e6e123dd-10ac-4e43-ab02-6a2b2b36140d

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/bill/update
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000002",
  "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
  "seller_id": 1000,
  "customer_id": 2000,
  "renewal": true,
  "total_cost": 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": "512",
      "servant_tariff_id": "00007",
      "period_id": "1MN",
      "amount": 1,
      "cost": 2000,
      "basis_id": "000000077"
    }
  ],
  "services": [
    {
      "service": "Консультации специалиста",
      "cost": 2000
    }
  ],
  "files": [
    {
      "id": "710e7a50-25b5-45e1-ab8a-3a0d657816ae",
      "name": "Счет.pdf"
    }
  ],
  "fields": [
    {
      "key": "Требуется заполнение данных абонента",
      "name": "Требуется заполнение данных абонента",
      "value": true,
      "type": "boolean"
    }
  ],
  "auth": {
    "account": 1000
  }
}

Пример ответа Развернуть

{
  "id": "000000002",
  "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

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 *	Строка (перечисление)	Направление передачи данных: download (Скачивание файла) upload (Загрузка файла)	upload
token *	Строка переменная (64)	Талон на загрузку файла	bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb
url *	Строка неограниченной длины	Адрес для загрузки (PUT)	http://example.com/sm/hs/dt/upload/bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/bill/file_token/upload
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000002",
  "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
  "name": "bill.pdf",
  "size": 52428800,
  "auth": {
    "account": 1000
  }
}

Пример ответа Развернуть

{
  "id": "000000002",
  "bill_id": "e6e123dd-10ac-4e43-ab02-6a2b2b36140d",
  "direction": "upload",
  "token": "bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb",
  "url": "http://example.com/sm/hs/dt/upload/bacff7f85e0fec5a0aba0b7a2e705a7c09b352dc196b45cab40897aae42a59eb",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх