Counterparties API

Группа методов для работы со списком контрагентов (Адресная книга) и выполнения обмена приглашениями.

Описание методов

Данный блок содержит подробное описание по каждому методу API.

[GET]/api/v1/blockedOrganizations

Получение списка заблокированных организаций (чёрный список).

Основной сценарий Получить список контрагентов, добавленных в чёрный список.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
filter	Нет	Query	string	Поисковое значение (например ИНН, КПП или наименование контрагента).
offset	Нет	Query	integer(int32)	Начальное значение списка.
count	Нет	Query	integer(int32)	Количество выводимых значений (По умолчанию: 15).

Возможные ответы метода

Код	Тип	Описание
200	BlockedOrganizationResultList	Список контрагентов, с которыми заблокирована связь (основная информация).
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
      "blockedBy": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
      "name": "Строка",
      "inn": "Строка",
      "kpp": "Строка",
      "blockingDate": "2022-02-11T13:03:05.670Z"
    }
  ]
}

[DELETE]/api/v1/blockedOrganizations

Разблокировать организацию (удаление из чёрного списка).

Основной сценарий Снять блокировку с контрагента.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.

Тело запроса

Тип запроса: application/json

Данные организации, которую нужно разблокировать.

Название	Обязат.	Тип	Описание
inn	Да	string	ИНН организации
kpp	Нет	string	КПП организации

Пример модели

{
  "inn": "Строка",
  "kpp": "Строка"
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Организация успешно разблокирована.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[POST]/api/v1/blockedOrganizations

Заблокировать организацию (добавление в чёрный список).

Основной сценарий Заблокировать контрагента.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.

Тело запроса

Тип запроса: application/json

Данные организации, которую нужно разблокировать.

Название	Обязат.	Тип	Описание
inn	Да	string	ИНН организации
kpp	Нет	string	КПП организации

Пример модели

{
  "inn": "Строка",
  "kpp": "Строка"
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Организация успешно заблокирована.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[GET]/api/v1/counterparties/globalIds

Поиск идентификаторов участника ЭДО (ИдЭДО) контрагента по ИНН/КПП.

Основной сценарий Поиск идентификатора участника ЭДО (ИдЭДО) контрагента для установки связи. Является необходимым действием перед началом обмена документами.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
inn	Да	Query	string	ИНН физического/юридического лица.
kpp	Нет	Query	string	КПП юридического лица (в случае ЮЛ является обязательным).

Возможные ответы метода

Код	Тип	Описание
200	StringResultList	Список идентификаторов участников ЭДО (ИдЭДО), соответствующих указанным ИНН/КПП.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    "Строка"
  ]
}

[GET]/api/v1/counterparties/contacts

Получение списка контактов адресной книги, содержащих информацию о контрагентах, с которыми установлена связь.

Основной сценарий Получить идентификатор участника ЭДО (ИдЭДО) из адресной книги для использования его в роли получателя документа.
Дополнительный сценарий Просмотреть актуальную адресную книгу на текущий момент.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
filter	Нет	Query	string	Поисковое значение (например ИНН, КПП или наименование контрагента).
offset	Нет	Query	integer(int32)	Начальное значение списка.
count	Нет	Query	integer(int32)	Количество выводимых значений (По умолчанию: 15).

Возможные ответы метода

Код	Тип	Описание
200	ContactResultList	Список контрагентов, с которыми установлена связь (основная информация).
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
      "owner": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "counterparty": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "operator": {
        "id": "ef2687fc-2a40-4bca-886c-e52283105315",
        "prefix": "2AE",
        "name": "АО Калуга Астрал"
      }
    }
  ]
}

[DELETE]/api/v1/counterparties/contacts/{contactId}

Удаление конкретного контакта (разрыв связи с контрагентом).

Основной сценарий Разорвать существующую связь с контрагентом по указанному идентификатору контакта.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
contactId	Да	Path	string(uuid)	Идентификатор контакта, который неоходимо разорвать.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Контакт успешно удален.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[PUT]/api/v1/counterparties/{counterpartId}/contact

Обновление информации в карточке контрагента с очисткой незаполненных реквизитов и информации о сотрудниках.

Основной сценарий Обновить информацию по адресу контрагента для последующей работы в ЭДО.
Адресная информация необходима для ее подстановки в документы, участвующие в ДО. Список сотрудников (ответственных лиц).
При добавлении, список действущих не удаляется.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
counterpartId	Да	Path	string(uuid)	Внутренний идентификатор контрагента.

Тело запроса

Тип запроса: application/json

Адресная информация и список сотрудников контрагента.

Название	Обязат.	Тип	Описание
legalAddress	Нет	Одна из: Address	Юридический адрес.
actualAddress	Нет	Одна из: Address	Фактический адрес.
newEmployees	Нет	CounterpartyEmployee[array]	Новые сотрудники контрагента.

Пример модели

{
  "legalAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "actualAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "newEmployees": [
    {
      "fullName": "Константинопольский Константин Константинович",
      "position": "Директор",
      "phone": "+70000000000",
      "email": "test@test.tt"
    }
  ]
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Информация в карточке контрагента успешно обновлена.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[PATCH]/api/v1/counterparties/{counterpartId}/contact

Обновление информации в карточке контрагента с игнорированием незаполненных реквизитов и информации о сотрудниках.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
counterpartId	Да	Path	string(uuid)	Внутренний идентификатор контрагента.

Тело запроса

Тип запроса: application/json

Адресная информация и список сотрудников контрагента.

Название	Обязат.	Тип	Описание
legalAddress	Нет	Одна из: Address	Юридический адрес.
actualAddress	Нет	Одна из: Address	Фактический адрес.
newEmployees	Нет	CounterpartyEmployee[array]	Новые сотрудники контрагента.

Пример модели

{
  "legalAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "actualAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "newEmployees": [
    {
      "fullName": "Константинопольский Константин Константинович",
      "position": "Директор",
      "phone": "+70000000000",
      "email": "test@test.tt"
    }
  ]
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Информация в карточке контрагента успешно обновлена.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[POST]/api/v1/invitations

Отправка приглашения контрагенту.

Основной сценарий Отправить приглашение с целью установить связь с указанным контрагентом (получателем).

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.

Тело запроса

Тип запроса: application/json

Данные приглашения.

Название	Обязат.	Тип	Описание
recipientGlobalId	Да	string	Идентификатор участника ЭДО (ИдЭДО), которому необходимо отправить приглашение.

Пример модели

{
  "recipientGlobalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875"
}

Возможные ответы метода

Код	Тип	Описание
200	string(uuid)	Идентификатор отправленного приглашения.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[GET]/api/v1/invitations/{invitationId}

Получение информации по конкретному приглашению.

Основной сценарий Проверить статус отправленного приглашения с целью узнать наличие и характер ответа контрагента.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
invitationId	Да	Path	string(uuid)	Идентификатор приглашения в системе Астрал ЭДО.

Возможные ответы метода

Код	Тип	Описание
200	Invitation	Подробная информация о приглашении.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "id": "b53e7790-a772-465f-a8c0-95a5e9bd1c9d",
  "sentDate": "2022-02-11T13:03:05.670Z",
  "invitationStatus": "Deferred",
  "sender": {
    "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
    "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
    "organizationName": "ОАО Тестовая организация",
    "inn": "9632018827",
    "kpp": "999901001"
  },
  "recipient": {
    "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
    "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
    "organizationName": "ОАО Тестовая организация",
    "inn": "9632018827",
    "kpp": "999901001"
  },
  "operator": {
    "id": "ef2687fc-2a40-4bca-886c-e52283105315",
    "prefix": "2AE",
    "name": "АО Калуга Астрал"
  }
}

[GET]/api/v1/invitations/outgoing

Получение списка исходящих приглашений.

Основной сценарий Получить информацию по приглашениям в подвешенном статусе.
Приглашение считается в подвешенном состоянии, если его статус принимает одно из следующих значений:
Sent, Rejected или Deferred.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
filter	Нет	Query	string	Поисковое значение (например ИНН, КПП или наименование). ВАЖНО: Поиск идет только по получателям (т.е. самого себя не найти).
offset	Нет	Query	integer(int32)	Начальное значение списка.
count	Нет	Query	integer(int32)	Количество выводимых значений (По умолчанию: 15).

Возможные ответы метода

Код	Тип	Описание
200	InvitationResultList	Список исходящих приглашений.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "id": "b53e7790-a772-465f-a8c0-95a5e9bd1c9d",
      "sentDate": "2022-02-11T13:03:05.670Z",
      "invitationStatus": "Deferred",
      "sender": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "recipient": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "operator": {
        "id": "ef2687fc-2a40-4bca-886c-e52283105315",
        "prefix": "2AE",
        "name": "АО Калуга Астрал"
      }
    }
  ]
}

[GET]/api/v1/invitations/incoming

Получение списка входящих приглашений, ожидающих ответа.

Основной сценарий Проверить наличие входящих приглашений, с целью установить связь с контрагентами-инициаторами.
Дополнительный сценарий Проверить наличие входящих приглашений, с целью отклонить приглашения.
Приглашения, на которые уже был дан ответ, в данном списке не выводятся (только приглашения в статусе Sent).

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
filter	Нет	Query	string	Поисковое значение (например ИНН, КПП или наименование). ВАЖНО: Поиск идет только по отправителям (т.е. самого себя не найти).
offset	Нет	Query	integer(int32)	Начальное значение списка.
count	Нет	Query	integer(int32)	Количество выводимых значений (По умолчанию: 15).

Возможные ответы метода

Код	Тип	Описание
200	InvitationResultList	Список входящих приглашения ожидающих ответа.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "id": "b53e7790-a772-465f-a8c0-95a5e9bd1c9d",
      "sentDate": "2022-02-11T13:03:05.670Z",
      "invitationStatus": "Deferred",
      "sender": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "recipient": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "operator": {
        "id": "ef2687fc-2a40-4bca-886c-e52283105315",
        "prefix": "2AE",
        "name": "АО Калуга Астрал"
      }
    }
  ]
}

[PUT]/api/v1/invitations/{invitationId}/acceptance

Принять приглашение.

Основной сценарий Установить связь с контрагентом-инициатором.
Необходимо для начала обмена документами.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
invitationId	Да	Path	string(uuid)	Идентификатор приглашения.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Приглашение успешно принято.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[PUT]/api/v1/invitations/{invitationId}/rejection

Отклонить приглашение.

Основной сценарий Отклонить приглашение с целью формирования отрицательного ответа на входящее приглашение.
Дополнительный сценарий Отклонить приглашение с целью разорвать существующий контакт.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
invitationId	Да	Path	string(uuid)	Идентификатор приглашения.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Приглашение успешно отклонено.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[POST]/api/v1/invitations/SendEmailInvite

Позволяет отправить письмо-приглашение в сервис Доки на почту контрагента

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Query	string(uuid)	Внутренний идентификатор абонента

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип
recipientEmail	Да	string
recipientInn	Да	string
recipientKpp	Нет	string

Пример модели

{
  "recipientEmail": "Строка",
  "recipientInn": "Строка",
  "recipientKpp": "Строка"
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Success

Описание дополнительных моделей

Данный блок содержит описание дополнительных моделей.

Address

Информация об адресе.

Название	Обязат.	Тип	Описание
postalIndex	Нет	string	Почтовый индекс.
regionCode	Да	string	Код региона.
regionName	Нет	string	Название региона.
area	Нет	string	Район.
city	Нет	string	Город. Это поле обязательно, если поле Settlement пустое.
settlement	Нет	string	Населенный пункт. Это поле обязательно, если поле City пустое.
street	Нет	string	Улица.
house	Нет	string	Дом.
housing	Нет	string	Корпус.
apartment	Нет	string	Квартира.

Пример модели

{
  "postalIndex": "000000",
  "regionCode": "000",
  "regionName": "Тестовый регион",
  "area": "Тестовый район",
  "city": "Тестовый город",
  "settlement": "Тестовый населённый пункт",
  "street": "Тестовая улица",
  "house": "404",
  "housing": "А",
  "apartment": "10"
}

BlockedOrganization

Информация об организации из чёрного списка.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Внутренний идентификатор заблокированного контрагента.
blockedBy	Да	string(uuid)	Внутренний идентификатор заблокировавшего контрагента.
name	Да	string	Наименование заблокированной организации.
inn	Да	string	ИНН заблокированной организации.
kpp	Нет	string	КПП заблокированной организации.
blockingDate	Да	date-time-offset	Дата блокировки.

Пример модели

{
  "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
  "blockedBy": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
  "name": "Строка",
  "inn": "Строка",
  "kpp": "Строка",
  "blockingDate": "2022-02-11T13:03:05.670Z"
}

BlockedOrganizationResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	BlockedOrganization[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    {
      "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
      "blockedBy": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
      "name": "Строка",
      "inn": "Строка",
      "kpp": "Строка",
      "blockingDate": "2022-02-11T13:03:05.670Z"
    }
  ]
}

Contact

Контакт с определенным контрагентом.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор контакта (связи).
owner	Да	Одна из: Counterparty	Информация о владельце контакта.
counterparty	Да	Одна из: Counterparty	Информация о контрагенте с которым установлен контакт.
operator	Да	Одна из: Operator	Информация о операторе контрагента с которым установлен контакт.

Пример модели

{
  "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
  "owner": {
    "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
    "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
    "organizationName": "ОАО Тестовая организация",
    "inn": "9632018827",
    "kpp": "999901001"
  },
  "counterparty": {
    "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
    "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
    "organizationName": "ОАО Тестовая организация",
    "inn": "9632018827",
    "kpp": "999901001"
  },
  "operator": {
    "id": "ef2687fc-2a40-4bca-886c-e52283105315",
    "prefix": "2AE",
    "name": "АО Калуга Астрал"
  }
}

ContactResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	Contact[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    {
      "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
      "owner": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "counterparty": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "operator": {
        "id": "ef2687fc-2a40-4bca-886c-e52283105315",
        "prefix": "2AE",
        "name": "АО Калуга Астрал"
      }
    }
  ]
}

Counterparty

Информация о контрагенте.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Внутренний идентификатор контрагента.
globalId	Да	string	Идентификатор участника ЭДО (ИдЭДО).
organizationName	Да	string	Название организации контрагента.
inn	Да	string	ИНН контрагента.
kpp	Нет	string	КПП контрагента.

Пример модели

{
  "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
  "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "organizationName": "ОАО Тестовая организация",
  "inn": "9632018827",
  "kpp": "999901001"
}

CounterpartyEmployee

Информация о сотруднике контрагента.

Название	Обязат.	Тип	Описание
fullName	Да	string	ФИО сотрудника.
position	Нет	string	Должность ответственного лица.
phone	Нет	string	Номер телефона.
email	Нет	string	Электронная почта.

Пример модели

{
  "fullName": "Константинопольский Константин Константинович",
  "position": "Директор",
  "phone": "+70000000000",
  "email": "test@test.tt"
}

InnKppPair

ИНН и КПП организации.

Название	Обязат.	Тип	Описание
inn	Да	string	ИНН организации
kpp	Нет	string	КПП организации

Пример модели

{
  "inn": "Строка",
  "kpp": "Строка"
}

Invitation

Информация о приглашении.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор приглашения.
sentDate	Да	date-time-offset	Дата отправки приглашения.
invitationStatus	Да	Одна из: InvitationStatus	Статус приглашения.
sender	Да	Одна из: Counterparty	Информация об отправителе.
recipient	Да	Одна из: Counterparty	Информация о получателе.
operator	Нет	Одна из: Operator	Информация об операторе.

Пример модели

{
  "id": "b53e7790-a772-465f-a8c0-95a5e9bd1c9d",
  "sentDate": "2022-02-11T13:03:05.670Z",
  "invitationStatus": "Deferred",
  "sender": {
    "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
    "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
    "organizationName": "ОАО Тестовая организация",
    "inn": "9632018827",
    "kpp": "999901001"
  },
  "recipient": {
    "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
    "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
    "organizationName": "ОАО Тестовая организация",
    "inn": "9632018827",
    "kpp": "999901001"
  },
  "operator": {
    "id": "ef2687fc-2a40-4bca-886c-e52283105315",
    "prefix": "2AE",
    "name": "АО Калуга Астрал"
  }
}

InvitationResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	Invitation[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    {
      "id": "b53e7790-a772-465f-a8c0-95a5e9bd1c9d",
      "sentDate": "2022-02-11T13:03:05.670Z",
      "invitationStatus": "Deferred",
      "sender": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "recipient": {
        "id": "fc7011ec-616d-4493-9c0c-8a13be96ad98",
        "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
        "organizationName": "ОАО Тестовая организация",
        "inn": "9632018827",
        "kpp": "999901001"
      },
      "operator": {
        "id": "ef2687fc-2a40-4bca-886c-e52283105315",
        "prefix": "2AE",
        "name": "АО Калуга Астрал"
      }
    }
  ]
}

InvitationStatus

Статус приглашения.

Значение	Описание
Accepted	Приглашение принято.
Deferred	Приглашение отложено (до окончания обработки заявки на регистрацию).
Rejected	Приглашение отклонено.
Sent	Приглашения отправлено.

Operator

Информация об операторе.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Внутренний идентификатор оператора.
prefix	Да	string	Префикс (уникальный идентификатор) оператора ЭДО.
name	Да	string	Наименование оператора.

Пример модели

{
  "id": "ef2687fc-2a40-4bca-886c-e52283105315",
  "prefix": "2AE",
  "name": "АО Калуга Астрал"
}

SendInvitationRequest

Информация о запросе на приглашение.

Название	Обязат.	Тип	Описание
recipientGlobalId	Да	string	Идентификатор участника ЭДО (ИдЭДО), которому необходимо отправить приглашение.

Пример модели

{
  "recipientGlobalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875"
}

StringResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	string[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    "Строка"
  ]
}

UpdateContactCardRequest

Модель запроса обновления информации о карточке контрагента.

Название	Обязат.	Тип	Описание
legalAddress	Нет	Одна из: Address	Юридический адрес.
actualAddress	Нет	Одна из: Address	Фактический адрес.
newEmployees	Нет	CounterpartyEmployee[array]	Новые сотрудники контрагента.

Пример модели

{
  "legalAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "actualAddress": {
    "postalIndex": "000000",
    "regionCode": "000",
    "regionName": "Тестовый регион",
    "area": "Тестовый район",
    "city": "Тестовый город",
    "settlement": "Тестовый населённый пункт",
    "street": "Тестовая улица",
    "house": "404",
    "housing": "А",
    "apartment": "10"
  },
  "newEmployees": [
    {
      "fullName": "Константинопольский Константин Константинович",
      "position": "Директор",
      "phone": "+70000000000",
      "email": "test@test.tt"
    }
  ]
}

Counterparties API

Описание методов​

[GET]/api/v1/blockedOrganizations​

Параметры в строке запроса​

Возможные ответы метода​

[DELETE]/api/v1/blockedOrganizations​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[POST]/api/v1/blockedOrganizations​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[GET]/api/v1/counterparties/globalIds​

Параметры в строке запроса​

Возможные ответы метода​

[GET]/api/v1/counterparties/contacts​

Параметры в строке запроса​

Возможные ответы метода​

[DELETE]/api/v1/counterparties/contacts/{contactId}​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/counterparties/{counterpartId}/contact​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[PATCH]/api/v1/counterparties/{counterpartId}/contact​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[POST]/api/v1/invitations​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[GET]/api/v1/invitations/{invitationId}​

Параметры в строке запроса​

Возможные ответы метода​

[GET]/api/v1/invitations/outgoing​

Параметры в строке запроса​

Возможные ответы метода​

[GET]/api/v1/invitations/incoming​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/invitations/{invitationId}/acceptance​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/invitations/{invitationId}/rejection​

Параметры в строке запроса​

Возможные ответы метода​

[POST]/api/v1/invitations/SendEmailInvite​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

Описание дополнительных моделей​

Address​

BlockedOrganization​

BlockedOrganizationResultList​

Contact​

ContactResultList​

Counterparty​

CounterpartyEmployee​

InnKppPair​

Invitation​

InvitationResultList​

InvitationStatus​

Operator​

SendInvitationRequest​

StringResultList​

UpdateContactCardRequest​

Описание методов

[GET]/api/v1/blockedOrganizations

Параметры в строке запроса

Возможные ответы метода

[DELETE]/api/v1/blockedOrganizations

Параметры в строке запроса

Тело запроса

Возможные ответы метода

[POST]/api/v1/blockedOrganizations

Параметры в строке запроса

Тело запроса

Возможные ответы метода

[GET]/api/v1/counterparties/globalIds

Параметры в строке запроса

Возможные ответы метода

[GET]/api/v1/counterparties/contacts

Параметры в строке запроса

Возможные ответы метода

[DELETE]/api/v1/counterparties/contacts/{contactId}

Параметры в строке запроса

Возможные ответы метода

[PUT]/api/v1/counterparties/{counterpartId}/contact

Параметры в строке запроса

Тело запроса

Возможные ответы метода

[PATCH]/api/v1/counterparties/{counterpartId}/contact

Параметры в строке запроса

Тело запроса

Возможные ответы метода

[POST]/api/v1/invitations

Параметры в строке запроса

Тело запроса

Возможные ответы метода

[GET]/api/v1/invitations/{invitationId}

Параметры в строке запроса

Возможные ответы метода

[GET]/api/v1/invitations/outgoing

Параметры в строке запроса

Возможные ответы метода

[GET]/api/v1/invitations/incoming

Параметры в строке запроса

Возможные ответы метода

[PUT]/api/v1/invitations/{invitationId}/acceptance

Параметры в строке запроса

Возможные ответы метода

[PUT]/api/v1/invitations/{invitationId}/rejection

Параметры в строке запроса

Возможные ответы метода

[POST]/api/v1/invitations/SendEmailInvite

Параметры в строке запроса

Тело запроса

Возможные ответы метода

Описание дополнительных моделей

Address

BlockedOrganization

BlockedOrganizationResultList

Contact

ContactResultList

Counterparty

CounterpartyEmployee

InnKppPair

Invitation

InvitationResultList

InvitationStatus

Operator

SendInvitationRequest

StringResultList

UpdateContactCardRequest