Skip to content

API Reference

Elevate IQ APIs are developed to the OpenAPI 3 standards.

These are the APIs available on Elevate IQ. You can click on each API or use the drop-down in the navigation bar for details of the endpoints available.

Admin API

Administrative operations for system configuration

  • /commission-agents - Manage commission agents
  • /contract-owners - Manage contract owners
  • /admin-contacts - Manage admin-level contacts

Assignment API

Rate card and contract assignments

  • /usage-rate-card-assignments - Assign usage rate cards
  • /rental-rate-card-assignments - Assign rental rate cards

Authentication API

User authentication and token management

  • /users - Create, get, and edit Elevate users
  • /user-roles - Read-only endpoint for user roles

Bill Run API

Manage billing cycles and ad-hoc billing

  • /bill-runs - Manage standard bill runs
  • /adhoc-bill-runs - Manage ad-hoc bill runs

Contract API

Customer contracts and profiles

  • /customer-contracts - Manage customer contracts
  • /contract-profiles - Manage contract profiles

Customer API

Customer, site, and customer-related data

  • /customers - Create, retrieve, update, and delete customers
  • /sites - Manage customer sites
  • /customer-usage-data - Get usage records (rated CDRs)
  • /customer-billing-summaries - Retrieve bill values and rating status

Document API

Document and file management

  • Document retrieval and management endpoints

Events API

Time-based events recorded within Elevate

  • Event tracking and monitoring endpoints

Inventory API

Usage (UPI), rental (RPI) and adhoc inventory

  • /usage-product-inventories - Manage usage product inventories
  • /rental-product-inventories - Manage rental product inventories
  • /usage-product-references - Manage product references
  • /provisioning-details - Get provisioning details for RPIs

Invoice API

Customer invoices and invoice payment events

  • /invoices - Retrieve invoice details
  • /invoice-summaries - Get invoice summary PDFs
  • /resend-invoice - Resend invoice emails
  • /invoice-payment-events - Record payment events (including undoing payments)

Mediation API

CDR mediation and usage data processing

  • Mediation processing endpoints

Notifications API

Email and notification management

  • /email-status - Check status of email notifications

Payment API

Payment and refund management

  • /invoice-payments - Manage invoice payments
  • /adhoc-invoice-payments - Manage ad-hoc invoice payments
  • /customer-payments - Manage customer payments
  • /customer-balances - Check customer balances
  • /invoice-payment-reprocess - Reprocess failed/skipped payments

Pricing API

Usage/rental rate cards and pricing

  • /usage-rate-cards - Manage usage rate cards
  • /rental-rate-cards - Manage rental rate cards
  • /usage-rates - Manage rates within usage rate cards
  • /rental-rates - Manage rates within rental rate cards

Product API

Usage and rental product management

  • /usage-products - Manage usage products
  • /rental-products - Manage rental products

Provisioning API

Activate, suspend and manage mobile SIMs

  • /sim-activation-request - Activate SIM products
  • /sim-suspension-request - Suspend SIM products
  • /sim-modification-request - Modify SIM settings (barring, etc.)
  • /sim-subscription-request - Manage data bundle subscriptions

Reference Data API

System reference data and lookups

  • Dial-strings, call-class, charge groups

Rental Rating API

Early termination charges (ETC) and rental rating

  • /rental-etcs - Calculate early termination charges
  • Retrieval of rental rated sell, buy, and suspense records

Tripwire API

Monitor usage and detect unusual behaviour

  • Tripwire monitoring and alert endpoints