Договор (ORG_Agreement)

Договор (ORG_Agreement) - это соглашение между клиентом и контрагентом. Договор может быть активирован клиентом и агентом.

Характеризуется следующими полями:

• id_Agreement (пример "123") - первичный ключ договора.
  В том случае, если мы создаем новый договор, то значение не передаем; если редактируем существующий - передаем идентификатор;

• id_CustomerGroup (пример "123") - идентификатор компании заказчика, с которой заключен договор (обязательное поле, число);

• id_ProviderGroup (пример "123") - идентификатор компании исполнителя, с которой заключен договор (обязательное поле, число);

• IsCustomerApproved (пример "true") - Поле, показывающее, что договор подтвержден заказчиком.
  Возможные значения:

  • true - подтверждён;

  • false - не подтверждён.

• IsSupplierApproved (пример "true") - Поле, показывающее, что договор подтвержден поставщиком
  Возможные значения:

  • true - подтверждён;

  • false - не подтверждён.

• id_ServiceTeam (пример "123") - Ссылка на группу операторов из Client.ServiceTeam (обязательное поле, число);

• Title (пример "Элмо") - заголовок договора - берется из поля номер или из имен агента - клиента (необязательное поле, строка);

• IsTest (пример "true") - признак тестового договора.
  Возможные значения:

  • true - тестовый;

  • false - не тестовый.

• LimitDate (пример "2015-11-18T00:00:00") - дата окончания договора (необязательное поле, дата).

Open

На интерфейсе список договоров доступен в разделе "Настройки" всем пользователям - и клиенту, и агенту:

Open

Список договоров выглядит следующим образом:

 Соответствие полей на интерфейсе полям в базе:

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

WSDL можно скачать с демо-сайта: https://demo.corteos.ru/XmlGate/V3/StaticData/Agreements/AgreementManagement.asmx?wsdl

Для работы в продуктовой среде необходимо заменить demo.corteos.ru на свой домен (на котором работают пользователи вашей компании).

В API реализованы следующие методы для работы с договором:

1. GetV2 - Получение договора по первичному ключу (ORG_Agreement.id_Agreement);

2. CreateNewV2 - Создание нового договора;

3. ListV2 - Получение списка договоров;

4. DeleteV2 - Удаление договора по id;

5. EnterV2 - Дополнительный сервисный метод. Входит в определенный договор для работы от имени клиента.

6. AgreementOrganizationSupplierApprove - включение и выключение плательщика(организации) в договоре

Разберем эти методы более подробно

1. Получение договора по первичному ключу (GetV2) - Запрос / Ответ

Для выгрузки договора по первичному ключу используется метод GetV2.

Соответственно, для проведения выгрузки данных необходимо хранить на стороне клиента API первичный ключ договора (id_Agreement).

2. Запрос на создание нового договора: (CreateNewV2) - Запрос / Ответ

3. Получение списка договоров (ListV2) - Запрос / Ответ

4. Удаление договора (DeleteV2) - Запрос / Ответ

5. Вход в договор (EnterV2) - Запрос / Ответ

6. Включение и выключение плательщика (организации) в договоре