API для интеграции с 1С
Статья описывает API интеграции BILLmanager с 1С. Порядок работы с API-функциями см. в статье Взаимодействие через API.
uploadcredit
Уровень доступа: сотрудник+
Выгружает список платежей.
| Параметры | |||
|---|---|---|---|
| Наименование | Тип | Обязательный | Описание |
company | целое положительное число | нет | id компании-получателя платежа |
fromdate и todate | строка формата ГГГГ-ММ-ДД | нет | фильтр по дате поступления платежа
могут использоваться раздельно |
programid | строка (255 символов максимум) | нет | id, который передаётся в запросах set1cidbyinvoice или в set1cid параметром programid позволяет плательщику иметь несколько id1c (id в 1C) в зависимости от programid |
recipient | целое положительное число | нет | id метода оплаты |
Пример запроса
| Ответ | |
|---|---|
Наименование | Описание |
amount | сумма платежа в валюте метода оплаты |
| billid | код плательщика, от имени которого совершается оплата |
| cdate | дата оплаты платежа |
| id1c | id в 1C |
| name | имя плательщика |
| num | номер платежа |
| pnum | номер документа, подтверждающего оплату; если его нет, то номер платежа |
| recipient | id компании-получателя платежа |
| sdate | дата создания платежа |
| tax | ставка налога, применяемая к платежу |
| taxamount | сумма налога, рассчитанная по платежу |
| type | id метода оплаты |
| vatnum | ИНН компании, связанной с платежом |
uploadcredit_paymethod
Уровень доступа: сотрудник+
Выгружает список платежей, объединённых по дням и платёжным системам, но не методам оплаты.
| Параметры | |||
|---|---|---|---|
| Наименование | Тип | Обязательный | Описание |
| company_separatly | флаг | нет | значение on добавляет агрегирование по плательщикам (т.е. будет объединять по дням, платёжным системам и плательщикам) |
company | целое положительное число | нет | id компании-получателя платежей |
fromdate и todate | строка формата ГГГГ-ММ-ДД | нет | фильтр по дате поступления платежа
могут использоваться раздельно по умолчанию для обоих параметров выставляется вчерашняя дата, также нельзя указать текущую дату |
| module | строка (32 символа максимум) | нет | название модуля платёжной системы (например, pmtinkoff) |
paymethod | целое положительное число | нет | id метода оплаты |
Пример запроса
| Ответ | ||
|---|---|---|
| Наименование | Описание | |
| amount | сумма всех платежей за день для данной платёжной системы (и плательщика, если company_separatly=on) | |
| cdate | дата оплаты платежа | |
module | название модуля платёжной системы | |
| paymethod | id метода оплаты | |
| recipient | id компании-получателя платежей | |
| sdate | дата оплаты платежей | |
| company_separatly=on добавляет | ||
| billid | id плательщика в BILLmanager | |
| id1c | id плательщика в 1C | |
| name | имя плательщика | |
| vatnum | ИНН плательщика | |
uploadinvoice
Уровень доступа: сотрудник+
Выгружает список актов выполненных работ.
| Параметры | |||
|---|---|---|---|
| Наименование | Тип | Обязательный | Описание |
| contracts | флаг | нет | значение on добавляет в результат список договоров плательщика, для которых выставлен акт |
| fromdate и todate | строка формата ГГГГ-ММ-ДД | нет | фильтр по дате поступления платежа
могут использоваться раздельно |
| itemparams | флаг | нет | значение on добавляет параметры позиций |
| programid | строка (255 символов максимум) | нет | id, который передаётся в запросах set1cidbyinvoice или в set1cid параметром programid позволяет плательщику иметь несколько id1c (id в 1C) в зависимости от programid |
| provider | целое положительное число | нет | id компании, выставившей акт выполненных работ |
| Ответ | |||
|---|---|---|---|
| Наименование | Описание | ||
| billcode | номер акта | ||
| cdate | дата выставления акта | ||
| billid | id акта в BILLmanager | ||
| name | имя компании, выставившей акт выполненных работ | ||
| id1c | id в 1C | ||
| vatnum | ИНН компании, выставившей акт выполненных работ | ||
| provider | id компании, выставившей акт выполненных работ | ||
| profiletype | категория лица клиента возможные значения:
| ||
| source_number | номер исходного акта (для актов корректировки) | ||
| source_cdate | дата выставления исходного акта (для актов корректировки) | ||
| service | позиция | ||
| возможные значения | |||
| id | id типа продукта | ||
| name | описание услуги или выполненных работ | ||
| amount | сумма по позиции | ||
| taxamount | сумма налога по позиции | ||
| taxrate | ставка налога позиции | ||
| source_amount | сумма по позиции исходного акта (для актов корректировки) | ||
| source_taxamount | сумма налога по позиции исходного акта (для актов корректировки) | ||
| source_taxrate | ставка налога по позиции исходного акта (для актов корректировки) | ||
| contracts | договоры для позиции, если установлен contracts=on | ||
| params | параметры позиции, если установлен itemparams=on
| ||
| 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 |
Пример запроса
Ответ: без ответа или возвращает ошибку.
set1cidbyinvoice
Уровень доступа: сотрудник+
Задаёт плательщику в BILLmanager идентификатор от 1C. В отличие от set1cid, поиск плательщика выполняется по акту.
| Параметры | |||
|---|---|---|---|
| Наименование | Тип | Обязательный | Описание |
| date | строка формата ГГГГ-ММ-ДД | да | дата выставления акта |
| id1c | строка (32 символа максимум) | да | id в 1C |
| num | строка (128 символов максимум) | да | номер акта |
| programid | строка (255 символов максимум) | нет | дополнительный идентификатор, позволяющий задавать одному плательщику несколько идентификаторов из 1C |
Ответ: без ответа или возвращает ошибку.