Counteragent

Данные контрагента.

message Counteragent {
    optional string IndexKey = 1;
    required Organization Organization = 2;
    optional CounteragentStatus CurrentStatus = 3 [default = UnknownCounteragentStatus];
    required sfixed64 LastEventTimestampTicks = 4;
    optional string MessageFromCounteragent = 6;
    optional string MessageToCounteragent = 7;
    optional DocumentId InvitationDocumentId = 8;
    optional string CounteragentGroupId = 9;
}

  • IndexKey — ключ для постраничного получения списка найденных контрагентов. Его можно передавать в качестве параметра afterIndexKey в метод GetCounteragents (V3): ключ может содержать недопустимые символы, поэтому при вызове метода должен быть закодирован в URL-формат.

  • Organization — информация об организации контрагента, представленная структурой Organization.

  • CurrentStatus — текущий статус отношения партнерства с контрагентом. Может меняться со временем. Принимает значения из перечисления CounteragentStatus.

  • LastEventTimestampTicks — время последнего события из истории взаимодействия с контрагентом, представляет собой целое число тиков, прошедших с момента времени 00:00:00 01.01.0001.

  • MessageFromCounteragent — текст последнего комментария, полученного от контрагента.

  • MessageToCounteragent — текст последнего комментария, отправленного контрагенту.

  • InvitationDocumentId — идентификатор документа, отправленного вместе с приглашением. Представлен структурой DocumentId. Поле заполняется независимо от наличия доступа к документу. Возвращается, если статус контрагента принимает одно из следующих значений:

    • CounteragentStatus = IsMyCounteragent,

    • CounteragentStatus = InvitesMe,

    • CounteragentStatus = IsInvitedByMe.

    Список статусов, для которых возвращается документ, может быть расширен в будущем.

  • CounteragentGroupId — идентификатор группы, в которую добавлен контрагент. Возвращается, если статус контрагента CounteragentStatus = IsMyCounteragent.

См. также

Структура используется: