Перейти к содержанию

API Финансы+

API Справочник Финансы+

API Финансы+ имеет предсказуемые ресурсо-ориентированные URL-адреса, принимает тела запросов, кодируемые формой или JSON структурами, возвращает ответы, кодируемые JSON, и использует стандартные коды ответов HTTP и аутентификацию.

Для доступа к функциям API необходимо создать Ключ API (подробнее по работе с REST API в Битрикс24 читайте документацию), который вы можете использовать для аутентификации запроса.

Для доступа к методам API приложения Финансы+ используйте следующий формат:

curl -X GET \
  https://example.com/api/resource \
  -H "Authorization: Token YOUR_TOKEN_HERE"

В этом примере: - -X GET указывает метод HTTP, который вы хотите использовать (в данном случае GET). - https://example.com/api/resource — это URL, к которому вы обращаетесь. - -H "Authorization: <Ваш токен>" добавляет заголовок Authorization с вашим токеном. Замените YOUR_TOKEN_HERE на ваш фактический токен. Если вы используете другой метод, например POST, вы можете изменить -X GET на -X POST и добавить данные запроса, если это необходимо.

Приложение Финансы+ предоставляет API для управления следующими объектами:

  • act

    получение списка актов из приложения Финансы+

  • api

    получение общих финансовых показателей по компании

  • company

    получение данных по компании

  • contact

    получение данных по контакту

  • deal

    получение списка сделок

  • fin-org

    получение сведений по финансовой организации

  • fin-resp-center

    получение сведений по ЦФО

  • installment-plan

    создание рассрочки платежей

  • online-payment

    создание настройки онлайн-платежей

  • payment

    управление поступлением средств

  • spending

    управление расходами средств

  • bitrix_activity_handler

    запись логов по активности операций в Битрикс24

  • event-handler

    обработка события при установке приложения

  • installments

    управление рассрочками платежей в приложении Финансы+

  • invoice

    хранение и управление структурой Счет

  • payments

    управление поступлениями платежей в приложении Финансы+

  • run-sync

    синхронизацию полей в приложении Финансы+

  • verification-act

    проверяет правильное заполнение актов

  • webhook

    обрабатывать хук об успешном выполнении платежа

  • webhooks

    выполнять запросы для записи лога

Описание методов API

ACT (объект)

Объект АКТ подробная работа со списком Актов описана в документации в разделе Акты

Объект АКТ имеет следующую структуру

Наименование Тип данных Комментарии
contractor_company array Контрагент (объект компания)
contractor_contact array Контрагент (объект контакт)
date__gte string($date) Дата от (начало периода акта)
date__lte string($date) Дата до (окончание периода акта)
deal array Сделка (объект сделка)
deal_category array Направление (объект воронка)
deal_stage array Этап сделки (объект этап воронки)
edo string Идентификатор в ЭДО
format string Доступные значения : datatables, json
is_signed boolean Признак подписания контрагентом
page integer Номер страницы со списком актов
inline_field * string Наименование поля для выборки актов
inline_value * integer значение поля для выборки актов

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

get
/act/{inline_field}/{inline_value}/api/ 
curl -X GET \
  https://example.com/act/{inline_field}/{inline_value}/api/ \
  -H "Authorization: <Ваш токен>"

Метод GET получает на вход значения в переменных {inline_field} и {inline_value} и возвращает список актов в формате JSON (в примере запроса замените входные переменные конкретными значениями)

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

get
/act/api/

Метод GET возвращает полный список актов в формате JSON

curl -X GET \
  https://example.com/act/api/ \
  -H 'accept: application/json' \
  -H "Authorization: <Ваш токен>"

Метод GET возвращает полный список актов в формате JSON

Пример возвращаемой структуры ACT

Описание структуры:

count - количество возвращаемых записей. Целое число, показывает количество отобранных актов по запросу
next - ссылка на следующую страницу с записями актов
previous - ссылка на предыдущую страницу с записями актов
results

массив с объектами act

id - идентификатор акта

deal - сделка

bx_id - идентификатор сделки в Битрикс24
title - наименование сделки в Битрикс24

date - дата составления акта

contractor - контрагент
contractor_company - контрагент-компания

bx_id - идентификатор компании в справочнике компаний
title - наименование компании

contractor_contact - контрагент-контакт

bx_id - идентификатор контакта в справочнике контактов
full_name - полное имя контакта

amount - сумма акта
storage_type - тип акта
edo - идентификатор электронного документооборота
basis - формат хранения (база данных или JSON)
is_signed - признак подписи акта
file - файл с актом 

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 0,
      "deal": {
        "id": 0,
        "bx_id": 2147483647,
        "title": "string"
      },
      "date": "2025-04-10",
      "contractor": {
        "contractor_company": {
          "id": 0,
          "bx_id": 2147483647,
          "title": "string"
        },
        "contractor_contact": {
          "id": 0,
          "bx_id": 2147483647,
          "full_name": "string"
        }
      },
      "amount": "-23748334350072.0",
      "storage_type": "string",
      "edo": "string",
      "basis": "string",
      "is_signed": true,
      "file": "string"
    }
  ]
}

API (объект)

Объект API за счет наследования от 5 предков позволяет:

  • выяснить, что пользователь залогинен к CRM Битрикс24;
  • определить, включена ли интеграция, и переправить на заглушку если нет;
  • запустить дополнительные действия в хуке initialize (см. описание)
  • уточнить, имеет ли он доступ к функционалу;
  • проверить, доступен ли этот функционал в действующей подписке;

Получить финансовую статистику по компании

get
/api/total-report/stats/ 
curl -X GET \
  https://example.com/api/total-report/stats/ \
  -H 'accept: application/json' \
  -H "Authorization: <Ваш токен>"

Метод GET на вход не получает данных и возвращает основные статистические показатели финансового состояния компании в формате JSON.

Пример возвращаемой структуры API

Описание структуры:

payment_fact_amount - сумма фактически полученных платежей
invoice_amount - сумма выставленных счетов
installment_amount - сумма платежей по рассрочке
payment_plan_amount - сумма плановых поступлений
spending_fact_amount - сумма фактических расходов
spending_plan_amount - сумма запланированных расходов
balance_fact - сумма баланса фактическая
balance_plan - сумма баланса плановая 

{
  "payment_fact_amount": "402",
  "invoice_amount": "-04998460.9",
  "installment_amount": "46171.4",
  "payment_plan_amount": "8500",
  "spending_fact_amount": "-95",
  "spending_plan_amount": "6873",
  "balance_fact": "-01574995",
  "balance_plan": "-019."
}

COMPANY (объект)

Объект COMPANY содержит сведения о компании, хранящиеся в справочнике компаний CRM Битрикс24.

Объект COMPANY имеет следующую структуру

Наименование Тип данных Комментарии
bx_id integer идентификатор компании в базе данных Битрикс24
title string наименование компании
phone string контактный телефон компании
email string email компании в формате user@example.com
inn string ИНН компании

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

get
/api/v1/company/{bx_id}/ 
curl -X GET \
  https://example.com/api/v1/company/{bx_id}/ \
  -H 'accept: application/json' \
  -H "Authorization: <Ваш токен>"

Метод GET на вход получает идентификатор bx_id компании и возвращает основные данные о компании в формате JSON.

Пример возвращаемой структуры

Описание структуры:

bx_id - идентификатор компании в базе данных Битрикс24
title - наименование компании
phone - контактный телефон компании
email - email компании в формате user@example.com
inn - ИНН компании 

{
  "bx_id": 2147483647,
  "title": "string",
  "phone": "string",
  "email": "user@example.com",
  "inn": "string"
}

CONTACT (объект)

Объект CONTACT содержит сведения о контакте (физическое лицо), хранящиеся в справочнике контактов CRM Битрикс24.

Объект CONTACT имеет следующую структуру

Наименование Тип данных Комментарии
bx_id integer идентификатор контакта в базе данных Битрикс24
full_name string наименование контакта
phone string телефон контакта
email string email контакта в формате user@example.com
inn string ИНН контакта
comment string комментарии к контакту

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

get
/api/v1/contact/{bx_id}/ 
curl -X GET \
  https://example.com/api/v1/contact/{bx_id}/ \
  -H 'accept: application/json' \
  -H "Authorization: <Ваш токен>"

Метод GET на вход получает идентификатор bx_id контакта и возвращает основные данные о контакте в формате JSON.

Пример возвращаемой структуры

Описание структуры:

bx_id - идентификатор контакта в базе данных Битрикс24
full_name - полное наименование контакта
phone - контактный телефон контакта
email - email контакта в формате user@example.com
comment - комментарии к контакту
inn - ИНН контакта 

{
  "bx_id": 2147483647,
  "full_name": "string",
  "phone": "string",
  "email": "user@example.com",
  "comments": "string",
  "inn": "string"
}

DEAL (объект)

Объект DEAL содержит сведения о Сделке включая финансовые составляющие и сведения о контрагенте.

Объект DEAL имеет следующую структуру

Наименование Тип данных Комментарии
bx_id integer идентификатор сделки
contractor_company array Контрагент (объект компания)
contractor_contact array Контрагент (объект контакт)
first_payment_datetime date-time Дата первого платежа по сделке
payment_amount integer Сумма поступлений по сделке
spending_amount integer Сумма расходов по сделке

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

get
/api/v1/deal/list/ 
curl -X GET \
  https://example.com/api/v1/deal/list/?page=2' \
  -H 'accept: application/json' \
  -H "Authorization: <Ваш токен>"

Метод GET на вход может получать необязательный параметр page с номером страницы списка сделок и возвращает постраничный список сделок с указанием контрагентов в формате JSON.

Пример возвращаемой структуры

Описание структуры:

count - количество возвращаемых записей. Целое число, показывает количество отобранных сделок по запросу
next - ссылка на следующую страницу с записями сделок
previous - ссылка на предыдущую страницу с записями сделок
results

массив с объектами deal

bx_id - идентификатор сделки

company - контрагент-компания

bx_id - идентификатор компании в справочнике компаний
title - наименование компании
phone - контактный телефон компании
email - email компании в формате user@example.com
inn - ИНН компании

contact - контрагент-контакт

bx_id - идентификатор контакта в справочнике контактов
full_name - полное имя контакта
phone - контактный телефон контакта
email - email контакта в формате user@example.com
comment - комментарии к контакту
inn - ИНН контакта

first_payment_datetime - дата первого платежа по сделке
payment_amount - сумма сделки
spending_amount - сумма расходов по сделке 

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "bx_id": 2147483647,
      "company": {
        "bx_id": 2147483647,
        "title": "string",
        "phone": "string",
        "email": "user@example.com",
        "inn": "string"
      },
      "contacts": [
        {
          "bx_id": 2147483647,
          "full_name": "string",
          "phone": "string",
          "email": "user@example.com",
          "comments": "string",
          "inn": "string"
        }
      ],
      "first_payment_datetime": "2025-04-11T09:52:37.455Z",
      "payment_amount": "4304631.66",
      "spending_amount": "79803292656119383"
    }
  ]
}

FIN-ORG (объект)

Объект FIN-ORG содержит сведения о финансовых организациях, зарегистрированных в CRM Битрикс24 (подробнее о финансовых организациях компании смотрите документацию)

Объект FIN-ORG имеет следующую структуру

Наименование Тип данных Комментарии
bx_id integer идентификатор финансовой организации
name string наименование финансовой организации
cash_amount integer сумма поступлений по финансовой организации
cashless_amount integer сумма расходов по финансовой организации
phone string контактный телефон финансовой организации
email string email финансовой организации в формате user@example.com
inn string ИНН финансовой организации

Получить сведения о финансовой организации

get
/api/v1/fin-org/{bx_id}/ 
curl -X GET \
  https://example.com/api/v1/fin-org/{bx_id}/ \
  -H 'accept: application/json' \
  -H "Authorization: <Ваш токен>"

Метод GET на вход передает идентификатор финансовой организации и возвращает финансовые обороты по поступлению и расходу финансовой организации в формате JSON.

Обновить сведения по финансовой организации

get
/api/v1/fin-org/update/{bx_id}/ 

curl -X 'PATCH' \
  'https://example.org/api/v1/fin-resp-center/update/{bx-id}/' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: iBwM2TXXwrYIe5MI2QGpuhfQA7cznTNBEZ9i09onJe1PfMNrwPiaSPFms2' \
  -d '{
  "cash_amount": "259185367951331582",
  "cashless_amount": "2076848544"
}'
Метод PATCH на вход передает идентификатор финансовой организации, запускает процедуру пересчета оборотов финансовой организации и возвращает финансовые обороты по поступлению и расходу финансовой организации в формате JSON.

Пример возвращаемой структуры

Описание структуры:

name - наименование финансовой организации
cash_amount - сумма поступлений по финансовой организации
cashless_amount - сумма расходов по финансовой организации 

{
  "name": "string",
  "cash_amount": "289950746983.81",
  "cashless_amount": "-9094041556.83"
}

FIN-RESP-CENTER (объект)

Объект FIN-RESP-CENTER содержит сведения о центрах финансовой ответственности (ЦФО), зарегистрированных в CRM Битрикс24 (подробнее о центрах финансовой ответственности компании смотрите документацию)

Объект FIN-RESP-CENTER имеет следующую структуру

Наименование Тип данных Комментарии
bx_id integer идентификатор центра финансовой ответственности (ЦФО)
name string наименование ЦФО
cash_amount integer сумма поступлений по ЦФО
cashless_amount integer сумма расходов по ЦФО

Получить сведения по ЦФО

get
/api/v1/fin-resp-center/{bx_id}/ 
curl -X GET \
  https://example.com/api/v1/fin-resp-center/{bx_id}/ \
  -H 'accept: application/json' \
  -H "Authorization: <Ваш токен>"

Метод GET на вход передает идентификатор ЦФО и возвращает финансовые обороты по поступлению и расходу ЦФО в формате JSON.

Обновить сведения по ЦФО

get
/api/v1/fin-resp-center/update/{bx_id}/ 

curl -X 'PATCH' \
  'https://example.org//api/v1/fin-resp-center/update/{bx_id}/' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: iBwM2TXXwrYIe5MI2QGpuhfQA7cznTNBEZ9i09onJe1PfMNrwPiaSPFms2' \
  -d '{
  "cash_amount": "259185367951331582",
  "cashless_amount": "2076848544"
}'
Метод PATCH на вход передает идентификатор ЦФО, запускает процедуру пересчета оборотов ЦФО и возвращает финансовые обороты по поступлению и расходу ЦФО в формате JSON.

Пример возвращаемой структуры

Описание структуры:

name - наименование ЦФО
cash_amount - сумма поступлений по ЦФО
cashless_amount - сумма расходов по ЦФО 

{
  "name": "string",
  "cash_amount": "-3960025223225311945759771129.3",
  "cashless_amount": "852604"
}

INSTALLMENT-PLAN (объект)

Объект INSTALLMENT-PLAN содержит сведения по плану рассрочки платежей. (Подробнее по плану рассрочки можно посмотреть в документации.)

Объект INSTALLMENT-PLAN имеет следующую структуру

Наименование Тип данных Комментарии
deal__integration__endpoint string наименование сделки в которой создается план платежей
deal__bx_id string идентификатор сделки в которой создается план платежей
first_installment_date date дата первого платежа
first_payment_amount integer сумма первого платежа
installment_amount integer сумма периодического платежа
interval_value integer количество платежей за период
interval_type string наименование периода (day, month, year)
number_of_installments integer общее количество платежей
total_amount integer общая сумма рассрочки
account_all_payments boolean признак завершения рассрочки

Создать план рассрочки

get
/api/v1/installment-plan/create/ 
curl -X 'POST' \
  'https://example.org/api/v1/installment-plan/create/' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: iBwM2TXXwrYIe5MI2QGpuhfQA7cznTNBEZ9i09onJe1PfMNrwPiaSPFms2' \
  -d '{
  "deal__integration__endpoint": "string",
  "deal__bx_id": "string",
  "first_installment_date": "2025-04-11",
  "first_payment_amount": "02149230",
  "installment_amount": "-077141575789580651080.",
  "interval_value": 1,
  "interval_type": "days",
  "number_of_installments": 0,
  "total_amount": "-67864205334",
  "account_all_payments": false
}'

Метод POST на вход передает структуру плана рассрочки в JSON формате и в случае успешного выполнения задания (создание плана рассрочки) возвращает аналогичную структуру данных в формате JSON.

Пример возвращаемой структуры

Описание структуры:

deal__integration__endpoint - наименование сделки в которой создается план платежей
deal__bx_id - идентификатор сделки в которой создается план платежей
first_installment_date - дата первого платежа
first_payment_amount - сумма первого платежа
installment_amount - сумма периодического платежа
interval_value - количество платежей за период
interval_type - наименование периода (day, month, year)
number_of_installments - общее количество платежей
total_amount - общая сумма рассрочки
account_all_payments - признак завершения рассрочки 

{
  "deal__integration__endpoint": "string",
  "deal__bx_id": "string",
  "first_installment_date": "2025-04-11",
  "first_payment_amount": "331004176834818467986.",
  "installment_amount": "64586085311.",
  "interval_value": 1,
  "interval_type": "days",
  "number_of_installments": 0,
  "total_amount": "-3225048256305378804520750668.2",
  "account_all_payments": false
}

ONLINE-PAYMENT (объект)

Объект ONLINE-PAYMENT содержит сведения по подключенным средствам онлайн платежей в приложении Финансы+. (Подробнее по подключению и настройке онлайн платежей можно посмотреть в документации.)

Объект ONLINE-PAYMENT имеет следующую структуру

Наименование Тип данных Комментарии
online_payment_id integer идентификатор настройки онлайн платежа
success boolean признак успешной настройки
online_payment_url string ссылка на платежный сервис, настроенного способа онлайн платежа

Создать новую запись онлайн платежей

get
/api/v1/online-payment/client-create/ 
curl -X 'POST' \
  'https://example.org/api/v1/online-payment/{client-create}/' \
  -H 'accept: */*' \
  -H 'Authorization: <Ваш токен>' \
  -H 'X-CSRFTOKEN: iBwM2TXXwrYIe5MI2QGpuhfQA7cznTNBEZ9i09onJe1PfMNrwPiaSPFms2' \
  -d ''

Метод POST на вход не передает данных, при активации метода создается запись в базе данных с настройками выбранного способа приема онлайн платежей.

Получить данные о настройках способа онлайн платежей

get
/api/v1/online-payment/url/{online_payment_id}/ 
curl -X 'GET' \
  'https://example.org/api/v1/online-payment/url/1/' \
  -H 'accept: */*' \
  -H 'Authorization: <Ваш токен>'

Метод GET на вход передает идентификатор настройки онлайн платежа и возвращает сведения о настройках способа приема онлайн платежей в JSON формате.

Пример возвращаемой структуры

Описание структуры:

success - признак успешной настройки онлайн платежа
online_payment_url - ссылка на платежный сервис оператора приема онлайн платежей с идентификатором настроек 

{
  "success": true,
  "online_payment_url": "https://securepay.tinkoff.ru/new/UerrsSd"
}

PAYMENT (объект)

Объект PAYMENT содержит сведения о полученных платежах компанией. (Подробнее по работе с платежами в приложении Финансы+ смотрите документацию.)

Объект PAYMENT имеет следующую структуру

Наименование Тип данных Комментарии
id integer идентификатор платежа
company array Контрагент (объект компания)
contact array Контрагент (объект контакт)
datetime string($date) Дата платежа
deal_id integer идентификатор сделки, по которой выполнен платеж
status boolean статус платежа (поступил или нет)
refund boolean признак возврата платежа
amount integer сумма платежа
payment_type integer тип платежа (наличные/безналичные)
robot string категории платежей
fin_org array структура финансовой организации, по которой прошло зачисление

Создать новое поступление платежа

get
/api/v1/payment/create/ 
curl -X 'POST' \
  'https://example.org/api/v1/payment/create/' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: iBwM2TXXwrYIe5MI2QGpuhfQA7cznTNBEZ9i09onJe1PfMNrwPiaSPFms2' \
  -d '{
  "deal_id": 0,
  "datetime": "2025-04-11T13:35:39.364Z",
  "amount": "588685321759139.07",
  "payment_type": 1,
  "category_id": 0,
  "invoice_id": 0
}'

Метод POST на вход передает данные платежа в формате JSON:

  • deal_id - ссылка на сделку
  • datetime - время платежа
  • amount - сумма платежа
  • payment_type - тип платежа
  • category_id - категория платежа
  • invoice_id - ссылка на счет (основание платежа)

при активации метода создается запись в базе данных с платежом и при успешном завершении возвращается этаже структура данных в формате JSON.

Обновить данные платежа

get
/api/v1/payment/{id}/update/ 
curl -X 'PATCH' \
  'https://example.org/api/v1/payment/{id}/update/' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: iBwM2TXXwrYIe5MI2QGpuhfQA7cznTNBEZ9i09onJe1PfMNrwPiaSPFms2' \
  -d '{
  "deal_id": 0,
  "datetime": "2025-04-11T13:47:04.808Z",
  "amount": "-286547717175836.69",
  "invoice_id": 0
}'

Метод PATCH на вход передает в формате JSON:

  • deal_id - ссылка на сделку
  • datetime - время платежа
  • amount - сумма платежа
  • invoice_id - ссылка на счет (основание платежа)

Метод обновляет данные платежа с переданными параметрами и возвращает обновленные данные в JSON формате.

Получить список платежей

get
/api/v1/payment/list/ 
curl -X 'GET' \
  'https://example.org/api/v1/payment/list/?date_from=01.01.2025&date_to=10.04.2025&page=1' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>'

Метод GET на вход передает диапазон дат для получения списка платежей date_from=01.01.2025, date_to=10.04.2025 и номер страницы списка page=1. Метод возвращает список платежей за выбранный период в JSON формате.

Пример возвращаемой структуры

Описание структуры:

count - количество возвращаемых записей. Целое число, показывает количество отобранных сделок по запросу
next - ссылка на следующую страницу с записями сделок
previous - ссылка на предыдущую страницу с записями сделок
results

массив с объектами payment

id - идентификатор платежа datetime - дата платежа
status - статус платежа (поступил/не поступил)
refund - признак возврата платежа
amount - сумма платежа

company - контрагент-компания

bx_id - идентификатор компании в справочнике компаний
title - наименование компании
phone - контактный телефон компании
email - email компании в формате user@example.com
inn - ИНН компании

contact - контрагент-контакт

bx_id - идентификатор контакта в справочнике контактов
full_name - полное имя контакта
phone - контактный телефон контакта
email - email контакта в формате user@example.com
comment - комментарии к контакту
inn - ИНН контакта

deal_id - ссылка на сделку
payment_type - тип платежа
robot - категория платежа

fin-org - финансовая организация

параметры финансовой организации на которую выполнено зачисление средств
bx_id - идентификатор финансовой организации
title - наименование финансовой организации
phone - контактный телефон финансовой организации
email - email компании в формате user@example.com
inn - ИНН финансовой организации 

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 0,
      "datetime": "2025-04-11T13:41:56.325Z",
      "status": true,
      "refund": true,
      "amount": "-115145299016.7",
      "contacts": [
        {
          "bx_id": 2147483647,
          "full_name": "string",
          "phone": "string",
          "email": "user@example.com",
          "comments": "string",
          "inn": "string"
        }
      ],
      "company": {
        "bx_id": 2147483647,
        "title": "string",
        "phone": "string",
        "email": "user@example.com",
        "inn": "string"
      },
      "deal_id": "string",
      "payment_type": 1,
      "robot": "string",
      "fin_org": {
        "bx_id": 2147483647,
        "title": "string",
        "phone": "string",
        "email": "user@example.com",
        "inn": "string"
      }
    }
  ]
}

SPENDING (объект)

Объект SPENDING содержит сведения о расходах компании. (Подробнее по работе с расходами в приложении Финансы+ смотрите документацию.)

Объект SPENDING имеет следующую структуру

Наименование Тип данных Комментарии
id integer идентификатор расхода
fin_resp_center array центр финансовой ответственности (объект ЦФО)
payee_company array Контрагент (объект компания)
payee_contact array Контрагент (объект контакт)
date string($date) Дата платежа
deal array сделка
amount integer сумма платежа
spending_type array тип расхода
category array категория платежей
fin_org_account array счет финансовой организации, по которой прошла операция
discription string комментарии к расходу
status array статус расхода
payment_docs array свойства платежного документа
bitrix_user array пользователь Битрикс24
can_edit_actions string признак доступа к редактированию записи

Получить список расходов

get
/api/v1/spending/list/ 
curl -X 'GET' \
  'https://example.org/api/v1/spending/list/?deal_id=100&has_deal=true' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>'

Метод GET на вход передает данные для получения списка расходов в формате JSON:

  • deal_id - ссылка на сделку
  • date_from - время начала периода отображаемых записей расходов
  • date_to - время окончания периода отображаемых записей расходов
  • has_deal - признак привязки расхода к сделке
  • page - номер страницы загружаемого списка расходов

при отправке запроса GET без параметров, возвращается полный список расходов по компании. Данные возвращаются в формате JSON с учетом переданных параметров для выборки записей расходов.

Обновить данные по расходу

get
/api/v1/spending/update/{id}/ 
curl -X 'PATCH' \
  'https://example.org/api/v1/spending/update/{id}/' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: iBwM2TXXwrYIe5MI2QGpuhfQA7cznTNBEZ9i09onJe1PfMNrwPiaSPFms2' \
  -d '{
  "status": 200
}'

Метод PATCH на вход передает идентификатор расхода в строке запроса (заменить {id} на фактический идентификатор) и в теле запроса JSON структуру для обновления параметров записи Расходы {"status": 200}

Метод выполняет обновление записи расходов и возвращает результат в формате JSON:

{
  "id": 0,
  "status": 200,
  "payment_confirm_doc": "string"
}

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

get
/spending/{inline_field}/{inline_value}/api/ 
curl -X 'GET' \
  'https://example.org/spending/field1/11/api/?assigned_by=111&category=12&client_company=100&date__gte=01.01.2025&date__lte=10.04.2025&deal=100&deal_category=33&deal_stage=2&department=%D0%BF%D1%80%D0%BE%D0%B4%D0%B0%D0%B6%D0%B8&fin_org_account=3333&fin_resp_center=1&format=json&page=1&payee_company=1&source=11&spending_type=1&status=10' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>'

Метод GET на вход передает перечень критериев для получения списка платежей:

  • assigned_by - ФИО ответственного по сделке
  • category - Категория расходов
  • client_company - Компания-клиент
  • client_contact - Контакт-клиент
  • date__gte - Дата от
  • date__lte - Дата до
  • deal - Сделка
  • deal_category - Направление (наименование воронки)
  • deal_stage - Этап сделки
  • department - Отдел (по сделке)
  • fin_org_account - Счёт финансовой организации
  • fin_resp_center - ЦФО
  • format - JSON или datatables
  • page - номер страницы с результатами выборки расходов
  • payee_company - Компания-получатель
  • payee_contact - Контакт-получатель
  • source - Источник (из справочника источников Битрикс24)
  • spending_type - Тип расхода (1 - Наличные 2 - Безналичные 3 - Карта)
  • status - Статус расхода (10 - Выплачено 20 - Запланировано 30 - На согласовании 40 - Не согласована)
  • transit - Признак транзитного платежа
  • inline_field * - наименование поля для выборки
  • inline_value * - значение поля для выборки

Метод возвращает список расходов с указанными критериями в JSON формате.

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

get
/spending/api/ 
curl -X 'GET' \
  'https://example.org/spending/api/?assigned_by=111&category=12&client_company=100&date__gte=01.01.2025&date__lte=10.04.2025&deal=100&deal_category=33&deal_stage=2&department=%D0%BF%D1%80%D0%BE%D0%B4%D0%B0%D0%B6%D0%B8&fin_org_account=3333&fin_resp_center=1&format=json&page=1&payee_company=1&source=11&spending_type=1&status=10' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>'

Метод GET на вход передает перечень критериев для получения списка платежей:

  • assigned_by - ФИО ответственного по сделке
  • category - Категория расходов
  • client_company - Компания-клиент
  • client_contact - Контакт-клиент
  • date__gte - Дата от
  • date__lte - Дата до
  • deal - Сделка
  • deal_category - Направление (наименование воронки)
  • deal_stage - Этап сделки
  • department - Отдел (по сделке)
  • fin_org_account - Счёт финансовой организации
  • fin_resp_center - ЦФО
  • format - JSON или datatables
  • page - номер страницы с результатами выборки расходов
  • payee_company - Компания-получатель
  • payee_contact - Контакт-получатель
  • source - Источник (из справочника источников Битрикс24)
  • spending_type - Тип расхода (1 - Наличные 2 - Безналичные 3 - Карта)
  • status - Статус расхода (10 - Выплачено 20 - Запланировано 30 - На согласовании 40 - Не согласована)
  • transit - Признак транзитного платежа

Метод возвращает список расходов с указанными критериями в JSON формате.

Пример возвращаемой структуры

Описание структуры:

count - количество возвращаемых записей. Целое число, показывает количество отобранных сделок по запросу
next - ссылка на следующую страницу с записями сделок
previous - ссылка на предыдущую страницу с записями сделок
results

массив с объектами spending

id - идентификатор расхода

fin_resp_center - ЦФО

id - идентификатор ЦФО
name - наименование ЦФО

deal - сделка

id - идентификатор
bx_id - идентификатор сделки
title - наименование сделки

date - дата расходов
amount - сумма платежа

client - контрагент
payee_company - контрагент-компания

bx_id - идентификатор компании в справочнике компаний
title - наименование компании

payee_contact - контрагент-контакт

bx_id - идентификатор контакта в справочнике контактов
full_name - полное имя контакта

amount - сумма расходов

spending_type - тип расходов

id - идентификатор типа расходов
name - наименование типа расходов

category - категория расходов

id - идентификатор категории расходов
name - наименование категории расходов

description - описание расхода

status - статус расходов

id - идентификатор статуса
name - наименование статуса расходов

payment_docs - платежный документ

additionalProp1 - свойство платежного документа
additionalProp2 - свойство платежного документа
additionalProp3 - свойство платежного документа

bitrix_user - пользователь Битрикс24

bx_id - идентификатор пользователя
full_name - полное имя пользователя

fin-org-account - счет финансовой организации

id - идентификатор финансовой организации
name - наименование финансовой организации

can_edit_actions - признак доступности редактирования записи расходов 

{
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 0,
      "fin_resp_center": {
        "id": 0,
        "name": "string"
      },
      "deal": {
        "id": 0,
        "bx_id": 2147483647,
        "title": "string"
      },
      "date": "2025-04-11",
      "client": {
        "payee_company": {
          "id": 0,
          "bx_id": 2147483647,
          "title": "string"
        },
        "payee_contact": {
          "id": 0,
          "bx_id": 2147483647,
          "full_name": "string"
        }
      },
      "amount": "-42226065863.",
      "spending_type": {
        "id": 0,
        "name": "string"
      },
      "category": {
        "id": 0,
        "name": "string"
      },
      "description": "string",
      "status": {
        "id": 0,
        "name": "string"
      },
      "payment_docs": [
        {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      ],
      "bitrix_user": {
        "id": 0,
        "bx_id": 2147483647,
        "full_name": "string"
      },
      "fin_org_account": {
        "id": 0,
        "name": "string"
      },
      "can_edit_actions": "string"
    }
  ]
}

BITRIX_ACTIVITY_HANDLER (объект)

Объект BITRIX_ACTIVITY_HANDLER обеспечивает запись логов по активности операций в Битрикс24

Регистрация запросов с указанным идентификатором подписи

get
/bitrix_activity_handler/{signed_integration_id}/ 
curl -X 'POST' \
  'https://example.org/bitrix_activity_handler/{signed_integration_id}/' \
  -H 'accept: */*' \
  -H 'X-CSRFTOKEN: iBwM2TXXwrYIe5MI2NnMQGpuhfQA7cznTNBEZ9i09o01cnJe1PfMNrwPiaSPFms2' \
  -d ''

Метод POST на вход передает {signed_integration_id} и записывает в лог запись с указанным идентификатором. В случае успеха возвращает код 200.

EVENT-HANDLER (объект)

Объект EVENT-HANDLER обеспечивает обработку события OnAppInstall.

Событие вызывается после установки приложения и отправляет в теле запроса application_token и scope. Данное событие сохраняется в интеграцию.

application_token нужен в обработчиках других событий, чтобы удостовериться, что запрос отправляется из Битрикс24, к которому относится полученная интеграция. Более подробно тут:

Регистрация события установки приложения

get
/event-handler/on-app-install/ 
curl -X 'POST' \
  'https://example.org/event-handler/on-app-install/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRFTOKEN: iBwM2TXXwrYIe5MI2NnMQGpuhfQA7cznTNBEZ9i09o01cnJe1PfMNrwPiaSPFms2' \
  -d '{
  "event": "string",
  "data": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "auth": {
    "access_token": "string",
    "scope": "string",
    "client_endpoint": "string",
    "member_id": "string",
    "application_token": "string"
  }
}'

Метод POST на вход передает структуру JSON с параметрами приложения и уровнем доступа пользователя: 

{
  "event": "string",
  "data": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "auth": {
    "access_token": "string",
    "scope": "string",
    "client_endpoint": "string",
    "member_id": "string",
    "application_token": "string"
  }
}
метод регистрирует установку приложения и возвращает переданную структуру данных в формате JSON.

Пример возвращаемой структуры

Описание структуры:

event - название события

data - данные по событию

additionalProp1 - свойство 1
additionalProp2 - свойство 2
additionalProp3 - свойство 3

auth - параметры аутентификации

access_token - токен доступа
scope - наименование пространства
client_endpoint - наименование клиента
member_id - идентификатор клиента
application_token - токен приложения 

{
  "event": "string",
  "data": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "auth": {
    "access_token": "string",
    "scope": "string",
    "client_endpoint": "string",
    "member_id": "string",
    "application_token": "string"
  }
}

INSTALLMENTS (объект)

Объект INSTALLMENTS обеспечивает управление рассрочками платежей в приложении Финансы+

Возвращает список рассрочек

get
/installments/api/ 
curl -X 'GET' \
  'https://example.org/installments/api/?assigned_by=0' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>'

Метод GET на вход передает структуру JSON для определения условий выборки данных по рассрочкам:

  • assigned_by - Ответственный
  • client_company - Компания
  • client_contact - Контакт
  • date__gte - Дата от
  • date__lte - Дата до
  • deal - Сделка
  • deal_category - Направление (воронка)
  • deal_kassa_company - Компания для проведения платежей
  • deal_stage - Этап сделки
  • department - Отдел
  • format - (datatables, json)
  • installment_allocation_confings - Распределение платежей (признак распределения)
  • page - номер страницы со списком рассрочек
  • source - Источник

  • status - Статус

    • coming - Ожидается
    • partial - Оплачен частично
    • paid - Оплачен
    • overdue - Просрочен

  • transit_status - признак транзитных платежей

возвращает список с рассрочками в соответствии с выборкой заданной на входе в метод в формате JSON. Также за счёт наследования от 5 предков позволяет:

  • выяснить, что пользователь залогинен;
  • определить, включена ли интеграция, и отредиректить на заглушку если нет;
  • запустить дополнительные действия в хуке initialize (см. описание)
  • уточнить, имеет ли он доступ к функционалу;
  • проверить, доступен ли этот функционал в действующей подписке;

Пример возвращаемой структуры

Описание структуры:

count - количество возвращаемых записей. Целое число, показывает количество отобранных рассрочек по запросу
next - ссылка на следующую страницу с записями рассрочек
previous - ссылка на предыдущую страницу с записями рассрочек

results - список выбранных рассрочек

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

status - статус рассрочки

id - идентификатор статуса
name - наименование статуса расходов

date - дата рассрочки
amount - сумма рассрочки

deal - сделка

id - идентификатор
bx_id - идентификатор сделки
title - наименование сделки

paid_amount - уплаченная сумма
remain_to_pay - остаток до текущей оплаты
total_remain - общий остаток оплаты
first_debt_date - дата первого платежа
transit_part - транзитная часть платежа
primary_part - основная часть платежа 

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 0,
      "status": {
        "id": "string",
        "name": "string"
      },
      "date": "2025-04-11",
      "amount": "-3160615574",
      "deal": {
        "id": 0,
        "bx_id": 2147483647,
        "title": "string"
      },
      "paid_amount": "string",
      "remain_to_pay": "-16019564843120044752.57",
      "total_remain": "2869839943187.3",
      "first_debt_date": "2025-04-11",
      "transit_part": "9337384075532269867309.7",
      "primary_part": "759313457"
    }
  ]
}

INVOICE (объект)

Объект INVOICE обеспечивает хранение и управление структурой Счет

Возвращает список счетов

get
/invoice/api/ 
curl -X 'GET' \
  'https://example.org/invoice/api/' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>'

Метод GET на вход передает структуру JSON для определения условий выборки данных по счетам:

  • assigned_by - Ответственный
  • client_company - Компания
  • client_contact - Контакт
  • date__gte - Дата от
  • date__lte - Дата до
  • deal - Сделка
  • format - (datatables, json)
  • page - номер страницы со списком счетов

возвращает список счетов в соответствии с выборкой заданной на входе в метод в формате JSON. Также за счёт наследования от 5 предков позволяет:

  • выяснить, что пользователь залогинен;
  • определить, включена ли интеграция, и отредиректить на заглушку если нет;
  • запустить дополнительные действия в хуке initialize (см. описание)
  • уточнить, имеет ли он доступ к функционалу;
  • проверить, доступен ли этот функционал в действующей подписке;

Пример возвращаемой структуры

Описание структуры:

count - количество возвращаемых записей. Целое число, показывает количество отобранных счетов по запросу
next - ссылка на следующую страницу с записями счетов
previous - ссылка на предыдущую страницу с записями счетов

results - список выбранных счетов

id - идентификатор счета
begindate - дата счета
opportunity - сумма счета для оплаты

deal - сделка

id - идентификатор
bx_id - идентификатор сделки
title - наименование сделки

stage - состояние оплаты

name - наименование состояния оплаты счета 

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 0,
      "begindate": "2025-04-11T18:00:16.006Z",
      "opportunity": "929366178606",
      "deal": {
        "id": 0,
        "bx_id": 2147483647,
        "title": "string"
      },
      "stage": {
        "name": "string"
      }
    }
  ]
}

PAYMENTS (объект)

Объект PAYMENTS обеспечивает управление поступлениями платежей в приложении Финансы+

Возвращает список платежей

get
/payments/api/ 
curl -X 'GET' \
  'https://example.org/payments/api/' \
  -H 'accept: application/json' \
  -H 'Authorization: <Ваш токен>'

Метод GET на вход передает структуру JSON для определения условий выборки данных по платежам:

  • assigned_by - Ответственный
  • category - Категория платежей
  • client_company - Компания
  • client_contact - Контакт
  • date__gte - Дата от
  • date__lte - Дата до
  • deal - Сделка
  • deal_category - Направление (воронка)
  • deal_kassa_company - Компания для проведения платежей
  • deal_stage - Этап сделки
  • deals_in_date_range - Признак новой сделки за период
  • department - Отдел
  • fin_org_account - Счёт финансовой организации
  • fin_resp_center - ЦФО
  • format - (datatables, json)
  • fully_paid - Полностью оплачен
  • page - номер страницы со списком платежей
  • payment_type - 1 - Наличные 2 - Безналичные 3 - Онлайн оплата 4 - Возврат средств
  • source - Источник
  • transit_status - признак транзитных платежей

возвращает список с рассрочками в соответствии с выборкой заданной на входе в метод в формате JSON. Также за счёт наследования от 5 предков позволяет:

  • выяснить, что пользователь залогинен;
  • определить, включена ли интеграция, и отредиректить на заглушку если нет;
  • запустить дополнительные действия в хуке initialize (см. описание)
  • уточнить, имеет ли он доступ к функционалу;
  • проверить, доступен ли этот функционал в действующей подписке;

Пример возвращаемой структуры

Описание структуры:

count - количество возвращаемых записей. Целое число, показывает количество отобранных рассрочек по запросу
next - ссылка на следующую страницу с записями рассрочек
previous - ссылка на предыдущую страницу с записями рассрочек

results - список выбранных платежей

id - идентификатор поступления

fin-org - финансовая организация

id - идентификатор финансовой организации
name - наименование финансовой организации

fin-org-account - счет финансовой организации

id - идентификатор счета финансовой организации
name - номер счета финансовой организации

fin-resp-center - ЦФО

id - идентификатор ЦФО
name - наименование ЦФО

deal - сделка

id - идентификатор
bx_id - идентификатор сделки
title - наименование сделки

deal_stage - состояние сделки в воронке

category - категория платежа

id - идентификатор категории
name - наименование категории платежа

payment_type - тип платежа

id - идентификатор типа платежа
name - наименование типа платежа

datetime - дата платежа
amount - сумма платежа
description - описание платежа
is_receipt - признак наличия чека

bitrix_user - пользователь Битрикс

id - идентификатор
bx_id - идентификатор пользователя
full_name - наименование пользователя 

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 0,
      "fin_org": {
        "id": 0,
        "name": "string"
      },
      "fin_org_account": {
        "id": 0,
        "name": "string"
      },
      "fin_resp_center": {
        "id": 0,
        "name": "string"
      },
      "deal": {
        "id": 0,
        "bx_id": 2147483647,
        "title": "string"
      },
      "deal_stage": "string",
      "category": {
        "id": 0,
        "name": "string"
      },
      "datetime": "2025-04-11T18:22:52.497Z",
      "payment_type": {
        "id": 0,
        "name": "string"
      },
      "amount": "-3363575529.4",
      "description": "string",
      "is_receipt": true,
      "bitrix_user": {
        "id": 0,
        "bx_id": 2147483647,
        "full_name": "string"
      }
    }
  ]
}

RUN-SYNC (объект)

Объект RUN-SYNC обеспечивает синхронизацию полей в приложении Финансы+ с полями CRM Битрикс24.

Запустить синхронизацию полей приложения с Битрикс24

get
/run-sync/ 
curl -X 'POST' \
  'https://example.org/run-sync/' \
  -H 'accept: */*' \
  -H 'Authorization: <Ваш токен>' \
  -H 'X-CSRFTOKEN: WeLOeCO2M78BEx83JjmnHFjnssaDOsrlssk4litRpfrKENbz6GrEX7lFlPbNGIdP' \
  -d ''

Метод POST активизирует процесс синхронизации полей приложения Финансы+ с полями CRM Битрикс24, а также за счёт наследования от 5 предков позволяет:

  • выяснить, что пользователь залогинен;
  • определить, включена ли интеграция, и отредиректить на заглушку если нет;
  • запустить дополнительные действия в хуке initialize (см. описание)
  • уточнить, имеет ли он доступ к функционалу;
  • проверить, доступен ли этот функционал в действующей подписке;

VERIFICATION-ACT (объект)

Объект VERIFICATION-ACT позволяет проверять правильное заполнение структуры актов в приложении Финансы+

Проверить правильное заполнение актов

get
/verification-act/api/ 
curl -X 'GET' \
  'https://example.org/verification-act/api/?format=datatables' \
  -H 'accept: */*' \
  -H 'Authorization: <Ваш токен>'

Метод GET на вход передает формат хранения актов json или datatables, выполняет проверку актов и возвращает статус выполненной операции. Также за счёт наследования от 5 предков позволяет:

  • выяснить, что пользователь залогинен;
  • определить, включена ли интеграция, и отредиректить на заглушку если нет;
  • запустить дополнительные действия в хуке initialize (см. описание)
  • уточнить, имеет ли он доступ к функционалу;
  • проверить, доступен ли этот функционал в действующей подписке;

WEBHOOK (объект)

Объект WEBHOOK позволяет обрабатывать хук от Финансов+ (bitrix_kassa) об успешном выполнении платежа.

Проверить

get
/webhook/subscription/success/ 

curl -X 'POST' \
  'https://example.org/webhook/subscription/success/' \
  -H 'accept: */*' \
  -H 'Authorization: <Ваш токен>' \
  -H 'X-CSRFTOKEN: WeLOeCO2M78BEx83JjFjnssaDOsrlssk4litRpfrKENbz6GrEX7lFlPbNGIdP' \
  -d ''
Данные для отправки создаются в виде success_webhook_token, токен должен представлять собой словарь и быть подписан стандартными джановскими средствами.

WEBHOOKS (объект)

Объект WEBHOOKS позволяет выполнять запросы для записи лога по выполненным WEBHOOKS

Проверить

get
/webhooks/bx24/{signed_integration_id}/ 
curl -X 'POST' \
  'https://example.org/webhooks/bx24/{signed_integration_id}/' \
  -H 'accept: */*' \
  -H 'X-CSRFTOKEN: WeLOeCO2M78BEx83JjmnHFjnssaDOsrlssk4litRpfrKENbz6GrEX7lFlPbNGIdP' \
  -d ''

На вход в метод передается {signed_integration_id} и выполняется запрос. При успешном выполнении возвращается статус OK.