contract

Get a list of contracts.

Request format

Note

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

actionObjectID

To get data for only one contract, specify its ID.

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

* Required

Response format

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

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`	Internal ID of the contract in Adfox
`externalID`	Contract ID for the Russian state register.
`customerID`	Customer ID.
`executorID`	Executor ID.
`type`	Contract type. Acceptable values: `0`: Intermediary contract. `1`: Service agreement. `2`: Additional agreement.
`isRegReport`	The executor is obliged to register and submit creatives.
`actionType`	Description of the mediation/representative activity. Acceptable values: `0`: Other. `1`: Distribution. `2`: Conclusion of contracts. `3`: Commercial representation.
`subjectType`	Information about the subject matter of a contract. Acceptable values: `0`: Other. `1`: Distribution. `2`: Organization distribution. `3`: Mediation. `4`: Representation.
`number`	Number of a contract/additional agreement.
`amountRub`	Contract price.
`isVat`	Price includes VAT. Acceptable values: `0`: Price does not include VAT. `1`: Price includes VAT.
`intermediaryContractID`	Parent contract ID.
`dateConclusion`	Date of a contract/additional agreement. Format: `YYYY-MM-DD`.
`isFinalAgreement`	Original contract or not. Acceptable values: `0`: No. `1`: Yes.

Sample request and response

Request:

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

Response:

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

Other actions with the object

See more actions with the contract object: