modify

Edit contract parameters. Submit only those contract parameters that you want to change.

Note

Changing the parameter values resubmits the contract to the state register for a review.

Request format

https://adfox.yandex.com/api/v1
  ? object=contract
  & action=modify
  & objectID=<integer>
  & [type=<integer>]
  & [customerID=<integer>]
  & [executorID=<integer>]
  & [intermediaryContractID=<integer>]
  & [subjectType=<integer>]
  & [actionType=<integer>]
  & [number=<string>]
  & [amountRub=<string>]
  & [dateConclusion=<string>]
  & [isVat=<integer>]
  & [isRegReport=<integer>]
  & [isFinalAgreement=<integer>]

objectID*

Contract ID.

type

Contract type.

Acceptable values:

  • 0: Service contract.
  • 1: Intermediary contract.
  • 2: Additional agreement. intermediaryContractID is a required field.

customerID

Customer ID.

executorID

Contractor ID.

intermediaryContractID

Parent contract ID.

subjectType

Subject matter of the contract.

Acceptable values:

  • 0: Other.
  • 1: Ad distribution contract.
  • 2: Contract to organize ad distribution.
  • 3: Mediation.
  • 4: Representation.

actionType

Description of actions performed by the intermediary representative.

Acceptable values:

  • 0: Other.
  • 1: Actions related to ad distribution.
  • 2: Conclusion of contracts.
  • 3: Commercial representation.

number

Contract / additional agreement number.

amountRub

Contract amount.

dateConclusion

Date of the contract / additional agreement. Format: YYYY-MM-DD. The contract / additional agreement date cannot be in the future.

isVat

The value includes VAT.

Acceptable values:

  • 0: Amount does not include VAT.
  • 1: Amount includes VAT.

isRegReport

The contractor is responsible for registering and submitting ad creatives.

Acceptable values:

  • 0: No.
  • 1: Yes.

isFinalAgreement

Specifies if this is the final contract in the chain.

Acceptable values:

  • 0: No.
  • 1: Yes.

* Required parameter

Response format

<response>
<status>
  <code>{integer}</code>
</status>
</response>

Response parameters

code

Request processing status. A value of 0 means the request was completed successfully. For the key, see Error handling.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=contract&action=modify&objectID=777&type=2&customerID=108&executorID=109&isRegReport=1&subjectType=0&actionType=3&number=number&amountRub=77&isVat=0&intermediaryContractID=43792&isFinalAgreement=1

Response:

<response>
<status>
  <code>0</code>
</status>
</response>

Other actions with the object

See also other actions with the contract object:

Contract ID.

Contract type.

Acceptable values:

  • 0: Service contract.

  • 1: Intermediary contract.

  • 2: Additional agreement. intermediaryContractID is a required field.

Customer ID.

Contractor ID.

Parent contract ID.

Subject matter of the contract.

Acceptable values:

  • 0: Other.

  • 1: Ad distribution contract.

  • 2: Contract to organize ad distribution.

  • 3: Mediation.

  • 4: Representation.

Description of actions performed by the intermediary representative.

Acceptable values:

  • 0: Other.

  • 1: Actions related to ad distribution.

  • 2: Conclusion of contracts.

  • 3: Commercial representation.

Contract / additional agreement number.

Contract amount.

Date of the contract / additional agreement. Format: YYYY-MM-DD. The contract / additional agreement date cannot be in the future.

The amount includes VAT.

Acceptable values:

  • 0: Amount does not include VAT.

  • 1: Amount includes VAT.

The contractor is responsible for registering and submitting ad creatives.

Acceptable values:

  • 0: No.

  • 1: Yes.

Specifies if this is the final contract in the chain.

Acceptable values:

  • 0: No.

  • 1: Yes.

Required parameter.

Previous
contract
Next
contractor