Skip to content
/
Check if customer usage c...

Elevate Customer and Sites API (1.49)

Customer and Site Management

Provides read & write access to customer and site entities.

Definitions

  • Customer - the primary entity within Elevate to represent the person or company who is contracted with a Contract Owner for the provision of products or services
  • Site - within each Customer, there are one or more Sites to represent the physical locations of the Customer

Products and services are associated to the Sites as inventory items. Sites can be setup to receive invoices individually or to consolidate invoices to a particular site or sites

Download OpenAPI description
billing-rest-customer.json
billing-rest-customer.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

customers

Customers represent the person or company contracted to receive products or services

Operations

sites

Sites represent the physical locations for each Customer

Operations

customer-billing-summaries

Billing summary information for customers

Operations

customer-usage-data

Usage data records for customers

Operations

customer-usage-charge-group-category-summaries

Usage quantities and cost grouped by charge group category

Operations

Check if customer usage charge group category summary information exists

Request

Count usage quantities and cost grouped by charge group category id

Security
bearerAuth
Query
customerIdstring(IdFilterParam)required

Required filter by customer

Example: customerId=0
billRunIdstring(IdFilterParam)

Filter by bill run - by default we return the open bill run summary information if this is omitted

Example: billRunId=0
chargeGroupCategoryIdstring(IdFilterParam)

Filter by charge group category identifier

Example: chargeGroupCategoryId=0
chargeGroupCategoryNamestring(StringFilterParam)

Filter by charge group category name

Example: chargeGroupCategoryName=xyz | in:x,y | like:xyz
chargingUnitTypestring(StringFilterParam)

Filter by charge unit type

Example: chargingUnitType=xyz | in:x,y | like:xyz
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v1/customer-usage-charge-group-category-summaries?customerId=0&billRunId=0&chargeGroupCategoryId=0&chargeGroupCategoryName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&chargingUnitType=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exists

Headers
X-Total-Countinteger

Total number of summary records

Body

Returns customer usage charge group category summary information

Request

Returns usage quantities and cost grouped by charge group category id

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
customerIdstring(IdFilterParam)required

Required filter by customer

Example: customerId=0
billRunIdstring(IdFilterParam)

Filter by bill run - by default we return the open bill run summary information if this is omitted

Example: billRunId=0
chargeGroupCategoryIdstring(IdFilterParam)

Filter by charge group category identifier

Example: chargeGroupCategoryId=0
chargeGroupCategoryNamestring(StringFilterParam)

Filter by charge group category name

Example: chargeGroupCategoryName=xyz | in:x,y | like:xyz
chargingUnitTypestring(StringFilterParam)

Filter by charge unit type

Example: chargingUnitType=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/customer-usage-charge-group-category-summaries?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&customerId=0&billRunId=0&chargeGroupCategoryId=0&chargeGroupCategoryName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&chargingUnitType=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
customerIdinteger(int64)read-only

Customer identifier

Example: 1
billRunIdinteger(int64)

Bill run identifier

Example: 0
chargingUnitTypestring(ChargingUnitType)

Charging unit i.e. duration or data (MB) or one off

Enum"DURATION""MB""ONE_OFF"
chargeGroupCategoryIdinteger(int64)read-only

Internal identifier of charge group category

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

Charge group category name

quantitynumberread-only

The quantity of the usage records for this charge group category in the chargingUnitType

Example: 80
priceInMajorCurrencynumberread-only

Price for the charge group category in major currency (e.g pounds/dollars/euros)

Example: 100
]
Response
application/json
[
  {
    "customerId": 1,
    "billRunId": 0,
    "chargingUnitType": "DURATION",
    "chargeGroupCategoryId": 1,
    "chargeGroupCategoryName": "string",
    "quantity": 80,
    "priceInMajorCurrency": 100
  }
]

customer-usage-by-charging-unit-type-summaries

Usage quantities and cost grouped by charging unit (DURATION/MB/ONE_OFF)

Operations

customer-usage-site-summaries

Usage quantities and cost grouped by site

Operations