Skip to content
customer-usage-data/
Returns usage data inform...

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

Returns usage data information for a customer

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

Filter by customer id

Example: customerId=0
siteIdstring(IdFilterParam)

Filter by site id

Example: siteId=0
billRunIdstring(IdFilterParam)

Filter by bill run id

Example: billRunId=0
productReferencestring(StringFilterParam)

Filter by product reference

Example: productReference=xyz | in:x,y | like:xyz
serviceIdstring(StringFilterParam)

Filter by serviceId

Example: serviceId=xyz | in:x,y | like:xyz
eventDateFromstring(DateTimeFilterParam)

Filter based on events from this date

Example: eventDateFrom=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
eventDateTostring(DateTimeFilterParam)

Filter based on events until this date

Example: eventDateTo=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
destinationstring(StringFilterParam)

Filter by destination/origin

Example: destination=xyz | in:x,y | like:xyz
excludeZeroValueRecordsstring(BooleanFilterParam)

Filter out zero value entries

Example: excludeZeroValueRecords=true | false
siteNamestring(StringFilterParam)

Filter by site name

Example: siteName=xyz | in:x,y | like:xyz
descriptionstring(StringFilterParam)

Filter by usage record description

Example: description=xyz | in:x,y | like:xyz
typestring(StringFilterParam)

Filter by charging unit type (ONE_OFF, MB, DURATION)

Example: type=xyz | in:x,y | like:xyz
inBundlestring(BooleanFilterParam)

Filter by whether the record is derived from a bundle

Example: inBundle=true | false
logicstring(StringFilterParam)

Logical operator used to combine filters. Accepted values AND (default), OR. When AND is used, only records matching all filters are returned. When OR is used, records matching any filter are returned

Example: logic=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/customer-usage-data?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&customerId=0&siteId=0&billRunId=0&productReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&serviceId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&eventDateFrom=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&eventDateTo=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&destination=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&excludeZeroValueRecords=true+%2C+false&siteName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&description=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&type=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&inBundle=true+%2C+false&logic=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Customer usage identifier

Example: 1
customerIdinteger(int64)

Customer identifier

Example: 0
siteIdinteger(int64)

Site identifier

Example: 0
siteNamestring<= 255 characters

Site name

billRunIdinteger(int64)

Bill run identifier

Example: 0
eventDatestring(date-time)read-only

Event date/time

productReferencestring(int64)

Product Reference identifier

Example: 0
serviceIdstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Service ID

destinationstring[ 4 .. 100 ] characters

Destination

chargeGroupIdinteger(int64)

Charge group identifier

Example: 1
callClassstring[ 4 .. 255 ] characters

Call class

oneOffQuantityinteger(int32)

One-off quantity

dataQuantitynumber

Data (MB) quantity

durationQuantityinteger(int32)

Duration (seconds)

sellPricenumber

Sell Price

preDiscountedSellPricenumber

Pre-discounted sell price

buyPricenumber

Buy Price

ratedBuyPricenumber

Rated buy Price

profitnumber

Profit

profitPercentagenumber

Profit percentage

marginPercentagenumber

Margin percentage

timeBandstring(TimeBand)

Time band

Enum"OFFPEAK""PEAK""WEEKEND"
usageProductIdinteger(int64)

Usage product identifier

Example: 1
usageDirectionstring(UsageDirection)

Usage direction

Enum"OUTBOUND""INBOUND"
isdnboolean

Is ISDN?

Default false
additionalInfoGeneralstring

Additional info general

additionalInfoElectronicstring

Additional info electronic summary

supplierAccountIdinteger(int64)

Supplier account identifier

Example: 1
fileNamestring[ 4 .. 255 ] characters

File name

loadedDatestring(date)

Loaded date/time

parserNamestring[ 4 .. 255 ] characters

Parser name

fileTypestring[ 4 .. 50 ] characters

File type

descriptionstring<= 255 characters

Usage record description

typestring(ChargingUnitType)

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

Enum"DURATION""MB""ONE_OFF"
inBundleboolean

Whether the record is derived from a bundle

Default false
]
Response
application/json
[
  {
    "id": 1,
    "customerId": 0,
    "siteId": 0,
    "siteName": "string",
    "billRunId": 0,
    "eventDate": "2019-08-24T14:15:22Z",
    "productReference": 0,
    "serviceId": "string",
    "destination": "string",
    "chargeGroupId": 1,
    "callClass": "string",
    "oneOffQuantity": 0,
    "dataQuantity": 0,
    "durationQuantity": 0,
    "sellPrice": 0,
    "preDiscountedSellPrice": 0,
    "buyPrice": 0,
    "ratedBuyPrice": 0,
    "profit": 0,
    "profitPercentage": 0,
    "marginPercentage": 0,
    "timeBand": "OFFPEAK",
    "usageProductId": 1,
    "usageDirection": "OUTBOUND",
    "isdn": false,
    "additionalInfoGeneral": "string",
    "additionalInfoElectronic": "string",
    "supplierAccountId": 1,
    "fileName": "string",
    "loadedDate": "2019-08-24",
    "parserName": "string",
    "fileType": "string",
    "description": "string",
    "type": "DURATION",
    "inBundle": false
  }
]

customer-usage-charge-group-category-summaries

Usage quantities and cost grouped by charge group category

Operations

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