Create a new rental product inventory

post/rental-product-inventories
SecuritybearerAuth
Request
header Parameters
disable_adding_linked_rentals
string (BooleanFilterParam)

A boolean flag to specify that any rental product inventories set to auto-generate (for the child rental products of the rental product assigned to this RPI) should be skipped

Example: true | false
Request Body schema: application/json

New rental product inventory

siteId
required
integer <int64>

Site identifier

rentalProductId
required
integer <int64>

Rental product identifier

parentRentalProductInventoryId
integer <int64>

Parent product identifier

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

Product name as presented on invoice

supplierAccountId
required
integer <int64>

Supplier account identifier

startDate
required
string <date>

Rental product inventory start date

endDate
string <date>

Rental product inventory end date

invoiceFrequency
required
integer <int32>

The rental records will be generated on every invoice per period (day/week/month) depending on the billing cycle with which the customer is associated. However you may wish to group the charges so they are included a frequency per period. So you might set the frequency to 3 and on the monthly cycle it would have a line item on the invoice for this RPI that covers three months. The next two months no line item on the invoice will be listed

quantity
required
integer <int32> [ 1 .. 1000000 ]

Quantity

productReference
string [ 1 .. 100 ] characters ^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Product reference

additionalProductReference
string [ 1 .. 100 ] characters ^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

In the case of an ISDN service, this reference can be used to link the usage product inventory (UPI) and the Rental Product Inventory (RPI) since a main billing number (MBN) would not be available

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

Label

treatStartAsWholePeriod
boolean
Default: false

If enabled this property will stop pro-rated charges being calculated at the start of the rental product inventory.

treatEndAsWholePeriod
boolean
Default: false

If enabled this property will stop pro-rated charges being calculated at the end of the rental product inventory.

contractStartDate
string <date>
Deprecated

Contract start date

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

User Id

userEmail
string [ 1 .. 255 ] characters [a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...

User email address

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

Cost centre code

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

Department code

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

Feature number

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

Nominal code

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

Notes

billable
boolean
Default: true

Is this rental product inventory to be billed now? If it is un-ticked then it will not appear on an invoice

inFlightOrder
boolean
Default: false

If selected this property denotes that the order has not yet completed

billInitialChargesImmediately
boolean
Default: false

When enabled, the initial rental charge (usually a part-period charge) will be billed immediately via an adhoc bill run

alignedToStart
boolean
Default: false

The Rental Product Inventory (RPI) will align to the anniversary of the start date as opposed to pro-rating to align with the billing period. For example, if the start date is the 10th, the RPI will bill every month, every quarter, and every year from the 10th with no pro-rating. This feature is particularly useful for annual charges to ensure that only 12 months are billed and that the charge will recur every 12 months on the anniversary of the start date

alignedToBillPeriod
boolean
Default: false

Where Rental Product Inventory (RPI) are added with start dates that are in the past, the default behaviour is to pro-rate multiple months up to the current bill period and then bill the required frequency. For example, this could result in 2.5 months pro-rated plus the next quarter being charged. Using this feature ensures that the RPI will pro-rate a maximum of one part month and then bill the required frequency. For example, a quarterly charge with a start date 2.5 months in the past will pro-rate the 0.5 month and then bill a full quarter. Note that this feature should only be used where start dates are in the past AND the billing frequency is not monthly

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

Unique reference for the external order. Buyer's side reference

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

Unique reference for the external order. Seller's side reference

pendingEndDate
string <date>

Inflight order pending end date

forceBilling
boolean

When this flag is set the rental product inventory will be rated if the start date is less than the billing run end date + the pricing frequency. So if you add an RPI to start at the start of the next bill run it will be rated in that bill run rather than in the next. The default value, if not specified, is defined by the contract owner's forceBillingDefault flag. If you specify just the forceBilling = true then this is the same as forceBillPeriods = 1 and if you specify the forceBilling = false then this is the same as forceBillPeriods = 0.

forceBillPeriods
integer <int32> [ 0 .. 731 ]

Number of bill periods to force. ForceBillPeriods is ignored when forceBilling is false.

object (Address)
Array of objects (CustomField)
Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Request samples
application/json
{
  • "siteId": 1,
  • "rentalProductId": 1,
  • "parentRentalProductInventoryId": 1,
  • "invoicePresentationProductName": "string",
  • "supplierAccountId": 1,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "invoiceFrequency": 0,
  • "quantity": 1,
  • "productReference": "string",
  • "additionalProductReference": "string",
  • "label": "string",
  • "treatStartAsWholePeriod": false,
  • "treatEndAsWholePeriod": false,
  • "contractStartDate": "2019-08-24",
  • "userId": "string",
  • "userEmail": "string",
  • "costCentreCode": "string",
  • "departmentCode": "string",
  • "featureNumber": "string",
  • "nominalCode": "string",
  • "notes": "string",
  • "billable": true,
  • "inFlightOrder": false,
  • "billInitialChargesImmediately": false,
  • "alignedToStart": false,
  • "alignedToBillPeriod": false,
  • "externalOrderReference": "string",
  • "externalNetworkOrderReference": "string",
  • "pendingEndDate": "2019-08-24",
  • "forceBilling": true,
  • "forceBillPeriods": 1,
  • "installationAddress": {
    • "businessName": "string",
    • "address1": "string",
    • "address2": "string",
    • "address3": "string",
    • "town": "string",
    • "county": "string",
    • "postcode": "string",
    • "country": "GB"
    },
  • "customFields": [
    • {
      • "label": "string",
      • "value": "string"
      }
    ]
}
Response samples
application/json
{
  • "id": 1,
  • "siteId": 1,
  • "rentalProductId": 1,
  • "parentRentalProductInventoryId": 1,
  • "invoicePresentationProductName": "string",
  • "supplierAccountId": 1,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "invoiceFrequency": 0,
  • "quantity": 1,
  • "productReference": "string",
  • "additionalProductReference": "string",
  • "label": "string",
  • "treatStartAsWholePeriod": false,
  • "treatEndAsWholePeriod": false,
  • "contractStartDate": "2019-08-24",
  • "userId": "string",
  • "userEmail": "string",
  • "costCentreCode": "string",
  • "departmentCode": "string",
  • "featureNumber": "string",
  • "nominalCode": "string",
  • "notes": "string",
  • "billable": true,
  • "inFlightOrder": false,
  • "billInitialChargesImmediately": false,
  • "alignedToStart": false,
  • "alignedToBillPeriod": false,
  • "externalOrderReference": "string",
  • "externalNetworkOrderReference": "string",
  • "pendingEndDate": "2019-08-24",
  • "forceBilling": true,
  • "forceBillPeriods": 1,
  • "installationAddress": {
    • "id": 1,
    • "businessName": "string",
    • "address1": "string",
    • "address2": "string",
    • "address3": "string",
    • "town": "string",
    • "county": "string",
    • "postcode": "string",
    • "country": "GB"
    },
  • "customFields": [
    • {
      • "id": 1,
      • "label": "string",
      • "value": "string"
      }
    ]
}