Customers represent the person or company contracted to receive products or services
Elevate Customer and Sites API (1.49)
- 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
Languages
Servers
https://rest.elevatebilling.com/v1
Query
Results to return per page
Example: pageSize=100
Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
Example: sort=id,name | name:desc
Comma-delimited list of the field(s) to return if only a subset is required
Example: fields=id,name
Filter by the difference (absolute value) between the previous and the open bill run value
Example: valueDifference=xyz | in:x,y | like:xyz
Filter by the difference (as percentage) between the previous and the open bill run value
Example: percentageDifference=xyz | in:x,y | like:xyz
Filter by the difference (absolute value) between the previous and the open adhoc bill run value
Example: adhocValueDifference=xyz | in:x,y | like:xyz
Filter by the difference (as percentage) between the previous and the open adhoc bill run value
Example: adhocPercentageDifference=xyz | in:x,y | like:xyz
Filter by rating status
Example: ratingStatus=xyz | in:x,y | like:xyz
- https://rest.elevatebilling.com/v1/customer-billing-summaries
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v1/customer-billing-summaries?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&customerId=0&valueDifference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&percentageDifference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&adhocValueDifference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&adhocPercentageDifference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&ratingStatus=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&billingStatus=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'OK
Billing status of a customer
Enum"ACTIVE""FIRST_INVOICE""CEASED""RESURRECTED""NEVER_BILLED"
Rating status of customer bill runs. If INCOMPLETE, then the bill run values are subject to change based on re-rating
Enum"COMPLETE""INCOMPLETE"
Net value for this customer in the open bill run in major currency (e.g pounds/dollars/euros)
Example: 100
Net value for this customer in the previous bill run in major currency (e.g pounds/dollars/euros)
Example: 60
The difference in monetary value between the previous and the open bill run net value
Example: 40
The difference between the previous and the open bill run value as a percentage
Example: 80
Net value for this customer from all adhoc charges associated with the open bill run in major currency (e.g pounds/dollars/euros)
Example: 50
Net value for this customer from adhoc charges associated with the previous bill run in major currency (e.g pounds/dollars/euros)
Example: 45
The difference in monetary value between the previous and the open adhoc bill run net values
Example: 5
The difference between the previous and the open adhoc bill run values as a percentage
Example: 11.11
Net value of rental product inventories in the open bill run, in major currency (e.g pounds/dollars/euros)
Example: 75
Number of distinct rental product inventories included in the openBillRunRentalValue
Example: 3
Net value of rental product inventories started during the open bill run period, in major currency (e.g pounds/dollars/euros)
Example: 25
Number of distinct rental product inventories included in the newRentalValue
Example: 1
Net value of rental product inventories during the open bill run period end date, in major currency (e.g pounds/dollars/euros)
Example: 10
Number of distinct rental product inventories included in the ceasedRentalValue
Example: 1
Response
application/json
[ { "customerId": 1, "billingStatus": "ACTIVE", "ratingStatus": "COMPLETE", "openBillRunValue": 100, "previousBillRunValue": 60, "valueDifference": 40, "percentageDifference": 80, "openAdhocValue": 50, "previousAdhocValue": 45, "adhocValueDifference": 5, "adhocPercentageDifference": 11.11, "openBillRunRentalValue": 75, "openBillRunRentalCount": 3, "newRentalValue": 25, "newRentalCount": 1, "ceasedRentalValue": 10, "ceasedRentalCount": 1 } ]