Returns billing summary information

get/customer-billing-summaries

Returns billing summary information for customers including open vs previous bill run values

SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

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

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

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

Example: fields=id,name
customerId
string (IdFilterParam)

Filter by customer

Example: customerId=0
valueDifference
string (StringFilterParam)

Filter by the difference (absolute value) between the previous and the open bill run value

Example: valueDifference=xyz | in:x,y | like:xyz
percentageDifference
string (StringFilterParam)

Filter by the difference (as percentage) between the previous and the open bill run value

Example: percentageDifference=xyz | in:x,y | like:xyz
ratingStatus
string (StringFilterParam)

Filter by rating status

Example: ratingStatus=xyz | in:x,y | like:xyz
billingStatus
string (StringFilterParam)

Filter by customer billing status

Example: billingStatus=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "customerId": 1,
    • "billingStatus": "ACTIVE",
    • "ratingStatus": "COMPLETE",
    • "openBillRunValue": 100,
    • "previousBillRunValue": 60,
    • "valueDifference": 40,
    • "percentageDifference": 80
    }
]