Режим фокусировки

Расходы (expense)

Расходы (expense)

Результат: список элементов

В веб-интерфейсе платформы: раздел Финансы → Расходы в левом меню платформы.

Возвращает список расходов.

Уровень доступа: admin, user

ПараметрТипОбязательныйЗначение
idПоложительное целое числодаУникальный идентификатор расхода.
locale_nameСтрокадаНаименование расхода.
accountСтрокадаКлиент, со счёта которого произведено списание.
realdateДата и времядаДата списания. Формат: YYYY-MM-DD.
cdateДата и времянетДата оказания услуги (начало периода). Формат: YYYY-MM-DD.
amountСтрокадаСумма списания. Денежное значение с разделителем-точкой. Например, 15.00 Р.
notpaydСтроканетНеоплаченная часть расхода. Например, 43.00 Р.
discountamountСтроканетСумма скидки, предоставленной при списании средств. Например, 75.00 Р.
paymentsСтрокадаНомера платежей, которыми оплачен расход.
discountСтроканетКод предоставленной скидки. Возможные значения:
  • personal — персональная;
  • promo — скидка по акции;
  • globaldiscount — глобальная скидка.
taxamountСтроканетСумма налога.

Редактировать расход

Функция: expense.edit

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел Финансы → Расходы → выберите расход → кнопка Изменить.

Используется для просмотра, изменения и создания расхода.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаУникальный идентификатор расхода 
subaccountПоложительное целое числодаПровайдер (субаккаунт), к которому относится расход.
itemПоложительное целое числонетid услуги, за которую будет создан расход. Например, 2882.
operationСтроканетОперация, на основании которой будет создан расход.
amountСтрокадаСумма расхода. Денежное значение в формате с разделителем-точкой. Например, 15.00 Р.
taxrateСтроканет

Ставка налога в процентах. Сумма налога рассчитывается автоматически: 

СУММА - (СУММА / ((100 + СТАВКА) / 100)).

postpaidФлагнетЕсли опция установлена (on), при нехватке средств на счёте расход будет создан в долг.
nameСтроканетНаименование расхода. Если не указано, генерируется автоматически на основе операции.
realdateДата и времянетФактическая дата списания. Формат: YYYY-MM-DD.
cdateДата и времянетДата оказания услуги (начало периода). Формат: YYYY-MM-DD.
sokСтрокадаЗначение ok подтверждает выполнение операции. Без этого параметра изменения не будут применены.

Удалить расход

Функция: expense.delete

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел Финансы → Расходы → выберите расход → кнопка Удалить.

Удаляет расход. Поддерживает удаление нескольких расходов через запятую. Требуется подтверждение через параметр sok.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id расходов через запятую. Например, 123,456.
sokСтрокадаЗначение ok подтверждает выполнение операции. Без этого параметра изменения не будут применены.

Установить фильтр по клиенту

Функция: expense.setfilter

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел Финансы → Расходы → кнопка По клиенту.

Устанавливает фильтр по клиенту для списка расходов. Условия сохраняются и применяются при каждом отображении списка до изменения или сброса.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
accountСтроканетКлиент, со счёта которого произведено списание. Поддерживается подстановочный знак *. Например, client = *smith отфильтрует расходы всех клиентов, в наименовании которых есть smith: Blacksmith, Goldsmith, и т.д.
sokСтроканетЗначение ok подтверждает сохранение фильтра.

Войти в панель с правами пользователя

Функция: expense.su

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел Финансы → Расходы → выберите расход → кнопка Войти.

Авторизует администратора в панели управления с правами клиента, на которого оформлен расход.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid расхода, по которому необходимо выполнить вход.

Установить фильтр

Функция: expense.filter

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел Финансы → Расходы → меню Фильтр в списке расходов.

Устанавливает расширенный фильтр. Вы можете задать условия отбора для данного списка. Они будут применяться при его отображении до тех пор, пока фильтр не будет изменён или снят.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор расхода для фильтрации.
locale_nameСтроканетНаименование расхода. Поддерживается подстановочный знак *. Например, client = *smith отфильтрует расходы всех клиентов, в наименовании которых есть smith: Blacksmith, Goldsmith, и т.д.
accountСтроканетКлиент, со счёта которого произведено списание.
realdate.fromДата и времянетНачало диапазона дат списания. Формат: YYYY-MM-DD.
realdate.toДата и времянетКонец диапазона дат списания. Формат: YYYY-MM-DD.
amountСтроканетСумма списания. Поддерживаются операторы сравнения. Например, id = >100, client = smith отфильтрует всех клиентов, наименование которых Smith, кроме первых 100.
notpaydСтроканетНеоплаченная часть расхода.
paymentsСтроканетНомера платежей, которыми оплачен расход.
taxamountСтроканетСумма налога. Например, 220.00 Р.
resetФлагнетЗначение on сбрасывает все установленные фильтры.

Платежи

Распределить сумму расхода по платежам

Функция: expense.payment

Результат: список элементов

В веб-интерфейсе платформы: раздел Финансы → Расходы → выберите расход → кнопка Платежи.

Возвращает список привязок расхода к платежам с указанием суммы, списанной с каждого платежа.

Уровень доступа: admin, user

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid расхода, для которого необходимо показать распределение.

Создать или редактировать платежи

Функция: expense.payment.edit

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел Финансы → Расходы → выберите расход → кнопка Платежи → кнопка Создать.

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

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор расхода, к которому должен быть привязан платёж (элемент id из функции expense).
elidПоложительное целое числонетУникальный идентификатор привязки (элемент payment из функции expense.payment). Обязателен для изменения существующей записи.
paymentПоложительное целое числодаКод платежа, с которого будет списана часть суммы расхода.
amountСтрокадаСумма, которая будет списана с платежа. Денежное значение в формате с разделителем-точкой. Например, 15.00 Р.
sokСтрокадаЗначение ok подтверждает выполнение операции. Без этого параметра изменения не будут применены.

Удалить привязку

Функция: expense.payment.delete

Результат: успешное выполнение операции или сообщение об ошибке

В веб-интерфейсе платформы: раздел Финансы → Платежи → выберите платёж → кнопка Удалить.

Удаляет привязку части расхода к платежу. Поддерживает удаление нескольких записей через запятую. Требуется подтверждение через параметр sok.

Уровень доступа: admin

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько идентификаторов привязок (payment) через запятую. Например, 100,200.
sokСтрокадаЗначение ok подтверждает выполнение операции. Без этого параметра изменения не будут применены.