Create a new rental product

post/rental-products
SecuritybearerAuth
Request
Request Body schema: application/json

New rental product

rentalProductCategoryId
required
integer <int64>

Rental product category identifier

productType
required
string (RentalProductType)

Rental product type

Enum: "PRODUCT" "FEATURE" "EVENT"
name
required
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Product name

invoicePresentationName
required
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Invoice Presentation name

parentRentalProductId
integer <int64>

Parent rental product identifier

supplierId
required
integer <int64>

Supplier identifier

supplierProductNames
Array of strings

Mapping name(s) used by the supplier in their invoice file

taxBandId
required
integer <int64>

Supplier account identifier

availableFrom
required
string <date>

Product is available from this date

nominalCode
string [ 1 .. 50 ] characters [a-zA-Z0-9\p{L}.\-_]*

Nominal code

availableTo
string <date>

Product is available to this date

doNotProRate
boolean
Default: false

Do not pro rate

alignedToStart
boolean
Default: false

Default value for alignedToStart when creating rental product inventories

alignedToBillPeriod
boolean
Default: false

Default value for alignedToBillPeriod when creating rental product inventories

billInitialChargesImmediately
boolean
Default: false

Default value for billInitialChargesImmediately when creating rental product inventories

forceBillPeriods
integer <int32> [ 0 .. 731 ]
Default: 0

Default value for forceBillPeriods when creating rental product inventories. When this is 0, forceBilling on the rental product inventories will be set to false.

additionalProductReferenceRequired
boolean
Default: false

Additional product reference is required on rental product inventories

additionalProductReferenceFormat
string [ 0 .. 50 ] characters

Regular expression (regex) used to validate the additional product reference on rental product inventories

linkedUsageProductId
integer <int64>

Linked usage product identifier

productReferenceRequired
boolean
Default: false

Product reference is required on rental product

productReferenceFormat
string [ 0 .. 50 ] characters

Regular expression (regex) used to validate the product reference on rental product inventories

productReferenceMayBeDDIRange
boolean
Default: false

Product reference may be a DDI range on rental product

generateWhenParentCreated
boolean
Default: false

Generate a FEATURE or EVENT RPI for this product when the parentRentalProduct is assigned to a new RPI. Will skip generation for products whose availableTo is in the past.

Array of objects (CustomField)
Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "rentalProductCategoryId": 1,
  • "productType": "PRODUCT",
  • "name": "string",
  • "invoicePresentationName": "string",
  • "parentRentalProductId": 1,
  • "supplierId": 0,
  • "supplierProductNames": [
    • "string"
    ],
  • "taxBandId": 1,
  • "availableFrom": "2019-08-24",
  • "nominalCode": "string",
  • "availableTo": "2019-08-24",
  • "doNotProRate": false,
  • "alignedToStart": false,
  • "alignedToBillPeriod": false,
  • "billInitialChargesImmediately": false,
  • "forceBillPeriods": 1,
  • "additionalProductReferenceRequired": false,
  • "additionalProductReferenceFormat": "[a-zA-Z0-9]{4,15}",
  • "linkedUsageProductId": 1,
  • "productReferenceRequired": false,
  • "productReferenceFormat": ".*",
  • "productReferenceMayBeDDIRange": false,
  • "generateWhenParentCreated": false,
  • "customFields": [
    • {
      • "label": "string",
      • "value": "string"
      }
    ]
}
Response samples
application/json
{
  • "id": 1,
  • "rentalProductCategoryId": 1,
  • "productType": "PRODUCT",
  • "name": "string",
  • "invoicePresentationName": "string",
  • "parentRentalProductId": 1,
  • "supplierId": 0,
  • "supplierProductNames": [
    • "string"
    ],
  • "taxBandId": 1,
  • "availableFrom": "2019-08-24",
  • "nominalCode": "string",
  • "availableTo": "2019-08-24",
  • "doNotProRate": false,
  • "alignedToStart": false,
  • "alignedToBillPeriod": false,
  • "billInitialChargesImmediately": false,
  • "forceBillPeriods": 1,
  • "additionalProductReferenceRequired": false,
  • "additionalProductReferenceFormat": "[a-zA-Z0-9]{4,15}",
  • "linkedUsageProductId": 1,
  • "productReferenceRequired": false,
  • "productReferenceFormat": ".*",
  • "productReferenceMayBeDDIRange": false,
  • "generateWhenParentCreated": false,
  • "customFields": [
    • {
      • "id": 1,
      • "label": "string",
      • "value": "string"
      }
    ]
}