Rental Option resource

Methods

  • post - Add an option to a rental
  • put - Change rental option quantity
  • get - Get rental option
  • get - List rental options

Resource

{
    "downPaymentRate": "integer",
    "fees": "number",
    "id": "integer",
    "option": {
        "description": "string",
        "id": "integer",
        "isMandatory": "boolean",
        "name": "string",
        "prices": [
            {
                "currency": {},
                "end_date": "date",
                "price": "number",
                "slot_option_id": "integer",
                "start_date": "date",
                "unit": "string"
            }
        ],
        "subtype": {
            "id": "integer",
            "key": "string",
            "value": "string"
        },
        "type": {
            "id": "integer",
            "key": "string",
            "value": "string"
        }
    },
    "price": "number",
    "quantity": "integer",
    "vatRate": "integer"
}

Properties

Name Type Description Additional
downPaymentRate integer

Minimum down payment percent accepted for the option

 Optional, read only.
fees number

Option full client fees price

 Optional, read only.
id integer

Element ID

 Optional, read only.
option object Optional, read only.
option.description string

Option description

 Optional, read only.
option.id integer

Option ID

 Optional, read only.
option.isMandatory boolean

Returns TRUE if the option is mandatory

 Optional, read only.
option.name string

Option name

 Optional, read only.
option.prices[] array Optional, read only.
option.prices[].currency object Optional, read only.
option.prices[].end_date date

The end date for the price period

 Optional, read only.
option.prices[].price number

Price of option within the period

 Optional, read only.
option.prices[].slot_option_id integer

The slot option ID

 Optional, read only.
option.prices[].start_date date

The start date for the price period

 Optional, read only.
option.prices[].unit string

The price may be fixed or may differ depending of the rental duration (accepted values are PURCHASE, HOUR, DAY, WEEK).

 Optional, read only.
option.subtype object Optional, read only.
option.subtype.id integer

Option Subtype ID

 Optional, read only.
option.subtype.key string

Option Subtype key

 Optional, read only.
option.subtype.value string

Option Subtype value

 Optional, read only.
option.type object Optional, read only.
option.type.id integer

Option Type ID

 Optional, read only.
option.type.key string

Option Type key

 Optional, read only.
option.type.value string

Option Type value

 Optional, read only.
price number

Option unit price

 Optional, read only.
quantity integer

Quantity ordered on the rental

 Optional, read only.
vatRate integer

Vat rate applied on the option

 Optional, read only.