Плательщики¶
Карточка плательщика¶
URI: /BumsCrmApiV01/Payer/card.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|
Id |
integer |
Идентификатор плательщика |
|
ExtraFields |
array |
Список системных имен дополнительных полей ( см. https://help.megaplan.ru/API_payer_fieldslist ) |
Выходные данные¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор плательщика |
Name |
string |
Наименование плательщика |
Inn |
integer |
ИНН плательщика |
Kpp |
integer |
КПП плательщика |
LegalAddress |
string |
Юридический адрес |
Address |
string |
Фактический адрес |
Ogrn |
integer |
ОГРН |
CurrentAccount |
integer |
Номер счета |
Bank |
string |
Наименование банка |
CorrespondentAccount |
integer |
Номер корреспонденского счета |
Bik |
integer |
Бик |
Country[Id] |
integer |
Идентификатор страны |
Country[Name] |
string |
Название страны |
Country[Abbreviation] |
string |
Аббривеатура страны |
Изменение контрагента плательщика¶
URI: /BumsCrmApiV01/Payer/changeContractor.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
ContractorId |
integer |
ID текущего клиента плательщика |
PayerId |
integer |
ID плательщика |
NewContractorId |
integer |
ID нового клиента плательщика |
Список полей плательщика¶
URI: /BumsCrmApiV01/Payer/listFields.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
PayerType |
string |
Тип плательщика - юридическое лицо(Legal) или физическое лицо(Natural), по умолчанию или неверному параметры выставляется Legal |
CountryCode |
string |
Двух буквенный код страны по ISO 3166-1 Alpha-2 http://ru.wikipedia.org/wiki/ISO_3166-1, по умолчанию или неверному параметру выставляется код, который является системным по умолчанию. |
Выходные параметры (массив полей плательщика)¶
Параметр |
Тип |
Описание |
|---|---|---|
Fields |
array<(name, systemName, isBase, viewOnEdit)> |
Массив key value значений, где key может быть name - HR название поля, systemName - название поля в системе, isBase - базовое поле, показывать поле при редактировании плательщика. |
CountryCode |
string |
двух буквенный код страны по ISO 3166-1 Alpha-2 |
PayerType |
string |
тип плательщика - Legal(юридическое лицо) или Natural(физическое лицо) |
Список плательщиков¶
URI: /BumsCrmApiV01/Payer/list.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|
ExtraFields |
array |
Список системных имен дополнительных полей ( см. https://help.megaplan.ru/API_payer_fieldslist ) |
|
FilterFields[Contractor] |
integer |
Идентификатор клиента |
|
FilterFields[Inn] |
integer |
ИНН плательщика |
|
DroppedOnly |
bool |
Если true, вернутся только удаленные плательщики |
Выходные данные¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор плательщика |
Name |
string |
Наименование плательщика |
Inn |
integer |
ИНН плательщика |
Kpp |
integer |
КПП плательщика |
LegalAddress |
string |
Юридический адрес |
Address |
string |
Фактический адрес |
Ogrn |
integer |
ОГРН |
CurrentAccount |
integer |
Номер счета |
Bank |
string |
Наименование банка |
CorrespondentAccount |
integer |
Номер корреспонденского счета |
Bik |
integer |
Бик |
Редактирование/Создание плательщика¶
URI: /BumsCrmApiV01/Payer/save.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
ContractorId |
integer |
ID клиента, к которому относится плательщик |
PayerId |
integer |
ID плательшика. Если не указан, то будет создан новый плательщик |
PayerType |
string |
Тип клиента: Natural (физическое лицо) — по умолчанию, Legal (юридическое лицо) |
PayerCountry |
string |
Двухзначный код страны (RU, UA, KZ и др.), по умолчанию — страна, указанная в настройках аккаунта |
Model[FirstName] |
string |
Имя (для физического лица) |
Model[LastName] |
string |
Фамилия (для физического лица) |
Model[NaturalInn] |
integer |
ИНН плательщика (для физического лица) |
Model[Name] |
string |
Наименование организации (для юридического лица) |
Model[Inn] |
integer |
ИНН плательщика (для юридического лица) |
Model[Kpp] |
integer |
КПП плательщика (для юридического лица) |
Model[LegalAddress] |
string |
Юридический адрес (для юридического лица) |
Model[Address] |
string |
Фактический адрес (для юридического лица) |
Model[Ogrn] |
integer |
ОГРН (для юридического лица) |
Model[CurrentAccount] |
integer |
Номер счета (для юридического лица) |
Model[Bank] |
string |
Наименование банка (для юридического лица) |
Model[CorrespondentAccount] |
integer |
Номер корреспонденского счета (для юридического лица) |
Model[Bik] |
integer |
Бик (для юридического лица) |
Выходные данные¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID плательщика |