Skip to content
/
Create a new rental categ...

Elevate Products API (2.13)

Product Management

Provides read & write access to usage and rental product entities

Definitions

  • Rental Product - a product or service that is billed on a fixed charge; for example, a broadband service, connection or site visit
  • Usage Product - a product that is billed based on it's usage, such as calls or data; these typically fall into one of the following categories within Elevate; outbound such as CPS/IDA, Mobile or VoIP; and Inbound
Download OpenAPI description
billing-rest-product.json
billing-rest-product.yaml
Languages
Servers
https://rest.elevatebilling.com/v2

usage-products

Usage products represent products that are billed based on usage

Operations

rental-products

Rental products represent a product or service that is billed on a fixed charge

Operations

custom-fields

Custom fields can be added to usage or rental products or to rental product inventory lines

Operations

rental-product-category

Rental product categories are used to group rental products together

Operations

Get a list of available rental product categories

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
namestring(StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/rental-product-categories?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Rental product category identifier

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

Rental product category name

startDatestring(date)required

Rental product category start date

endDatestring(date)

Rental product category end date

siMaintainedbooleanread-only

If true the product categories is maintained by SI. The products under this category cannot be created,updated or deleted

Default false
contractOwnerIdsArray of integers(int32)non-emptyrequired

Contract owner identifiers

Example: [1]
supplierAccountIdsArray of integers(int32)

Supplier account ids with this category

Example: [1]
displayIconstring(DisplayIconType)

Display icon for the rental product category

Enum"fa-wifi""fa-sitemap""fa-server""fa-hdd-o""fa-database""fa-plug""fa-bolt""fa-cloud""fa-cloud-download""fa-cloud-upload"
]
Response
application/json
[
  {
    "id": 1,
    "name": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "siMaintained": false,
    "contractOwnerIds": [ … ],
    "supplierAccountIds": [ … ],
    "displayIcon": "fa-wifi"
  }
]

Create a new rental category

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New rental product category

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

Rental product category name

startDatestring(date)required

Rental product category start date

endDatestring(date)

Rental product category end date

contractOwnerIdsArray of integers(int32)non-emptyrequired

Contract owner identifiers

Example: [1]
supplierAccountIdsArray of integers(int32)

Supplier account ids with this category

Example: [1]
displayIconstring(DisplayIconType)

Display icon for the rental product category

Enum"fa-wifi""fa-sitemap""fa-server""fa-hdd-o""fa-database""fa-plug""fa-bolt""fa-cloud""fa-cloud-download""fa-cloud-upload"
curl -i -X POST \
  https://rest.elevatebilling.com/v2/rental-product-categories \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "contractOwnerIds": [
      1
    ],
    "supplierAccountIds": [
      1
    ],
    "displayIcon": "fa-wifi"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Rental product category identifier

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

Rental product category name

startDatestring(date)required

Rental product category start date

endDatestring(date)

Rental product category end date

siMaintainedbooleanread-only

If true the product categories is maintained by SI. The products under this category cannot be created,updated or deleted

Default false
contractOwnerIdsArray of integers(int32)non-emptyrequired

Contract owner identifiers

Example: [1]
supplierAccountIdsArray of integers(int32)

Supplier account ids with this category

Example: [1]
displayIconstring(DisplayIconType)

Display icon for the rental product category

Enum"fa-wifi""fa-sitemap""fa-server""fa-hdd-o""fa-database""fa-plug""fa-bolt""fa-cloud""fa-cloud-download""fa-cloud-upload"
Response
application/json
{
  "id": 1,
  "name": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "siMaintained": false,
  "contractOwnerIds": [
    1
  ],
  "supplierAccountIds": [
    1
  ],
  "displayIcon": "fa-wifi"
}

Get a specific rental product category

Request

Security
bearerAuth
Path
rental_product_category_idinteger(int64)(IdParam)>= 1required

Rental product category identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v2/rental-product-categories/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Rental product category found

Bodyapplication/json
idinteger(int64)read-only

Rental product category identifier

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

Rental product category name

startDatestring(date)required

Rental product category start date

endDatestring(date)

Rental product category end date

siMaintainedbooleanread-only

If true the product categories is maintained by SI. The products under this category cannot be created,updated or deleted

Default false
contractOwnerIdsArray of integers(int32)non-emptyrequired

Contract owner identifiers

Example: [1]
supplierAccountIdsArray of integers(int32)

Supplier account ids with this category

Example: [1]
displayIconstring(DisplayIconType)

Display icon for the rental product category

Enum"fa-wifi""fa-sitemap""fa-server""fa-hdd-o""fa-database""fa-plug""fa-bolt""fa-cloud""fa-cloud-download""fa-cloud-upload"
Response
application/json
{
  "id": 1,
  "name": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "siMaintained": false,
  "contractOwnerIds": [
    1
  ],
  "supplierAccountIds": [
    1
  ],
  "displayIcon": "fa-wifi"
}

Delete a rental product category

Request

Security
bearerAuth
Path
rental_product_category_idinteger(int64)(IdParam)>= 1required

Rental product category identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v2/rental-product-categories/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body

Update a specific rental product category

Request

Update a specific rental product category

Security
bearerAuth
Path
rental_product_category_idinteger(int64)(IdParam)>= 1required

Rental product category identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed

Array [
opstringrequired

The JSON Patch operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations

fromstring

A string containing a JSON Pointer value

]
curl -i -X PATCH \
  https://rest.elevatebilling.com/v2/rental-product-categories/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/name",
      "value": "insurance"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Rental product category identifier

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

Rental product category name

startDatestring(date)required

Rental product category start date

endDatestring(date)

Rental product category end date

siMaintainedbooleanread-only

If true the product categories is maintained by SI. The products under this category cannot be created,updated or deleted

Default false
contractOwnerIdsArray of integers(int32)non-emptyrequired

Contract owner identifiers

Example: [1]
supplierAccountIdsArray of integers(int32)

Supplier account ids with this category

Example: [1]
displayIconstring(DisplayIconType)

Display icon for the rental product category

Enum"fa-wifi""fa-sitemap""fa-server""fa-hdd-o""fa-database""fa-plug""fa-bolt""fa-cloud""fa-cloud-download""fa-cloud-upload"
Response
application/json
{
  "id": 1,
  "name": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "siMaintained": false,
  "contractOwnerIds": [
    1
  ],
  "supplierAccountIds": [
    1
  ],
  "displayIcon": "fa-wifi"
}