contract

Получить список договоров.

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

Примечание

https://adfox.yandex.ru/api/v1
  ? object=account
  & action=list
  & actionObject=contract
  & [actionObjectID=<integer>]

actionObjectID

Чтобы получить данные только по одному договору, укажите его идентификатор.

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

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

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <externalID>{string}</externalID>
    <type>{integer}</type>
    <agentActingForPublisher>{integer}</agentActingForPublisher>
    <chargePaidByAgent>{integer}</chargePaidByAgent>
    <intermediaryContractID>{integer}</intermediaryContractID>
    <customerID>{integer}</customerID>
    <executorID>{integer}</executorID>
    <subjectType>{integer}</subjectType>
    <number>{string}</number>
    <dateConclusion>{string}</dateConclusion>
    <amountType>{float}</amountType>
    <amountRub>{float}</amountRub>
    <actionType>{integer}</actionType>
    <isRegReport>{integer}</isRegReport>
    <socialType>{integer}</socialType>
    <contractRole>{integer}</contractRole>
  </row0>
</data>
</result>
</response>

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

`code`	Статус обработки запроса. Значение `0` — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.
`row0`	Элемент списка с соответствующим номером.
`ID`	Внутренний идентификатор договора в Adfox
`externalID`	Идентификатор договора для ЕРИР.
`customerID`	Идентификатор заказчика. Как получить список ID контрагентов, см. в разделе contractor.
`executorID`	Идентификатор исполнителя. Как получить список ID контрагентов, см. в разделе contractor.
`type`	Тип контракта. Допустимые значения: `0` — Договор оказания услуг. `1` — Посреднический договор. Доступны параметры: `agentActingForPublisher`— функция посредника. `chargePaidByAgent` — опция «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент». `2` — Дополнительное соглашение.
`isRegReport`	На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы.
`actionType`	Описание действий посредника-представителя. Допустимые значения: `0` — Иное. `1` — Действия в целях распространения рекламы. `2` — Заключение договоров. `3` — Коммерческое представительство.
`subjectType`	Сведения о предмете договора. Допустимые значения: `0` — Остальное. `1` — Договор на распространение рекламы. `2` — Договор на организацию распространения рекламы. `3` — Посредничество. `4` — Представительство.
`number`	Номер договора/дополнительного соглашения.
`amountRub`	Цена договора.
`amountType`	Цена договора. Допустимые значения: `0` — Возмездный (при этом значении обязательным становится `amountRub`). `1` — Безвозмездный. `2` — В договоре нет цены.
`intermediaryContractID`	Идентификатор родительского договора.
`dateConclusion`	Дата договора/дополнительного соглашения.
`socialType`	Вид договора. Доступные значения: `0` — Коммерческий. `1` — Договор социальной рекламы с оплатой. `2` — Договор социальной рекламы по квоте.
`agentActingForPublisher`	Функция посредника, признак направления денежного потока в сторону принципала. Обязателен, если выбран тип договора `type` = `1`, в противном случае указывать нельзя. Доступные значения: `0` — Агент действует в интересах РД в этом агентском договоре (является представителем рекламодателя). `1` — Агент действует в интересах РР в этом агентском договоре (является представителем рекламной площадки).
`chargePaidByAgent`	Признак «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент». Поле может передаваться только в посредническом договоре `type` = `1` и при признаке направления денежного потока в сторону принципала `agentActingForPublisher` = `0`. Доступные значения: `0` — Выключено. `1` — Включено (сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент).

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

Запрос:

https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=contract

Ответ:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <ID>123</ID>
    <externalID>321</externalID>
    <type>0</type>
    <agentActingForPublisher>0</agentActingForPublisher>
    <chargePaidByAgent>0</chargePaidByAgent>
    <intermediaryContractID>12</intermediaryContractID>
    <customerID>1</customerID>
    <executorID>2</executorID>
    <subjectType>0</subjectType>
    <number>123456</number>
    <dateConclusion>2022-11-10</dateConclusion>
    <amountType>0</amountType>
    <amountRub>1000000 RUB</amountRub>
    <actionType>1</actionType>
    <isRegReport>1</isRegReport>
    <socialType>0</socialType>
    <contractRole>0</contractRole>
  </row0>
</data>
</result>
</response>

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

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