Skip to content
/
Retrieve a page of buy ra...

Elevate Mediation and Suspense API (1.1)

File mediation and usage suspense management

Provides read access to mediation file entities and usage suspense summary entities

Definitions

  • Mediation File - a representation of a mediation file loaded into the Elevate billing system
  • Usage Suspense - a usage record that could not be rated or matched to a product inventory item and is therefore held in suspense awaiting resolution
  • Suspense Summary - an aggregated view of usage records in suspense, grouped by a specific dimension (e.g. product reference, call class, dial string, or rate card) to help identify the root cause and volume of unresolved records
Download OpenAPI description
billing-rest-mediation.json
billing-rest-mediation.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

mediation-files

A representation of a mediation file that Elevate loads and processes

Operations

usage-suspense-summary

Aggregated views of usage records in suspense

Operations

Retrieve a page of product reference suspense summary records

Request

Returns product reference suspense summary records. Use pagination and filters to narrow results

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
productReferencestring(StringFilterParam)

Filter by product reference

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

Filter by service identifier

Example: serviceId=xyz | in:x,y | like:xyz
supplierIdstring(IdFilterParam)

Filter by supplier identifier

Example: supplierId=0
supplierAccountIdstring(IdFilterParam)

Filter by supplier account identifier

Example: supplierAccountId=0
firstEventDatestring(DateTimeFilterParam)

Filter by first event date/time

Example: firstEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
lastEventDatestring(DateTimeFilterParam)

Filter by last event date/time

Example: lastEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
totalSupplierCoststring(NumericFilterParam)

Filter by total supplier cost

Example: totalSupplierCost=1 | in:1,2 | gt:1 | lt:1 | ge:1 | le:1
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/usage-product-reference-suspense-summary?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&productReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&serviceId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&supplierId=0&supplierAccountId=0&firstEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&lastEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&totalSupplierCost=1+%7C+in%3A1%2C2+%7C+gt%3A1+%7C+lt%3A1+%7C+ge%3A1+%7C+le%3A1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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

Product reference

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

Service identifier

Example: "AB123345"
supplierIdinteger(int64)read-only

Supplier identifier

Example: 5
supplierAccountIdinteger(int64)read-only

Supplier account identifier

Example: 1
firstEventDatestring(date-time)read-onlyrequired

Date and time of the first event in this group

Example: "2026-07-24T14:15:22Z"
lastEventDatestring(date-time)read-onlyrequired

Date and time of the last event in this group

Example: "2026-08-24T14:15:22Z"
totalSupplierCostnumber(double)>= 0read-onlyrequired

Total supplier cost for this group

Example: 250
totalQuantityinteger(int64)>= 0read-onlyrequired

Total quantity for this group

Example: 55
totalRecordsinteger(int64)>= 1read-onlyrequired

Total number of suspense records in this group

Example: 125
]
Response
application/json
[
  {
    "productReference": "VM123456",
    "serviceId": "AB123345",
    "supplierId": 5,
    "supplierAccountId": 1,
    "firstEventDate": "2026-07-24T14:15:22Z",
    "lastEventDate": "2026-08-24T14:15:22Z",
    "totalSupplierCost": 250,
    "totalQuantity": 55,
    "totalRecords": 125
  }
]

Retrieve a page of call class suspense summary records

Request

Returns call class suspense summary records. Use pagination and filters to narrow results

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
callClassstring(StringFilterParam)

Filter by call class

Example: callClass=xyz | in:x,y | like:xyz
referenceDateSourceIdstring(IdFilterParam)

Filter by reference date source identifier

Example: referenceDateSourceId=0
secondaryReferenceDateSourceIdstring(IdFilterParam)

Filter by secondary reference date source identifier

Example: secondaryReferenceDateSourceId=0
usageProductIdstring(IdFilterParam)

Filter by usage product identifier

Example: usageProductId=0
supplierIdstring(IdFilterParam)

Filter by supplier identifier

Example: supplierId=0
supplierAccountIdstring(IdFilterParam)

Filter by supplier account identifier

Example: supplierAccountId=0
firstEventDatestring(DateTimeFilterParam)

Filter by first event date/time

Example: firstEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
lastEventDatestring(DateTimeFilterParam)

Filter by last event date/time

Example: lastEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
totalSupplierCoststring(NumericFilterParam)

Filter by total supplier cost

Example: totalSupplierCost=1 | in:1,2 | gt:1 | lt:1 | ge:1 | le:1
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/usage-call-class-suspense-summary?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&callClass=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&referenceDateSourceId=0&secondaryReferenceDateSourceId=0&usageProductId=0&supplierId=0&supplierAccountId=0&firstEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&lastEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&totalSupplierCost=1+%7C+in%3A1%2C2+%7C+gt%3A1+%7C+lt%3A1+%7C+ge%3A1+%7C+le%3A1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
callClassstring[ 1 .. 100 ] characters[a-zA-Z0-9_]+read-onlyrequired

Call class

Example: "ABC_TO_CDE"
referenceDateSourceIdinteger(int64)read-only

Reference date source identifier

Example: 4
secondaryReferenceDateSourceIdinteger(int64)read-only

Secondary reference date source identifier

Example: 5
usageProductIdinteger(int64)read-only

Usage product identifier

Example: 5
supplierIdinteger(int64)read-only

Supplier identifier

Example: 5
supplierAccountIdinteger(int64)read-only

Supplier account identifier

Example: 1
firstEventDatestring(date-time)read-onlyrequired

Date and time of the first event in this group

Example: "2026-07-24T14:15:22Z"
lastEventDatestring(date-time)read-onlyrequired

Date and time of the last event in this group

Example: "2026-08-24T14:15:22Z"
totalSupplierCostnumber(double)>= 0read-onlyrequired

Total supplier cost for this group

Example: 250
totalQuantityinteger(int64)>= 0read-onlyrequired

Total quantity for this group

Example: 100
totalRecordsinteger(int64)>= 1read-onlyrequired

Total number of suspense records in this group

Example: 125
]
Response
application/json
[
  {
    "callClass": "ABC_TO_CDE",
    "referenceDateSourceId": 4,
    "secondaryReferenceDateSourceId": 5,
    "usageProductId": 5,
    "supplierId": 5,
    "supplierAccountId": 1,
    "firstEventDate": "2026-07-24T14:15:22Z",
    "lastEventDate": "2026-08-24T14:15:22Z",
    "totalSupplierCost": 250,
    "totalQuantity": 100,
    "totalRecords": 125
  }
]

Retrieve a page of dial string suspense summary records

Request

Returns dial string suspense summary records. Use pagination and filters to narrow results

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
dialStringstring(StringFilterParam)

Filter by dial string

Example: dialString=xyz | in:x,y | like:xyz
referenceDateSourceIdstring(IdFilterParam)

Filter by reference date source identifier

Example: referenceDateSourceId=0
secondaryReferenceDateSourceIdstring(IdFilterParam)

Filter by secondary reference date source identifier

Example: secondaryReferenceDateSourceId=0
usageProductIdstring(IdFilterParam)

Filter by usage product identifier

Example: usageProductId=0
supplierIdstring(IdFilterParam)

Filter by supplier identifier

Example: supplierId=0
supplierAccountIdstring(IdFilterParam)

Filter by supplier account identifier

Example: supplierAccountId=0
firstEventDatestring(DateTimeFilterParam)

Filter by first event date/time

Example: firstEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
lastEventDatestring(DateTimeFilterParam)

Filter by last event date/time

Example: lastEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
totalSupplierCoststring(NumericFilterParam)

Filter by total supplier cost

Example: totalSupplierCost=1 | in:1,2 | gt:1 | lt:1 | ge:1 | le:1
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/usage-dialstring-suspense-summary?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&dialString=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&referenceDateSourceId=0&secondaryReferenceDateSourceId=0&usageProductId=0&supplierId=0&supplierAccountId=0&firstEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&lastEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&totalSupplierCost=1+%7C+in%3A1%2C2+%7C+gt%3A1+%7C+lt%3A1+%7C+ge%3A1+%7C+le%3A1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
dialStringstring[ 3 .. 15 ] characters[0-9]+read-onlyrequired

Dial string

Example: "02132568"
referenceDateSourceIdinteger(int64)read-only

Reference date source identifier

Example: 4
secondaryReferenceDateSourceIdinteger(int64)read-only

Secondary reference date source identifier

Example: 5
usageProductIdinteger(int64)read-only

Usage product identifier

Example: 5
supplierIdinteger(int64)read-only

Supplier identifier

Example: 5
supplierAccountIdinteger(int64)read-only

Supplier account identifier

Example: 1
firstEventDatestring(date-time)read-onlyrequired

Date and time of the first event in this group

Example: "2026-07-24T14:15:22Z"
lastEventDatestring(date-time)read-onlyrequired

Date and time of the last event in this group

Example: "2026-08-24T14:15:22Z"
totalSupplierCostnumber(double)>= 0read-onlyrequired

Total supplier cost for this group

Example: 250
totalQuantityinteger(int64)>= 0read-onlyrequired

Total quantity for this group

Example: 100
totalRecordsinteger(int64)>= 1read-onlyrequired

Total number of suspense records in this group

Example: 125
]
Response
application/json
[
  {
    "dialString": "02132568",
    "referenceDateSourceId": 4,
    "secondaryReferenceDateSourceId": 5,
    "usageProductId": 5,
    "supplierId": 5,
    "supplierAccountId": 1,
    "firstEventDate": "2026-07-24T14:15:22Z",
    "lastEventDate": "2026-08-24T14:15:22Z",
    "totalSupplierCost": 250,
    "totalQuantity": 100,
    "totalRecords": 125
  }
]

Retrieve a page of sell rate card suspense summary records

Request

Returns sell rate card suspense summary records. Use pagination and filters to narrow results

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 identifier

Example: customerId=0
siteIdstring(IdFilterParam)

Filter by site identifier

Example: siteId=0
usageProductIdstring(IdFilterParam)

Filter by usage product identifier

Example: usageProductId=0
supplierIdstring(IdFilterParam)

Filter by supplier identifier

Example: supplierId=0
supplierAccountIdstring(IdFilterParam)

Filter by supplier account identifier

Example: supplierAccountId=0
firstEventDatestring(DateTimeFilterParam)

Filter by first event date/time

Example: firstEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
lastEventDatestring(DateTimeFilterParam)

Filter by last event date/time

Example: lastEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
totalSupplierCoststring(NumericFilterParam)

Filter by total supplier cost

Example: totalSupplierCost=1 | in:1,2 | gt:1 | lt:1 | ge:1 | le:1
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/usage-sell-rate-card-suspense-summary?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&customerId=0&siteId=0&usageProductId=0&supplierId=0&supplierAccountId=0&firstEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&lastEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&totalSupplierCost=1+%7C+in%3A1%2C2+%7C+gt%3A1+%7C+lt%3A1+%7C+ge%3A1+%7C+le%3A1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
customerIdinteger(int64)read-only

Customer identifier

Example: 2225
siteIdinteger(int64)read-only

Site identifier

Example: 2226
usageProductIdinteger(int64)read-only

Usage product identifier

Example: 5
productReferencestring[ 1 .. 100 ] charactersread-only

Product reference

Example: "VMC123456"
supplierIdinteger(int64)read-only

Supplier identifier

Example: 5
supplierAccountIdinteger(int64)read-only

Supplier account identifier

Example: 1
firstEventDatestring(date-time)read-onlyrequired

Date and time of the first event in this group

Example: "2026-07-24T14:15:22Z"
lastEventDatestring(date-time)read-onlyrequired

Date and time of the last event in this group

Example: "2026-08-24T14:15:22Z"
totalSupplierCostnumber(double)>= 0read-onlyrequired

Total supplier cost for this group

Example: 250
totalQuantityinteger(int64)>= 0read-onlyrequired

Total quantity for this group

Example: 100
totalRecordsinteger(int64)>= 1read-onlyrequired

Total number of suspense records in this group

Example: 125
]
Response
application/json
[
  {
    "customerId": 2225,
    "siteId": 2226,
    "usageProductId": 5,
    "productReference": "VMC123456",
    "supplierId": 5,
    "supplierAccountId": 1,
    "firstEventDate": "2026-07-24T14:15:22Z",
    "lastEventDate": "2026-08-24T14:15:22Z",
    "totalSupplierCost": 250,
    "totalQuantity": 100,
    "totalRecords": 125
  }
]

Retrieve a page of sell rate suspense summary records

Request

Returns sell rate suspense summary records. Use pagination and filters to narrow results

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

Filter by usage product identifier

Example: usageProductId=0
usageRateCardIdstring(IdFilterParam)

Filter by usage rate card identifier

Example: usageRateCardId=0
chargeGroupIdstring(IdFilterParam)

Filter by charge group identifier

Example: chargeGroupId=0
supplierIdstring(IdFilterParam)

Filter by supplier identifier

Example: supplierId=0
supplierAccountIdstring(IdFilterParam)

Filter by supplier account identifier

Example: supplierAccountId=0
timeBandstring(StringFilterParam)

Filter by time band

Example: timeBand=xyz | in:x,y | like:xyz
referenceDateSourceIdstring(IdFilterParam)

Filter by reference date source identifier

Example: referenceDateSourceId=0
secondaryReferenceDateSourceIdstring(IdFilterParam)

Filter by secondary reference date source identifier

Example: secondaryReferenceDateSourceId=0
firstEventDatestring(DateTimeFilterParam)

Filter by first event date/time

Example: firstEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
lastEventDatestring(DateTimeFilterParam)

Filter by last event date/time

Example: lastEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
totalSupplierCoststring(NumericFilterParam)

Filter by total supplier cost

Example: totalSupplierCost=1 | in:1,2 | gt:1 | lt:1 | ge:1 | le:1
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/usage-sell-rate-suspense-summary?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&usageProductId=0&usageRateCardId=0&chargeGroupId=0&supplierId=0&supplierAccountId=0&timeBand=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&referenceDateSourceId=0&secondaryReferenceDateSourceId=0&firstEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&lastEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&totalSupplierCost=1+%7C+in%3A1%2C2+%7C+gt%3A1+%7C+lt%3A1+%7C+ge%3A1+%7C+le%3A1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
usageProductIdinteger(int64)read-only

Usage product identifier

Example: 5
isdnbooleanread-only

Whether the record is ISDN

Example: true
usageRateCardIdinteger(int64)read-only

Usage rate card identifier

Example: 6
chargeGroupIdinteger(int64)read-only

Charge group identifier

Example: 155
supplierIdinteger(int64)read-only

Supplier identifier

Example: 3
supplierAccountIdinteger(int64)read-only

Supplier account identifier

Example: 1
timeBandstring(TimeBand)

Usage time band

Enum"PEAK""OFFPEAK""WEEKEND""ALL"
referenceDateSourceIdinteger(int64)read-only

Reference date source identifier

Example: 4
secondaryReferenceDateSourceIdinteger(int64)read-only

Secondary reference date source identifier

Example: 5
firstEventDatestring(date-time)read-onlyrequired

Date and time of the first event in this group

Example: "2026-07-24T14:15:22Z"
lastEventDatestring(date-time)read-onlyrequired

Date and time of the last event in this group

Example: "2026-08-24T14:15:22Z"
totalSupplierCostnumber(double)>= 0read-onlyrequired

Total supplier cost for this group

Example: 250
totalQuantityinteger(int64)>= 0read-onlyrequired

Total quantity for this group

Example: 100
totalRecordsinteger(int64)>= 1read-onlyrequired

Total number of suspense records in this group

Example: 125
]
Response
application/json
[
  {
    "usageProductId": 5,
    "isdn": true,
    "usageRateCardId": 6,
    "chargeGroupId": 155,
    "supplierId": 3,
    "supplierAccountId": 1,
    "timeBand": "PEAK",
    "referenceDateSourceId": 4,
    "secondaryReferenceDateSourceId": 5,
    "firstEventDate": "2026-07-24T14:15:22Z",
    "lastEventDate": "2026-08-24T14:15:22Z",
    "totalSupplierCost": 250,
    "totalQuantity": 100,
    "totalRecords": 125
  }
]

Retrieve a page of buy rate card suspense summary records

Request

Returns buy rate card suspense summary records. Use pagination and filters to narrow results

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 identifier

Example: customerId=0
siteIdstring(IdFilterParam)

Filter by site identifier

Example: siteId=0
usageProductIdstring(IdFilterParam)

Filter by usage product identifier

Example: usageProductId=0
productReferencestring(StringFilterParam)

Filter by product reference

Example: productReference=xyz | in:x,y | like:xyz
supplierIdstring(IdFilterParam)

Filter by supplier identifier

Example: supplierId=0
supplierAccountIdstring(IdFilterParam)

Filter by supplier account identifier

Example: supplierAccountId=0
firstEventDatestring(DateTimeFilterParam)

Filter by first event date/time

Example: firstEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
lastEventDatestring(DateTimeFilterParam)

Filter by last event date/time

Example: lastEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
totalSupplierCoststring(NumericFilterParam)

Filter by total supplier cost

Example: totalSupplierCost=1 | in:1,2 | gt:1 | lt:1 | ge:1 | le:1
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/usage-buy-rate-card-suspense-summary?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&customerId=0&siteId=0&usageProductId=0&productReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&supplierId=0&supplierAccountId=0&firstEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&lastEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&totalSupplierCost=1+%7C+in%3A1%2C2+%7C+gt%3A1+%7C+lt%3A1+%7C+ge%3A1+%7C+le%3A1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
customerIdinteger(int64)read-only

Customer identifier

Example: 2225
siteIdinteger(int64)read-only

Site identifier

Example: 2226
usageProductIdinteger(int64)read-only

Usage product identifier

Example: 5
productReferencestring[ 1 .. 100 ] charactersread-only

Product reference

Example: "VMC123456"
supplierIdinteger(int64)read-only

Supplier identifier

Example: 3
supplierAccountIdinteger(int64)read-only

Supplier account identifier

Example: 1
firstEventDatestring(date-time)read-onlyrequired

Date and time of the first event in this group

Example: "2026-07-24T14:15:22Z"
lastEventDatestring(date-time)read-onlyrequired

Date and time of the last event in this group

Example: "2026-08-24T14:15:22Z"
totalSupplierCostnumber(double)>= 0read-onlyrequired

Total supplier cost for this group

Example: 250
totalQuantityinteger(int64)>= 0read-onlyrequired

Total quantity for this group

Example: 100
totalRecordsinteger(int64)>= 1read-onlyrequired

Total number of suspense records in this group

Example: 125
]
Response
application/json
[
  {
    "customerId": 2225,
    "siteId": 2226,
    "usageProductId": 5,
    "productReference": "VMC123456",
    "supplierId": 3,
    "supplierAccountId": 1,
    "firstEventDate": "2026-07-24T14:15:22Z",
    "lastEventDate": "2026-08-24T14:15:22Z",
    "totalSupplierCost": 250,
    "totalQuantity": 100,
    "totalRecords": 125
  }
]

Retrieve a page of buy rate suspense summary records

Request

Returns buy rate suspense summary records. Use pagination and filters to narrow results

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

Filter by usage product identifier

Example: usageProductId=0
isdnstring(BooleanFilterParam)

Filter by ISDN flag

Example: isdn=true | false
usageRateCardIdstring(IdFilterParam)

Filter by usage rate card identifier

Example: usageRateCardId=0
chargeGroupIdstring(IdFilterParam)

Filter by charge group identifier

Example: chargeGroupId=0
supplierIdstring(IdFilterParam)

Filter by supplier identifier

Example: supplierId=0
supplierAccountIdstring(IdFilterParam)

Filter by supplier account identifier

Example: supplierAccountId=0
timeBandstring(StringFilterParam)

Filter by time band

Example: timeBand=xyz | in:x,y | like:xyz
referenceDateSourceIdstring(IdFilterParam)

Filter by reference date source identifier

Example: referenceDateSourceId=0
secondaryReferenceDateSourceIdstring(IdFilterParam)

Filter by secondary reference date source identifier

Example: secondaryReferenceDateSourceId=0
firstEventDatestring(DateTimeFilterParam)

Filter by first event date/time

Example: firstEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
lastEventDatestring(DateTimeFilterParam)

Filter by last event date/time

Example: lastEventDate=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
totalSupplierCoststring(NumericFilterParam)

Filter by total supplier cost

Example: totalSupplierCost=1 | in:1,2 | gt:1 | lt:1 | ge:1 | le:1
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/usage-buy-rate-suspense-summary?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&usageProductId=0&isdn=true+%2C+false&usageRateCardId=0&chargeGroupId=0&supplierId=0&supplierAccountId=0&timeBand=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&referenceDateSourceId=0&secondaryReferenceDateSourceId=0&firstEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&lastEventDate=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&totalSupplierCost=1+%7C+in%3A1%2C2+%7C+gt%3A1+%7C+lt%3A1+%7C+ge%3A1+%7C+le%3A1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
usageProductIdinteger(int64)read-only

Usage product identifier

Example: 5
isdnbooleanread-only

Whether the record is ISDN

Example: true
usageRateCardIdinteger(int64)read-only

Usage rate card identifier

Example: 6
chargeGroupIdinteger(int64)read-only

Charge group identifier

Example: 155
supplierIdinteger(int64)read-only

Supplier identifier

Example: 3
supplierAccountIdinteger(int64)read-only

Supplier account identifier

Example: 1
timeBandstring(TimeBand)

Usage time band

Enum"PEAK""OFFPEAK""WEEKEND""ALL"
referenceDateSourceIdinteger(int64)read-only

Reference date source identifier

Example: 4
secondaryReferenceDateSourceIdinteger(int64)read-only

Secondary reference date source identifier

Example: 5
firstEventDatestring(date-time)read-onlyrequired

Date and time of the first event in this group

Example: "2026-07-24T14:15:22Z"
lastEventDatestring(date-time)read-onlyrequired

Date and time of the last event in this group

Example: "2026-08-24T14:15:22Z"
totalSupplierCostnumber(double)>= 0read-onlyrequired

Total supplier cost for this group

Example: 250
totalQuantityinteger(int64)>= 0read-onlyrequired

Total quantity for this group

Example: 100
totalRecordsinteger(int64)>= 1read-onlyrequired

Total number of suspense records in this group

Example: 125
]
Response
application/json
[
  {
    "usageProductId": 5,
    "isdn": true,
    "usageRateCardId": 6,
    "chargeGroupId": 155,
    "supplierId": 3,
    "supplierAccountId": 1,
    "timeBand": "PEAK",
    "referenceDateSourceId": 4,
    "secondaryReferenceDateSourceId": 5,
    "firstEventDate": "2026-07-24T14:15:22Z",
    "lastEventDate": "2026-08-24T14:15:22Z",
    "totalSupplierCost": 250,
    "totalQuantity": 100,
    "totalRecords": 125
  }
]