contract

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

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

Примечание

Доступна пагинация.

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

actionObjectID

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

Значение по умолчанию: 0 — выводить список всех договоров.

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

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

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <externalID>{string}</externalID>
    <customerID>{integer}</customerID>
    <executorID>{integer}</executorID>
    <type>{integer}</type>
    <isRegReport>{integer}</isRegReport>
    <actionType>{integer}</actionType>
    <subjectType>{integer}</subjectType>
    <number>{string}</number>
    <amountRub>{float}</amountRub>
    <isVat>{integer}</isVat>
    <intermediaryContractID>{integer}</intermediaryContractID>
    <dateConclusion>{string}</dateConclusion>
    <isFinalAgreement>{integer}</isFinalAgreement>
  </row0>
</data>
</result>
</response>

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

code

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

row0

Элемент списка с соответствующим номером.

ID

Внутренний идентификатор договора в Adfox

externalID

Идентификатор договора для ЕРИР.

customerID

Идентификатор заказчика.

executorID

Идентификатор исполнителя.

type

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

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

  • 0 — Посреднический договор.
  • 1 — Договор оказания услуг.
  • 2 — Дополнительное соглашение.

isRegReport

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

actionType

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

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

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

subjectType

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

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

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

number

Номер договора/дополнительного соглашения.

amountRub

Цена договора.

isVat

Цена включает НДС.

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

  • 0 — цена не включает НДС;
  • 1 — цена включает НДС.

intermediaryContractID

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

dateConclusion

Дата договора/дополнительного соглашения. Формат: ГГГГ-ММ-ДД.

isFinalAgreement

Договор первичный или нет.

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

  • 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>
    <customerID>1</customerID>
    <executorID>2</executorID>
    <type>0</type>
    <isRegReport>1</isRegReport>
    <actionType>1</actionType>
    <subjectType>0</subjectType>
    <number>123456</number>
    <amountRub>1000000 RUB</amountRub>
    <isVat>1</isVat>
    <intermediaryContractID>12</intermediaryContractID>
    <dateConclusion>2022-11-10</dateConclusion>
    <isFinalAgreement>1</isFinalAgreement>
  </row0>
</data>
</result>
</response>

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

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

Предыдущая
category
Следующая
contractor
В этой статье: