Skip to content

Elevate Admin API (1.46)

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

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

invoice-group-tag-labels

An optional grouping identifier for mid-month charges (such as bill-immediately ad-hoc product inventories and bill-immediately charges). Charges with the same invoice group tag will be invoiced together, generating one invoice per unique tag

Operations

Get invoice group tag labels for a contract owner sub-brand

Request

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

Contract owner sub-brand identifier

Example: 1
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
labelstring(StringFilterParam)

Filter by label name

Example: label=xyz | in:x,y | like:xyz
showOnInvoiceboolean

Filter by showOnInvoice flag

curl -i -X GET \
  'https://rest.elevatebilling.com/v1/contract-owner-sub-brands/1/invoice-group-tag-labels?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&label=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&showOnInvoice=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Headers
X-Total-Countinteger

Total number of invoice group tag labels

Bodyapplication/jsonArray [
idinteger(int64)read-only

Invoice group tag label identifier

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

Label name used to categorise invoice charges (e.g., 'Cost Centre', 'PO Number', 'Department')

Example: "Cost Centre"
contractOwnerSubBrandIdinteger(int64)required

Contract owner sub-brand identifier

Example: 1
showOnInvoiceboolean

Display this label and its value on customer invoices

Default true
Example: true
]
Response
application/json
[
  {
    "id": 1,
    "label": "Cost Centre",
    "contractOwnerSubBrandId": 1,
    "showOnInvoice": true
  }
]

Create a new invoice group tag label

Request

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

Contract owner sub-brand identifier

Example: 1
Bodyapplication/jsonrequired

New invoice group tag label

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

Label name used to categorise invoice charges (e.g., 'Cost Centre', 'PO Number', 'Department')

Example: "Cost Centre"
contractOwnerSubBrandIdinteger(int64)required

Contract owner sub-brand identifier

Example: 1
showOnInvoiceboolean

Display this label and its value on customer invoices

Default true
Example: true
curl -i -X POST \
  https://rest.elevatebilling.com/v1/contract-owner-sub-brands/1/invoice-group-tag-labels \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "label": "Cost Centre",
    "contractOwnerSubBrandId": 1,
    "showOnInvoice": true
  }'

Responses

Created

Bodyapplication/json
idinteger(int64)read-only

Invoice group tag label identifier

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

Label name used to categorise invoice charges (e.g., 'Cost Centre', 'PO Number', 'Department')

Example: "Cost Centre"
contractOwnerSubBrandIdinteger(int64)required

Contract owner sub-brand identifier

Example: 1
showOnInvoiceboolean

Display this label and its value on customer invoices

Default true
Example: true
Response
application/json
{
  "id": 1,
  "label": "Cost Centre",
  "contractOwnerSubBrandId": 1,
  "showOnInvoice": true
}

Get a specific invoice group tag label

Request

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

Invoice group tag label identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v1/invoice-group-tag-labels/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Invoice group tag label identifier

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

Label name used to categorise invoice charges (e.g., 'Cost Centre', 'PO Number', 'Department')

Example: "Cost Centre"
contractOwnerSubBrandIdinteger(int64)required

Contract owner sub-brand identifier

Example: 1
showOnInvoiceboolean

Display this label and its value on customer invoices

Default true
Example: true
Response
application/json
{
  "id": 1,
  "label": "Cost Centre",
  "contractOwnerSubBrandId": 1,
  "showOnInvoice": true
}

Update an invoice group tag label

Request

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

Invoice group tag label identifier

Example: 1
Bodyapplication/json-patch+json

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/invoice-group-tag-labels/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/label",
      "value": "Cost Center"
    }
  ]'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Invoice group tag label identifier

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

Label name used to categorise invoice charges (e.g., 'Cost Centre', 'PO Number', 'Department')

Example: "Cost Centre"
contractOwnerSubBrandIdinteger(int64)required

Contract owner sub-brand identifier

Example: 1
showOnInvoiceboolean

Display this label and its value on customer invoices

Default true
Example: true
Response
application/json
{
  "id": 1,
  "label": "Cost Centre",
  "contractOwnerSubBrandId": 1,
  "showOnInvoice": true
}

Delete an invoice group tag label

Request

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

Invoice group tag label identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v1/invoice-group-tag-labels/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

contract-owner-sub-brands

Operations

invoice-marketing-info-trial-preview

Operations