Skip to content
commission-agents/
Get a list of available c...

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

commission-agents

Commission agents can be set against customers to manage commission

Operations

Get a list of available commission agents

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

Filter by type

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

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Internal identifier of commission agent

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

Name of the commission agent

contractOwnerIdinteger

Contract Owner identifier

Example: 1
accountNumberstring[ 1 .. 255 ] charactersread-only

Account number of the commission agent

accountsReferencestring[ 1 .. 255 ] charactersread-only

Accounts reference of the commission agent

vatRegNumberstring[ 1 .. 255 ] charactersread-only

Vat registration number of the commission agent

addressobject(Address)required
address.​idinteger(int64)read-only

Internal identifier for address entry

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

Business name

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

Address line 1

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

Address line 2

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

Address line 3

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

Town

address.​countystring[ 0 .. 30 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

County

address.​postcodestring[ 0 .. 20 ] characters[a-zA-Z0-9\p{L}@.\-\+_\s]+required

Postcode

address.​countrystring(CountryCode)= 2 characters[A-Z]{2}required

ISO 3166 alpha-2 code representing country

Example: "GB"
companyNumberstring[ 1 .. 255 ] charactersread-onlyrequired

Company number of the commission agent

typestring(CommissionAgentType)required

Commission Agent Type

Enum"INTERNAL""EXTERNAL"
parentAgentCommissionIdinteger(int64)read-only

Internal identifier of the parent commission agent

Example: 1
availableFromDatestring(date)required

Commission agent start date

availableToDatestring(date)

Commission agent end date

usageCommissionPaidOnstring(CommissionPaidOn)

Commission to be paid on

Enum"PROFIT""TURNOVER"
usageCommissionPercentagenumber(decimal)

Usage commission percentage

rentalCommissionPaidOnstring(CommissionPaidOn)

Commission to be paid on

Enum"PROFIT""TURNOVER"
rentalCommissionPercentagenumber(decimal)

Rental commission percentage

adhocCommissionPaidOnstring(CommissionPaidOn)

Commission to be paid on

Enum"PROFIT""TURNOVER"
adhocCommissionPercentagenumber(decimal)

Adhoc commission percentage

paymentTermsInDaysinteger(int32)[ 0 .. 400 ]

Payment terms in days

paymentMethodstring(PaymentMethod)

Payment method

Enum"CHEQUE""DIRECT_DEBIT""CANCELLED_DD""CANCELLED_CARD""CREDIT_CARD""PAYPAL""BACS""POST_OFFICE_PAYMENT_CARD""EZYPAY""GO_CARDLESS"
]
Response
application/json
[
  {
    "id": 1,
    "name": "string",
    "contractOwnerId": 1,
    "accountNumber": "string",
    "accountsReference": "string",
    "vatRegNumber": "string",
    "address": { … },
    "companyNumber": "string",
    "type": "INTERNAL",
    "parentAgentCommissionId": 1,
    "availableFromDate": "2019-08-24",
    "availableToDate": "2019-08-24",
    "usageCommissionPaidOn": "PROFIT",
    "usageCommissionPercentage": 0,
    "rentalCommissionPaidOn": "PROFIT",
    "rentalCommissionPercentage": 0,
    "adhocCommissionPaidOn": "PROFIT",
    "adhocCommissionPercentage": 0,
    "paymentTermsInDays": 400,
    "paymentMethod": "CHEQUE"
  }
]

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