Skip to content

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

Get a list of invoice marketing information for sub-brand and invoice template

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
contractOwnerSubBrandIdstring(IdFilterParam)

Filter by contract owner sub-brand id

Example: contractOwnerSubBrandId=0
invoiceTemplateIdstring(IdFilterParam)

Filter by invoice template id

Example: invoiceTemplateId=0
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/invoice-marketing-info?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&contractOwnerSubBrandId=0&invoiceTemplateId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Invoice Marketing Info record identifier

Example: 1
contractOwnerSubBrandIdinteger(int32)required

Contract Owner Sub-Brand Identifier

invoiceTemplateIdinteger(int32)required

Invoice Template Identifier

createdDatestring(date-time)read-only

Date when this record was created

updatedDatestring(date-time)read-only

Date when this record was last updated

slot1object(InvoiceMarketingInfoSlot)
slot2object(InvoiceMarketingInfoSlot)
slot3object(InvoiceMarketingInfoSlot)
slot4object(InvoiceMarketingInfoSlot)
]
Response
application/json
[
  {
    "id": 1,
    "contractOwnerSubBrandId": 0,
    "invoiceTemplateId": 0,
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "slot1": { … },
    "slot2": { … },
    "slot3": { … },
    "slot4": { … }
  }
]

Check if invoice marketing info record exist

Request

Security
bearerAuth
Query
contractOwnerSubBrandIdstring(IdFilterParam)

Filter by contract owner sub-brand id

Example: contractOwnerSubBrandId=0
invoiceTemplateIdstring(IdFilterParam)

Filter by invoice template id

Example: invoiceTemplateId=0
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v1/invoice-marketing-info?contractOwnerSubBrandId=0&invoiceTemplateId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exists

Headers
X-Total-Countinteger

Total number of invoice marketing info records

Create new invoice marketing info details for a sub-brand and invoice template

Request

Security
bearerAuth
Bodymultipart/form-datarequired

New invoice marketing info details

invoiceMarketingInfoobject(InvoiceMarketingInfo)required
invoiceMarketingInfo.​contractOwnerSubBrandIdinteger(int32)required

Contract Owner Sub-Brand Identifier

invoiceMarketingInfo.​invoiceTemplateIdinteger(int32)required

Invoice Template Identifier

invoiceMarketingInfo.​slot1object(InvoiceMarketingInfoSlot)
invoiceMarketingInfo.​slot2object(InvoiceMarketingInfoSlot)
invoiceMarketingInfo.​slot3object(InvoiceMarketingInfoSlot)
invoiceMarketingInfo.​slot4object(InvoiceMarketingInfoSlot)
file1multipartFile(binary)

File content (jpeg,png,gif,bmp,tiff,rtf)

file2multipartFile(binary)

File content (jpeg,png,gif,bmp,tiff,rtf)

file3multipartFile(binary)

File content (jpeg,png,gif,bmp,tiff,rtf)

file4multipartFile(binary)

File content (jpeg,png,gif,bmp,tiff,rtf)

curl -i -X POST \
  https://rest.elevatebilling.com/v1/invoice-marketing-info \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'invoiceMarketingInfo[contractOwnerSubBrandId]=0' \
  -F 'invoiceMarketingInfo[invoiceTemplateId]=0' \
  -F 'invoiceMarketingInfo[slot1][type]=TEXT' \
  -F 'invoiceMarketingInfo[slot1][textContent]=string' \
  -F 'invoiceMarketingInfo[slot2][type]=TEXT' \
  -F 'invoiceMarketingInfo[slot2][textContent]=string' \
  -F 'invoiceMarketingInfo[slot3][type]=TEXT' \
  -F 'invoiceMarketingInfo[slot3][textContent]=string' \
  -F 'invoiceMarketingInfo[slot4][type]=TEXT' \
  -F 'invoiceMarketingInfo[slot4][textContent]=string' \
  -F file1=null \
  -F file2=null \
  -F file3=null \
  -F file4=null

Responses

Created

Bodyapplication/json
idinteger(int64)read-only

Invoice Marketing Info record identifier

Example: 1
contractOwnerSubBrandIdinteger(int32)required

Contract Owner Sub-Brand Identifier

invoiceTemplateIdinteger(int32)required

Invoice Template Identifier

createdDatestring(date-time)read-only

Date when this record was created

updatedDatestring(date-time)read-only

Date when this record was last updated

slot1object(InvoiceMarketingInfoSlot)
slot2object(InvoiceMarketingInfoSlot)
slot3object(InvoiceMarketingInfoSlot)
slot4object(InvoiceMarketingInfoSlot)
Response
application/json
{
  "id": 1,
  "contractOwnerSubBrandId": 0,
  "invoiceTemplateId": 0,
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "slot1": {
    "type": "TEXT",
    "textContent": "string"
  },
  "slot2": {
    "type": "TEXT",
    "textContent": "string"
  },
  "slot3": {
    "type": "TEXT",
    "textContent": "string"
  },
  "slot4": {
    "type": "TEXT",
    "textContent": "string"
  }
}

Update a invoice marketing info record

Request

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

Invoice marketing info record identifier

Example: 1
Body
required

A set of JSONPatch operations to be performed

file1multipartFile(binary)

Slot 1 file content (jpeg,png,gif,bmp,tiff,rtf)

file2multipartFile(binary)

Slot 2 file content (jpeg,png,gif,bmp,tiff,rtf)

file3multipartFile(binary)

Slot 3 file content (jpeg,png,gif,bmp,tiff,rtf)

file4multipartFile(binary)

Slot 4 file content (jpeg,png,gif,bmp,tiff,rtf)

patchArray of objects(PatchRequest)

JSON Patch is a format for describing changes to a JSON document as specified in RFC 6902. Refer to jsonpatch.com for more information

curl -i -X PATCH \
  https://rest.elevatebilling.com/v1/invoice-marketing-info/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file1=null \
  -F file2=null \
  -F file3=null \
  -F file4=null \
  -F 'patch[0][op]=add' \
  -F 'patch[0][path]=string' \
  -F 'patch[0][from]=string'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Invoice Marketing Info record identifier

Example: 1
contractOwnerSubBrandIdinteger(int32)required

Contract Owner Sub-Brand Identifier

invoiceTemplateIdinteger(int32)required

Invoice Template Identifier

createdDatestring(date-time)read-only

Date when this record was created

updatedDatestring(date-time)read-only

Date when this record was last updated

slot1object(InvoiceMarketingInfoSlot)
slot2object(InvoiceMarketingInfoSlot)
slot3object(InvoiceMarketingInfoSlot)
slot4object(InvoiceMarketingInfoSlot)
Response
application/json
{
  "id": 1,
  "contractOwnerSubBrandId": 0,
  "invoiceTemplateId": 0,
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "slot1": {
    "type": "TEXT",
    "textContent": "string"
  },
  "slot2": {
    "type": "TEXT",
    "textContent": "string"
  },
  "slot3": {
    "type": "TEXT",
    "textContent": "string"
  },
  "slot4": {
    "type": "TEXT",
    "textContent": "string"
  }
}

Get a specific invoice marketing info record

Request

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

Invoice marketing info record identifier

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

Responses

Invoice marketing info found

Bodymultipart/form-data
invoiceMarketingInfoobject(InvoiceMarketingInfo)required
invoiceMarketingInfo.​idinteger(int64)read-only

Invoice Marketing Info record identifier

Example: 1
invoiceMarketingInfo.​contractOwnerSubBrandIdinteger(int32)required

Contract Owner Sub-Brand Identifier

invoiceMarketingInfo.​invoiceTemplateIdinteger(int32)required

Invoice Template Identifier

invoiceMarketingInfo.​createdDatestring(date-time)read-only

Date when this record was created

invoiceMarketingInfo.​updatedDatestring(date-time)read-only

Date when this record was last updated

invoiceMarketingInfo.​slot1object(InvoiceMarketingInfoSlot)
invoiceMarketingInfo.​slot2object(InvoiceMarketingInfoSlot)
invoiceMarketingInfo.​slot3object(InvoiceMarketingInfoSlot)
invoiceMarketingInfo.​slot4object(InvoiceMarketingInfoSlot)
file1multipartFile(binary)

File content (jpeg,png,gif,bmp,tiff,rtf)

file2multipartFile(binary)

File content (jpeg,png,gif,bmp,tiff,rtf)

file3multipartFile(binary)

File content (jpeg,png,gif,bmp,tiff,rtf)

file4multipartFile(binary)

File content (jpeg,png,gif,bmp,tiff,rtf)

Response
multipart/form-data
{
  "invoiceMarketingInfo": {
    "id": 1,
    "contractOwnerSubBrandId": 0,
    "invoiceTemplateId": 0,
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "slot1": {
      "type": "TEXT",
      "textContent": "string"
    },
    "slot2": {
      "type": "TEXT",
      "textContent": "string"
    },
    "slot3": {
      "type": "TEXT",
      "textContent": "string"
    },
    "slot4": {
      "type": "TEXT",
      "textContent": "string"
    }
  },
  "file1": null,
  "file2": null,
  "file3": null,
  "file4": null
}

Delete an invoice marketing info record

Request

Delete an invoice marketing info record

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

Invoice marketing info record identifier

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

Responses

No Content

Body

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

contract-owner-sub-brands

Operations

invoice-marketing-info-trial-preview

Operations