GetCounteragent¶

Метод GetCounteragent возвращает информацию о контрагенте.

Версии метода:

v2 — возвращает для контрагента только видимые подразделения и их родительские подразделения.
v1 — возвращает все подразделения контрагента.

v2¶

GET /V2/GetCounteragent¶

Query Parameters:

myOrgId – идентификатор организации, для которой осуществляется поиск контрагента.
counteragentOrgId – идентификатор организации-контрагента.

Request Headers:

Authorization – данные, необходимые для авторизации.

Status Codes:

200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
402 Payment Required – у организации с указанным идентификатором myOrgId закончилась подписка на API.
403 Forbidden – доступ к списку контрагентов организации myOrgId с предоставленным авторизационным токеном запрещен.
404 Not Found – партнерские отношения между организациями myOrgId и counteragentOrgId не установлены.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит информацию о контрагенте с идентификатором counteragentOrgId для организации myOrgId, представленную структурой Counteragent. Вложенная в нее структура Counteragent.Organization.Departments содержит только видимые подразделения и их родительские подразделения.

Пользователь имеет право запрашивать и производить действия со списком контрагентов организации myOrgId, если у него есть доступ к ящику этой организации.

v1¶

GET /GetCounteragent¶

Query Parameters:

myOrgId – идентификатор организации, для которой осуществляется поиск контрагента.
counteragentOrgId – идентификатор организации-контрагента.

Request Headers:

Authorization – данные, необходимые для авторизации.

Status Codes:

200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
402 Payment Required – у организации с указанным идентификатором myOrgId закончилась подписка на API.
403 Forbidden – доступ к списку контрагентов организации myOrgId с предоставленным авторизационным токеном запрещен.
404 Not Found – партнерские отношения между организациями myOrgId и counteragentOrgId не установлены.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит информацию о контрагенте с идентификатором counteragentOrgId для организации myOrgId, представленную структурой Counteragent.

Пользователь имеет право запрашивать и производить действия со списком контрагентов организации myOrgId, если у него есть доступ к ящику этой организации.