the top-level organisation that uses Elevate to bill its own customers. A Billing Client is the outermost data-isolation boundary in the API. Every other resource (contract owner, site, customer, product, price, invoice, CDR) belongs to exactly one Billing Client, and no request can return data from more than one
Elevate Admin API (1.50)
Currently provides read-only access to list admin entities required by other endpoints. Maintenance of these entities is available via the Elevate frontend or by contacting the Elevate support team.
Billing Client - the top-level organisation that uses Elevate to bill its own customers. A Billing Client is the outermost data-isolation boundary in the API. Every other resource (contract owner, site, customer, product, price, invoice, CDR) belongs to exactly one Billing Client, and no request can return data from more than one.
Contract Owner - the party with which a Customer is contracted to purchase products and services - segregates Customers for reporting and/or branding purposes.
Billing Cycle - means of segregating a Contract Owner's Customer base into separate billing processes which have different start days.
Supplier - the third party supplier of the product or service - allows for a number of different accounts with each supplier.
Invoice Document Profile - defines the configuration used to generate invoices for Customers. This is used on creation of Sites only.
Admin Contact - a configurable contact usable across the entire platform that can receive tripwire, usage cap, and auto-close notifications.
Email Template - a named template of text and substituted values that is used to send emails from the system.
Invoice Marketing Information - for a given sub-brand and invoice template, the marketing information used to populate the invoice template slots. This might be blank, text, images or rich text.
Results to return per page
Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
Comma-delimited list of the field(s) to return if only a subset is required
Filter by supplier account number
Filter by supplier account identifier
Filter by whether the supplier has an FTP host set
- https://rest.elevatebilling.com/v1/suppliers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v1/suppliers?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&accountNumber=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&supplierAccountId=0&ftpConfigured=true+%2C+false&ftpEnabled=true+%2C+false' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'OK
Supplier name
is an FTP host set for the supplier, whether or not ftp downloads are enabled
is an FTP host set for the supplier and the supplier enabled for ftp downloads
Directories on the remote server that files are listed from. These are the FTP paths stored for the supplier, in the order they were stored and without duplicates; empty if none are stored.
The SDR filename masks stored for the supplier (supplier process type SDR_VIA_FILE_TRANSFER), one per stored record. A file is picked up if its whole name matches any of them.
The CDR filename masks stored for the supplier (supplier process type CDR_VIA_FILE_TRANSFER or CDR_VIA_ROBOT), one per stored record. A file is picked up if its whole name matches any of them.
[ { "id": 1, "name": "string", "ftpDownloadEnabled": false, "ftpConfigured": false, "ftpEnabled": false, "startPaths": [ … ], "sdrFilenameMasks": [ … ], "cdrFilenameMasks": [ … ], "supplierAccounts": [ … ] } ]
- https://rest.elevatebilling.com/v1/suppliers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X HEAD \
'https://rest.elevatebilling.com/v1/suppliers?name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&accountNumber=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&supplierAccountId=0&ftpConfigured=true+%2C+false&ftpEnabled=true+%2C+false' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'