contractor

Get a list of contractors.

Request format

Note

Pagination available.

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

actionObjectID

To get data for only one contractor, specify their ID.

Default value: 0 (display the list of all contractors).

* Required

Response format

<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>

Response parameters

code

Request processing status. If the value is 0, the request was completed successfully. For the key, see Error handling.

row0

List item with its corresponding number.

ID

Contractor's unique ID.

ownerID

Account ID.

name

Contractor's name.

type

Contractor type.

Acceptable values:

  • 0: Entity (Russia).
  • 1: Individual (Russia).
  • 2: Individual entrepreneur (Russia).
  • 3: Foreign entity (non-resident).
  • 4: Foreign individual (non-resident).

roles

Roles that a contractor can assume when entering into a contract.

Acceptable values:

  • 0: Executor.
  • 1: Customer.

countryOKSM

Country code of jurisdiction of registration as per the All-Russian Classifier of Countries of the World.

inn

Contractor's TIN.

mobilePhone

Contractor's phone number.

epayNumber

Number of the electronic payment facility.

regNumber

Registration number.

isOrs

Is an ad system operator.

Acceptable values:

  • 0: Is not an ad system operator.
  • 1: Is an ad system operator.

isRr

Is an ad distributor.

Acceptable values:

  • 0: Is not an ad distributor.
  • 1: Is an ad distributor.

rsUrl

Ad system URL or other information.

Sample request and response

Request:

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

Response:

<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.com</rsUrl>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the contractor object:

To get data for only one contractor, specify their ID.

Default value: 0 (display the list of all contractors).

Required

Previous
contract
Next
defaultBanner