Документация BILLmanager 6 Startup, Advanced

API для интеграции с 1С

Статья описывает API интеграции BILLmanager с 1С. Порядок работы с API-функциями см. в статье Взаимодействие через API.

uploadcredit

Уровень доступа: сотрудник+

Выгружает список платежей.

Параметры
НаименованиеТипОбязательныйОписание

company 

целое положительное число

нет

id компании-получателя платежа

fromdate и todate

строка формата ГГГГ-ММ-ДД

нет

фильтр по дате поступления платежа

  • fromdate — начальная дата
  • todate — конечная дата

могут использоваться раздельно

programid 

строка (255 символов максимум)

нет

id, который передаётся в запросах set1cidbyinvoice или в set1cid параметром programid

позволяет плательщику иметь несколько id1c (id в 1C) в зависимости от programid

recipient 

целое положительное число

нет

id метода оплаты

Пример запроса
https://your.billmgr.com:1500/billmgr?func=uploadcredit&out=xml
Ответ

Наименование

Описание

amount

сумма платежа в валюте метода оплаты
billid код плательщика, от имени которого совершается оплата
cdateдата оплаты платежа
id1cid в 1C
name имя плательщика
numномер платежа
pnumномер документа, подтверждающего оплату; если его нет, то номер платежа
recipientid компании-получателя платежа
sdateдата создания платежа
taxставка налога, применяемая к платежу
taxamountсумма налога, рассчитанная по платежу
typeid метода оплаты
vatnumИНН компании, связанной с платежом

uploadcredit_paymethod

Уровень доступа: сотрудник+

Выгружает список платежей, объединённых по дням и платёжным системам, но не методам оплаты.

Параметры
Наименование

Тип

Обязательный

Описание

company_separatly

флаг

нет

значение on добавляет агрегирование по плательщикам (т.е. будет объединять по дням, платёжным системам и плательщикам)

company

целое положительное число

нет

id компании-получателя платежей

fromdate и todate

строка формата ГГГГ-ММ-ДД

нет

фильтр по дате поступления платежа

  • fromdate — начальная дата
  • todate — конечная дата

могут использоваться раздельно

по умолчанию для обоих параметров выставляется вчерашняя дата, также нельзя указать текущую дату

module

строка (32 символа максимум)

нет

название модуля платёжной системы (например, pmtinkoff)

paymethod

целое положительное число

нет

id метода оплаты

Пример запроса
https://your.billmgr.com:1500/billmgr?func=uploadcredit_paymethod&out=xml
Ответ
Наименование

Описание

amount

сумма всех платежей за день для данной платёжной системы (и плательщика, если company_separatly=on)

cdateдата оплаты платежа

module 

название модуля платёжной системы
paymethod id метода оплаты
recipient id компании-получателя платежей
sdate дата оплаты платежей
company_separatly=on добавляет
billidid плательщика в BILLmanager
id1cid плательщика в 1C
name

имя плательщика

vatnum

ИНН плательщика

uploadinvoice

Уровень доступа: сотрудник+

Выгружает список актов выполненных работ.

Параметры
НаименованиеТипОбязательныйОписание
contractsфлагнет

значение on добавляет в результат список договоров плательщика, для которых выставлен акт

fromdate и todateстрока формата ГГГГ-ММ-ДДнет

фильтр по дате поступления платежа

  • fromdate — начальная дата
  • todate — конечная дата

могут использоваться раздельно

itemparamsфлагнетзначение on добавляет параметры позиций
programid строка (255 символов максимум)нет

id, который передаётся в запросах set1cidbyinvoice или в set1cid параметром programid

позволяет плательщику иметь несколько id1c (id в 1C) в зависимости от programid

provider целое положительное числонет

id компании, выставившей акт выполненных работ

Ответ
НаименованиеОписание
billcodeномер акта
cdateдата выставления акта
billid id акта в BILLmanager
nameимя компании, выставившей акт выполненных работ
id1cid в 1C
vatnumИНН компании, выставившей акт выполненных работ
providerid компании, выставившей акт выполненных работ
profiletype

категория лица клиента

возможные значения:

  • 1 — физическое лицо
  • 2 — компания
  • 3 — индивидуальный предприниматель
source_numberномер исходного акта (для актов корректировки)
source_cdateдата выставления исходного акта (для актов корректировки)
serviceпозиция
возможные значения
idid типа продукта
nameописание услуги или выполненных работ
amountсумма по позиции
taxamountсумма налога по позиции
taxrateставка налога позиции
source_amount

сумма по позиции исходного акта (для актов корректировки)

source_taxamountсумма налога по позиции исходного акта (для актов корректировки)
source_taxrate

ставка налога по позиции исходного акта (для актов корректировки)

contracts

договоры для позиции, если установлен contracts=on

params

параметры позиции, если установлен itemparams=on

  • param — значение параметра,
    • атрибут name — имя параметра
taxrateставка налога в акте
taxamountсумма налога в акте
contracts=on добавляет
contracts

договоры для акта. contracts имеет атрибут number — номер договора

возможные значения

id

id договора в BILLmanager

number

номер договора

signdate

дата подписания

senddate

дата отправки оригинала договора клиенту

profile

плательщик, с которым заключён договор

companycontract

id образца договора в BILLmanager

comment

комментарий к договору

set1cid

Уровень доступа: сотрудник+

Задаёт плательщику в BILLmanager идентификатор от 1C.

Параметры
НаименованиеТипОбязательныйОписание
billid целое положительное числодаid плательщика в BILLmanager
id1cстрока (32 символа максимум)даid в 1C
programidстрока (255 символов максимум)нетдополнительный идентификатор, позволяющий задавать одному плательщику несколько идентификаторов из 1C
Пример запроса
https://your.billmgr.com:1500/billmgr?func=set1cid&billid=15&id1c=2

Ответ: без ответа или возвращает ошибку.

set1cidbyinvoice

Уровень доступа: сотрудник+

Задаёт плательщику в BILLmanager идентификатор от 1C. В отличие от set1cid, поиск плательщика выполняется по акту.

Параметры
НаименованиеТипОбязательныйОписание
date строка формата ГГГГ-ММ-ДДдадата выставления акта
id1c строка (32 символа максимум)даid в 1C
num строка (128 символов максимум)даномер акта
programid строка (255 символов максимум)нетдополнительный идентификатор, позволяющий задавать одному плательщику несколько идентификаторов из 1C

Ответ: без ответа или возвращает ошибку.