Function /seller/rental/add
Function invocation
https://json.aftermarket.pl/seller/rental/add
Function description
It inserts new rental transaction into the system.
Input parameters
This function takes the following input parameters:
| Parameter | Type | Required | Default value | Description |
|---|---|---|---|---|
| name | string | YES | Name of the domain to be listed in hire transaction | |
| memberId | string | YES | Lessee login | |
| installment | float | YES | Price of installment | |
| firstInstallment | float | 0 | Another price of first installment | |
| currency | string | YES | Transaction currency | |
| infinite | boolean | YES | Indefinite period of transaction | |
| months | integer | 0 | The duration of transaction (it works only if infinite is false) | |
| cancelMonths | integer | 0 | The duration of transaction after termination | |
| sellerCanCancel | boolean | YES | Transaction can be terminated by lessor | |
| buyerCanCancel | boolean | YES | Transaction can be terminated by lessee (it must be true if infinite is also true) | |
| priceBuyNow | float | 0 | If it is set then lessee will be able to buy domain for this price during rental transaction | |
| saleType | string | "vat" | Possible transaction document (vat - invoice with VAT only, novat - invoice with VAT or invoice without VAT, person - invoice with VAT or no document) |
Return value
New rental identifier (integer value).