Skip to content
/
Get a specific admin cont...

Elevate Admin API (1.44)

Admin Level Management

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.

Definitions

  • 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.

Download OpenAPI description
billing-rest-admin.json
billing-rest-admin.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

contract-owners

Contract owners segregate Customers for reporting and/or branding purposes

Operations

billing-cycles

Billing cycles segregate a Contract Owner's Customer base into separate billing processes

Operations

suppliers

The third party supplier of a product or service available to be billed via Elevate

Operations

invoice-document-profiles

Invoice Document Profiles determine the invoice and summary layouts for billing

Operations

invoice-templates

Document templates used to define the invoice structure and look and feel

Operations

invoice-summary-templates

Document templates used to define the invoice summary structure and look and feel

Operations

invoice-summary-template-components

Document summary template components used to define the invoice summary structure and look and feel

Operations

electronic-summary-templates

Document templates used to define the electronic summary structure and look and feel

Operations

invoice-marketing-info

Marketing information used to define the contents of the invoice template slots for a sub-brand

Operations

invoice-marketing-info-preview

Generate a preview with fake data and the invoice marketing information

Operations

admin-contacts

Administration contacts used to receive tripwire, usage cap, and auto-close notifications

Operations

Get a list of available admin contacts

Request

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

Filter by name

Example: name=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/admin-contacts?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Admin contact identifier

Example: 1
namestring[ 1 .. 100 ] characters^[\w\p{L}\s%£@&#=':;`’,|!_—–()\\\/\-+.?*$\[\]...required

Admin contact name

rolestring(AdminContactRole)required

Admin contact roles

Enum"GENERAL""ACCOUNTS""TECHNICAL""SALES"
telephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

alternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}
emailstring[ 1 .. 255 ] characters^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\...

Contact email address

receiveSmsFraudAlertboolean

is the admin contact set to receive fraud alerts via SMS

Default false
receiveEmailFraudAlertboolean

is the admin contact set to receive fraud alerts via email

Default false
receiveEmailUsageCapAlertboolean

is the admin contact set to receive usage cap alerts via email

Default false
receiveEmailBillRunClosureAlertboolean

is the admin contact set to receive bill run auto-closure alerts via email

Default false
receiveEmailDuplicateCallsSummaryAlertboolean

is the admin contact set to receive duplicate calls summary alerts via email

Default false
receiveEmailDuplicateCallsReminderAlertboolean

is the admin contact set to receive duplicate calls reminder alerts via email

Default false
receiveEmailContractRenewalAlertboolean

is the admin contact set to receive contracts renewal reminder alerts via email

Default false
]
Response
application/json
[
  {
    "id": 1,
    "name": "string",
    "role": "GENERAL",
    "telephoneNumber": "string",
    "alternativeTelephoneNumber": "string",
    "email": "string",
    "receiveSmsFraudAlert": false,
    "receiveEmailFraudAlert": false,
    "receiveEmailUsageCapAlert": false,
    "receiveEmailBillRunClosureAlert": false,
    "receiveEmailDuplicateCallsSummaryAlert": false,
    "receiveEmailDuplicateCallsReminderAlert": false,
    "receiveEmailContractRenewalAlert": false
  }
]

Create a new admin contact

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New admin contact

namestring[ 1 .. 100 ] characters^[\w\p{L}\s%£@&#=':;`’,|!_—–()\\\/\-+.?*$\[\]...required

Admin contact name

rolestring(AdminContactRole)required

Admin contact roles

Enum"GENERAL""ACCOUNTS""TECHNICAL""SALES"
telephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

alternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}
emailstring[ 1 .. 255 ] characters^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\...

Contact email address

receiveSmsFraudAlertboolean

is the admin contact set to receive fraud alerts via SMS

Default false
receiveEmailFraudAlertboolean

is the admin contact set to receive fraud alerts via email

Default false
receiveEmailUsageCapAlertboolean

is the admin contact set to receive usage cap alerts via email

Default false
receiveEmailBillRunClosureAlertboolean

is the admin contact set to receive bill run auto-closure alerts via email

Default false
receiveEmailDuplicateCallsSummaryAlertboolean

is the admin contact set to receive duplicate calls summary alerts via email

Default false
receiveEmailDuplicateCallsReminderAlertboolean

is the admin contact set to receive duplicate calls reminder alerts via email

Default false
receiveEmailContractRenewalAlertboolean

is the admin contact set to receive contracts renewal reminder alerts via email

Default false
curl -i -X POST \
  https://rest.elevatebilling.com/v1/admin-contacts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "role": "GENERAL",
    "telephoneNumber": "string",
    "alternativeTelephoneNumber": "string",
    "email": "string",
    "receiveSmsFraudAlert": false,
    "receiveEmailFraudAlert": false,
    "receiveEmailUsageCapAlert": false,
    "receiveEmailBillRunClosureAlert": false,
    "receiveEmailDuplicateCallsSummaryAlert": false,
    "receiveEmailDuplicateCallsReminderAlert": false,
    "receiveEmailContractRenewalAlert": false
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Admin contact identifier

Example: 1
namestring[ 1 .. 100 ] characters^[\w\p{L}\s%£@&#=':;`’,|!_—–()\\\/\-+.?*$\[\]...required

Admin contact name

rolestring(AdminContactRole)required

Admin contact roles

Enum"GENERAL""ACCOUNTS""TECHNICAL""SALES"
telephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

alternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}
emailstring[ 1 .. 255 ] characters^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\...

Contact email address

receiveSmsFraudAlertboolean

is the admin contact set to receive fraud alerts via SMS

Default false
receiveEmailFraudAlertboolean

is the admin contact set to receive fraud alerts via email

Default false
receiveEmailUsageCapAlertboolean

is the admin contact set to receive usage cap alerts via email

Default false
receiveEmailBillRunClosureAlertboolean

is the admin contact set to receive bill run auto-closure alerts via email

Default false
receiveEmailDuplicateCallsSummaryAlertboolean

is the admin contact set to receive duplicate calls summary alerts via email

Default false
receiveEmailDuplicateCallsReminderAlertboolean

is the admin contact set to receive duplicate calls reminder alerts via email

Default false
receiveEmailContractRenewalAlertboolean

is the admin contact set to receive contracts renewal reminder alerts via email

Default false
Response
application/json
{
  "id": 1,
  "name": "string",
  "role": "GENERAL",
  "telephoneNumber": "string",
  "alternativeTelephoneNumber": "string",
  "email": "string",
  "receiveSmsFraudAlert": false,
  "receiveEmailFraudAlert": false,
  "receiveEmailUsageCapAlert": false,
  "receiveEmailBillRunClosureAlert": false,
  "receiveEmailDuplicateCallsSummaryAlert": false,
  "receiveEmailDuplicateCallsReminderAlert": false,
  "receiveEmailContractRenewalAlert": false
}

Get a specific admin contact

Request

Security
bearerAuth
Path
adminContactIdinteger(int64)(IdParam)>= 1required

Admin contact identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v1/admin-contacts/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Admin contact found

Bodyapplication/json
idinteger(int64)read-only

Admin contact identifier

Example: 1
namestring[ 1 .. 100 ] characters^[\w\p{L}\s%£@&#=':;`’,|!_—–()\\\/\-+.?*$\[\]...required

Admin contact name

rolestring(AdminContactRole)required

Admin contact roles

Enum"GENERAL""ACCOUNTS""TECHNICAL""SALES"
telephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

alternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}
emailstring[ 1 .. 255 ] characters^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\...

Contact email address

receiveSmsFraudAlertboolean

is the admin contact set to receive fraud alerts via SMS

Default false
receiveEmailFraudAlertboolean

is the admin contact set to receive fraud alerts via email

Default false
receiveEmailUsageCapAlertboolean

is the admin contact set to receive usage cap alerts via email

Default false
receiveEmailBillRunClosureAlertboolean

is the admin contact set to receive bill run auto-closure alerts via email

Default false
receiveEmailDuplicateCallsSummaryAlertboolean

is the admin contact set to receive duplicate calls summary alerts via email

Default false
receiveEmailDuplicateCallsReminderAlertboolean

is the admin contact set to receive duplicate calls reminder alerts via email

Default false
receiveEmailContractRenewalAlertboolean

is the admin contact set to receive contracts renewal reminder alerts via email

Default false
Response
application/json
{
  "id": 1,
  "name": "string",
  "role": "GENERAL",
  "telephoneNumber": "string",
  "alternativeTelephoneNumber": "string",
  "email": "string",
  "receiveSmsFraudAlert": false,
  "receiveEmailFraudAlert": false,
  "receiveEmailUsageCapAlert": false,
  "receiveEmailBillRunClosureAlert": false,
  "receiveEmailDuplicateCallsSummaryAlert": false,
  "receiveEmailDuplicateCallsReminderAlert": false,
  "receiveEmailContractRenewalAlert": false
}

Update an admin contact

Request

Security
bearerAuth
Path
adminContactIdinteger(int64)(IdParam)>= 1required

Admin contact identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed

Array [
opstringrequired

The JSON Patch operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations

fromstring

A string containing a JSON Pointer value

]
curl -i -X PATCH \
  https://rest.elevatebilling.com/v1/admin-contacts/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/name",
      "value": "Tommy Tynan"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Admin contact identifier

Example: 1
namestring[ 1 .. 100 ] characters^[\w\p{L}\s%£@&#=':;`’,|!_—–()\\\/\-+.?*$\[\]...required

Admin contact name

rolestring(AdminContactRole)required

Admin contact roles

Enum"GENERAL""ACCOUNTS""TECHNICAL""SALES"
telephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Contact telephone number

alternativeTelephoneNumberstring[ 4 .. 100 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}
emailstring[ 1 .. 255 ] characters^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\...

Contact email address

receiveSmsFraudAlertboolean

is the admin contact set to receive fraud alerts via SMS

Default false
receiveEmailFraudAlertboolean

is the admin contact set to receive fraud alerts via email

Default false
receiveEmailUsageCapAlertboolean

is the admin contact set to receive usage cap alerts via email

Default false
receiveEmailBillRunClosureAlertboolean

is the admin contact set to receive bill run auto-closure alerts via email

Default false
receiveEmailDuplicateCallsSummaryAlertboolean

is the admin contact set to receive duplicate calls summary alerts via email

Default false
receiveEmailDuplicateCallsReminderAlertboolean

is the admin contact set to receive duplicate calls reminder alerts via email

Default false
receiveEmailContractRenewalAlertboolean

is the admin contact set to receive contracts renewal reminder alerts via email

Default false
Response
application/json
{
  "id": 1,
  "name": "string",
  "role": "GENERAL",
  "telephoneNumber": "string",
  "alternativeTelephoneNumber": "string",
  "email": "string",
  "receiveSmsFraudAlert": false,
  "receiveEmailFraudAlert": false,
  "receiveEmailUsageCapAlert": false,
  "receiveEmailBillRunClosureAlert": false,
  "receiveEmailDuplicateCallsSummaryAlert": false,
  "receiveEmailDuplicateCallsReminderAlert": false,
  "receiveEmailContractRenewalAlert": false
}

Delete an admin contact

Request

Security
bearerAuth
Path
adminContactIdinteger(int64)(IdParam)>= 1required

Admin contact identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v1/admin-contacts/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body

commission-agents

Commission agents can be set against customers to manage commission

Operations

email-templates

Email templates used to communicate via email

Operations

custom-field-definitions

Custom field definition are used to store additional information about entities in Elevate

Operations

contract-owner-sub-brands

Operations

invoice-marketing-info-trial-preview

Operations