CreateInvoice
Generates an invoice for one or more campaigns in HTML format.
Alert
Disabled method. Use version 5 of the API.
For information about the compatibility of methods between versions 4 and 5, see the Migration guide.
The CreateInvoice (Live) version also exists for this method.
When calling this method, specify one or more campaigns and the amounts to pay that should be shown in the invoice. The method returns the URL of the invoice. Only the user who the method was called on behalf of can access the invoice (the user must log in on Yandex).
Alert
Direct advertisers can generate an invoice only when the campaign has been approved by a moderator (see the campaign parameter StatusModerate).
Recommendations and restrictions
Alert
All campaigns specified in the same method call must be of the same type. More information about campaign types
We recommend generating invoices using as few calls of the CreateInvoice method per day as possible. This recommendation is aimed at improving the performance of the Yandex Direct API. In terms of productivity, it is better to generate one invoice for several campaigns at once than to generate separate invoices by calling the method multiple times.
Restrictions on method calls:
- A single user can call the method 1000 times per day.
- A single campaign can have no more than 30 transactions per day, including generating invoices (CreateInvoice (Live)), transferring funds (TransferMoney (Live)), and delayed payment (PayCampaigns).
Exceeding these limits results in the error 56.
Input data
The input data structure in JSON is shown below.
Alert
It is mandatory to include the finance_token and operation_num parameters in the request. For more information, see the Accessing finance methods.
{
"method": "CreateInvoice",
"finance_token": (string),
"operation_num": (int),
"param": {
/* CreateInvoiceInfo */
"Payments": [
{ /* PayCampElement */
"CampaignID": (int),
"Sum": (float)
}
...
]
}
}
Parameters are described below.
|
Parameter |
Description |
Required |
|
CreateInvoiceInfo object |
||
|
|
Array of |
Yes |
|
PayCampElement object |
||
|
|
The campaign ID. |
Yes |
|
|
The amount in Yandex units to be displayed in the payment invoice. |
Yes |
Output data
If successful, the method returns the URL for the invoice, as shown below. If unsuccessful, an error message is returned.
{
"data": "https://passport.yandex.ru/passport?mode=subscribe&from=balance&retpath=http%3A%2F%2Fbalance.yandex.ru%2Fpaypreview.xml%3Frequest_id%3D14062489%26ref_service_id%3D7%26ui_type%3Dstd"
}
Examples of input data
Python
{
'Payments': [
{'CampaignID': 3193279, 'Sum': 500.0}
{'CampaignID': 3193244, 'Sum': 1200.0}
]
}
PHP
array(
'Payments' => array(
array('CampaignID' => 3193279,'Sum' =500.0)
array('CampaignID' => 3193244,'Sum' =1200.0)
)
)
Perl
{
'Payments' => [
{'CampaignID' => 3193279, 'Sum' =500.0}
{'CampaignID' => 3193279, 'Sum' =1200.0}
]
}