Skip to content
invoice-marketing-info-tr...
/
Generate a preview invoic...

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

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

Generate a preview invoice PDF for passed in invoice marketing info

Request

Security
bearerAuth
Bodymultipart/form-datarequired

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-trial-preview \
  -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

A PDF file

Bodyapplication/pdf
string(binary)