modify

Редактировать параметры договора. Передавайте только те параметры договора, которые хотите изменить.

Примечание

Изменение параметров приведет к отправке договора в ЕРИР на повторную проверку.

Формат запроса

https://adfox.yandex.ru/api/v1
  ? object=contract
  & action=modify
  & objectID=<integer>
  & [type=<integer>]
  & [agentActingForPublisher=<integer>]
  & [chargePaidByAgent=<integer>]
  & [intermediaryContractID=<integer>]
  & [customerID=<integer>]
  & [executorID=<integer>]
  & [subjectType=<integer>]
  & [number=<string>]
  & [dateConclusion=<string>]
  & [amountType=<string>]
  & [amountRub=<string>]
  & [actionType=<integer>]
  & [isRegReport=<integer>]
  & [contractRole=<integer>]

objectID*

Идентификатор договора.

type

Тип контракта.

Допустимые значения:

  • 0 — Договор оказания услуг.
  • 1 — Посреднический договор. Доступны параметры:
    • agentActingForPublisher— функция посредника.
    • chargePaidByAgent — опция «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент».
  • 2 — Дополнительное соглашение. Обязательно заполнить поле intermediaryContractID.

contractRole

Роль договора. Доступные значения:

  • 0 — Первичный.
  • 1 — Конечный.
  • 2 — Прямой.

customerID

Идентификатор заказчика. Как получить список ID контрагентов, см. в разделе contractor.

executorID

Идентификатор исполнителя. Как получить список ID контрагентов, см. в разделе contractor.

intermediaryContractID

Идентификатор родительского договора. Передается, только если type = 2.

subjectType

Сведения о предмете договора.

Допустимые значения:

  • 0 — Остальное.
  • 1 — Договор на распространение рекламы.
  • 2 — Договор на организацию распространения рекламы.
  • 3 — Посредничество.
  • 4 — Представительство.

actionType

Описание действий посредника-представителя.

Допустимые значения:

  • 0 — Иное.
  • 1 — Действия в целях распространения рекламы.
  • 2 — Заключение договоров.
  • 3 — Коммерческое представительство.

number

Номер договора/дополнительного соглашения. В начале и конце не должно быть пробела и переноса на другую строку.

amountRub

Цена договора. Передается, только если amountType = 0 (возмездный).

amountType

Цена договора. Допустимые значения:

  • 0 — Возмездный (при этом значении обязательным становится amountRub).
  • 1 — Безвозмездный.
  • 2 — В договоре нет цены.

dateConclusion

Дата договора/дополнительного соглашения. Формат: ГГГГ-ММ-ДД. Дата договора/дополнительного соглашения не может быть больше текущей.

isRegReport

На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы.

Доступные значения:

  • 0 — нет;
  • 1 — да.

agentActingForPublisher

Функция посредника, признак направления денежного потока в сторону принципала. Обязателен, если выбран тип договора type = 1, в противном случае указывать нельзя. Доступные значения:

  • 0 — Агент действует в интересах РД в этом агентском договоре (является представителем рекламодателя).
  • 1 — Агент действует в интересах РР в этом агентском договоре (является представителем рекламной площадки).

chargePaidByAgent

Признак «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент». Поле может передаваться только в посредническом договоре type = 1 и при признаке направления денежного потока в сторону принципала agentActingForPublisher = 0. Доступные значения:

  • 0 — Выключено.
  • 1 — Включено (сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент).

* Обязательный параметр

Формат ответа

<response>
<status>
  <code>{integer}</code>
</status>
</response>

Параметры ответа

code

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

Пример запроса и ответа

Запрос:

https://adfox.yandex.ru/api/v1?object=contract&action=modify&objectID=777&type=2&customerID=108&executorID=109&isRegReport=1&subjectType=0&actionType=3&number=number&amountRub=77&intermediaryContractID=43792

Ответ:

<response>
<status>
  <code>0</code>
</status>
</response>

Другие действия с объектом

Читайте также о других действиях с объектом contract:

Идентификатор договора.

Тип контракта.

Допустимые значения:

  • 0 — Договор оказания услуг.
  • 1 — Посреднический договор. Доступны параметры:
    • agentActingForPublisher— функция посредника.
    • chargePaidByAgent — опция «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент».
  • 2 — Дополнительное соглашение. Обязательно заполнить поле intermediaryContractID.

Идентификатор заказчика. Как получить список ID контрагентов, см. в разделе contractor.

Идентификатор исполнителя. Как получить список ID контрагентов, см. в разделе contractor.

Идентификатор родительского договора. Передается, только если type = 2.

Сведения о предмете договора.

Допустимые значения:

  • 0 — Иное.

  • 1 — Договор на распространение рекламы.

  • 2 — Договор на организацию распространения рекламы.

  • 3 — Посредничество.

  • 4 — Представительство.

Описание действий посредника-представителя.

Допустимые значения:

  • 0 — Иное.

  • 1 — Действия в целях распространения рекламы.

  • 2 — Заключение договоров.

  • 3 — Коммерческое представительство.

Номер договора/дополнительного соглашения. В начале и конце не должно быть пробела и переноса на другую строку.

Цена договора. Передается, только если amountType = 0 (возмездный).

Цена договора. Допустимые значения:

  • 0 — Возмездный (при этом значении обязательным становится amountRub).
  • 1 — Безвозмездный.
  • 2 — В договоре нет цены.

Роль договора. Доступные значения:

  • 0 — Первичный.
  • 1 — Конечный.
  • 2 — Прямой.

Функция посредника, признак направления денежного потока в сторону принципала. Обязателен, если выбран тип договора type = 1, в противном случае указывать нельзя. Доступные значения:

  • 0 — Агент действует в интересах РД в этом агентском договоре (является представителем рекламодателя).
  • 1 — Агент действует в интересах РР в этом агентском договоре (является представителем рекламной площадки).

Признак «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент». Поле может передаваться только в посредническом договоре type = 1 и при признаке направления денежного потока в сторону принципала agentActingForPublisher = 0. Доступные значения:

  • 0 — Выключено.
  • 1 — Включено (сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент).

Дата договора/дополнительного соглашения. Формат: ГГГГ-ММ-ДД. Дата договора/дополнительного соглашения не может быть больше текущей.

На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы.

Доступные значения:

  • 0 — нет;

  • 1 — да.

Обязательный параметр

Предыдущая
contract
Следующая
contractor