Додавання / редагування партнера-контрагента¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP POST |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
|
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації |
Обов’язкові параметри, що передаються в тілі запиту (json) |
code, name, contactEmail |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
Опис json-параметрів запиту метода API (об’єкт Partner)
Таблиця 1 - Опис параметрів об’єкта Partner
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Partner |
||
partnerId |
long |
id контрагента-партнера |
accountId |
long |
id аккаунта |
code |
String |
код ЕДРПОУ |
name |
String |
назва компанїї |
contactPerson |
String |
ПІБ контактної особи |
contactEmail |
String |
Email контактної особи |
contactPhone |
String |
контактный телефон |
comment |
String |
коментар |
invitationDate |
long |
дата / час запрошення |
status |
int |
статус запрошення |
contractStatus |
int |
статус контракту (відмітка про те, що контрагент зареєстрований на платформі DOCflow); 1 - так, 0 - немає |
companyId |
long |
id компанії |
RESPONSE
Опис json-параметрів відповіді метода API (об’єкт Partner)
Таблиця 3 - Опис параметрів об’єкта Partner
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Partner |
||
partnerId |
long |
id контрагента-партнера |
accountId |
long |
id аккаунта |
code |
String |
код ЕДРПОУ |
name |
String |
назва компанїї |
contactPerson |
String |
ПІБ контактної особи |
contactEmail |
String |
Email контактної особи |
contactPhone |
String |
контактный телефон |
comment |
String |
коментар |
invitationDate |
long |
дата / час запрошення |
status |
int |
статус запрошення |
contractStatus |
int |
статус контракту (відмітка про те, що контрагент зареєстрований на платформі DOCflow); 1 - так, 0 - немає |
companyId |
long |
id компанії |
Приклади¶
Приклад тіла запиту (json):
{
"code": "3260408077",
"name": "Arsen",
"contactPerson": "Arsen contact-person",
"contactEmail": "007Arsen@gmail.com",
"contactPhone": "123244",
"comment": "запит",
}
Приклад тіла відповіді (json):
{
"partnerId": 762,
"accountId": 8,
"code": "3260408077",
"name": "Arsen",
"contactPerson": "Arsen contact-person",
"contactEmail": "007Arsen@gmail.com",
"contactPhone": "123244",
"comment": "запит",
"invitationDate": 1566223863,
"status": 2,
"contractStatus": 0,
"companyId": 0
}