contractor

Получить список контрагентов.

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

Примечание

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

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

actionObjectID

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

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

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

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

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <ownerId>{integer}</ownerId>
    <name>{string}</name>
    <type>{integer}</type>
      <roles>
        <row0>{integer}</row0>
        <row1>{integer}</row1>
      </roles>
    <countryOKSM>{string}</countryOKSM>
    <inn>{string}</inn>
    <mobilePhone>{string}</mobilePhone>
    <epayNumber>{string}</epayNumber>
    <regNumber>{string}</regNumber>
    <isOrs>{integer}</isOrs>
    <isRr>{integer}</isRr>
    <rsUrl>{string}</rsUrl>
  </row0>
</data>
</result>
</response>

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

code

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

row0

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

ID

Уникальный идентификатор контрагента.

ownerId

ID аккаунта.

name

Название контрагента.

type

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

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

  • 0 — Юридическое лицо (РФ).
  • 1 — Физическое лицо (РФ).
  • 2 — Индивидуальный предприниматель (РФ).
  • 3 — Юридическое лицо (Нерезидент).
  • 4 — Физическое лицо (Нерезидент).

roles

Роли в которых может выступать контрагент при заключении договора.

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

  • 0 — Исполнитель.
  • 1 — Заказчик.

countryOKSM

ОКСМ код страны регистрации.

inn

ИНН контрагента.

mobilePhone

Номер телефона контрагента.

epayNumber

Номер электронного средства платежа.

regNumber

Регистрационный номер.

isOrs

Является оператором рекламной системы.

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

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

isRr

Является распространителем рекламы.

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

  • 0 — не является распространителем рекламы;
  • 1 — является распространителем рекламы.

rsUrl

URL рекламной системы или другая информация.

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

Запрос:

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

Ответ:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <ID>1111</ID>
    <ownerId>111111</ownerId>
    <name>contractor_1</name>
    <type>0</type>
      <roles>
        <row0>0</row0>
        <row1>1</row1>
      </roles>
    <countryOKSM>643</countryOKSM>
    <inn>1234567890</inn>
    <mobilePhone>+7 (999) 999-99-99</mobilePhone>
    <epayNumber>1234567890987654321</epayNumber>
    <regNumber>123</regNumber>
    <isOrs>0</isOrs>
    <isRr>0</isRr>
    <rsUrl>adfox.ru</rsUrl>
  </row0>
</data>
</result>
</response>

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

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

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