# Elevate Admin API ### 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. Version: 1.44 ## Servers ``` https://rest.elevatebilling.com/v1 ``` ## Security ### bearerAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Elevate Admin API](https://docs.elevatebilling.com/_bundle/openapi/prod/gen/billing-rest-admin.yaml) ## contract-owners Contract owners segregate Customers for reporting and/or branding purposes ### Get a list of available contract owners - [GET /contract-owners](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owners/getcontractowners.md) ### Create a new contract owner - [POST /contract-owners](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owners/createcontractowner.md) ### Get a specific contract owner - [GET /contract-owners/{contract_owner_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owners/getcontractowner.md) ### Update a contract_owner - [PATCH /contract-owners/{contract_owner_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owners/updatecontractowner.md) ## billing-cycles Billing cycles segregate a Contract Owner's Customer base into separate billing processes ### Get a list of available billing cycles - [GET /billing-cycles](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/billing-cycles/getbillingcycles.md) ### Create a new billing cycle - [POST /billing-cycles](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/billing-cycles/createbillingcycle.md) ### Get a specific billing cycle - [GET /billing-cycles/{billing_cycle_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/billing-cycles/getbillingcycle.md) ### Update a billing cycle - [PATCH /billing-cycles/{billing_cycle_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/billing-cycles/updatebillingcycle.md) ### Delete a billing cycle - [DELETE /billing-cycles/{billing_cycle_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/billing-cycles/deletebillingcycle.md) ## suppliers The third party supplier of a product or service available to be billed via Elevate ### Get a list of available suppliers - [GET /suppliers](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/suppliers/getsuppliers.md) ## invoice-document-profiles Invoice Document Profiles determine the invoice and summary layouts for billing ### Get a list of available invoice document profiles - [GET /invoice-document-profiles](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-document-profiles/getinvoicedocumentprofiles.md) ## invoice-templates Document templates used to define the invoice structure and look and feel ### Get a list of invoice templates e.g. Enterprise Invoice Blue, - [GET /invoice-templates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-templates/getinvoicetemplates.md) ## invoice-summary-templates Document templates used to define the invoice summary structure and look and feel ### Get a list of invoice summary templates e.g. Service Charges, - [GET /invoice-summary-templates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-summary-templates/getinvoicesummarytemplates.md) ## invoice-summary-template-components Document summary template components used to define the invoice summary structure and look and feel ### Get a list of invoice summary template components e.g. Service Charges - [GET /invoice-summary-template-components](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-summary-template-components/getinvoicesummarytemplatecomponents.md) ### Get a specific invoice summary template component - [GET /invoice-summary-template-components/{invoiceSummaryTemplateComponentId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-summary-template-components/getinvoicesummarytemplatecomponent.md) ## electronic-summary-templates Document templates used to define the electronic summary structure and look and feel ### Get a list of electronic summary templates - [GET /electronic-summary-templates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/electronic-summary-templates/getelectronicsummarytemplates.md) ### Get a specific electronic summary template - [GET /electronic-summary-templates/{electronicSummaryTemplateId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/electronic-summary-templates/getelectronicsummarytemplate.md) ## invoice-marketing-info Marketing information used to define the contents of the invoice template slots for a sub-brand ### Get a list of invoice marketing information for sub-brand and invoice template - [GET /invoice-marketing-info](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-marketing-info/getinvoicemarketinginfos.md) ### Check if invoice marketing info record exist - [HEAD /invoice-marketing-info](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-marketing-info/checkinvoicemarketinginfos.md) ### Create new invoice marketing info details for a sub-brand and invoice template - [POST /invoice-marketing-info](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-marketing-info/createinvoicemarketinginfo.md) ### Update a invoice marketing info record - [PATCH /invoice-marketing-info/{invoiceMarketingInfoId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-marketing-info/updateinvoicemarketinginfo.md) ### Get a specific invoice marketing info record - [GET /invoice-marketing-info/{invoiceMarketingInfoId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-marketing-info/getinvoicemarketinginfo.md) ### Delete an invoice marketing info record - [DELETE /invoice-marketing-info/{invoiceMarketingInfoId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-marketing-info/deleteinvoicemarketinginfo.md): Delete an invoice marketing info record ## invoice-marketing-info-preview Generate a preview with fake data and the invoice marketing information ### Generate a preview invoice PDF for invoice marketing info - [POST /invoice-marketing-info-preview](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-marketing-info-preview/generateinvoicepreviewpdf.md) ## admin-contacts Administration contacts used to receive tripwire, usage cap, and auto-close notifications ### Get a list of available admin contacts - [GET /admin-contacts](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/admin-contacts/getadmincontacts.md) ### Create a new admin contact - [POST /admin-contacts](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/admin-contacts/createadmincontact.md) ### Get a specific admin contact - [GET /admin-contacts/{adminContactId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/admin-contacts/getadmincontact.md) ### Update an admin contact - [PATCH /admin-contacts/{adminContactId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/admin-contacts/updateadmincontact.md) ### Delete an admin contact - [DELETE /admin-contacts/{adminContactId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/admin-contacts/deleteadmincontact.md) ## commission-agents Commission agents can be set against customers to manage commission ### Get a list of available commission agents - [GET /commission-agents](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/commission-agents/getcommissionagents.md) ## email-templates Email templates used to communicate via email ### Get a list of email templates - [GET /email-templates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/email-templates/getemailtemplates.md) ## custom-field-definitions Custom field definition are used to store additional information about entities in Elevate ### Get a list of custom field definitions - [GET /custom-field-definitions](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/custom-field-definitions/getcustomfielddefinitions.md) ### Create a new custom field definition - [POST /custom-field-definitions](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/custom-field-definitions/createcustomfielddefinition.md) ### Get a specific custom field definition - [GET /custom-field-definitions/{customFieldDefinitionId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/custom-field-definitions/getcustomfielddefinition.md) ### Update a custom field definition - [PATCH /custom-field-definitions/{customFieldDefinitionId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/custom-field-definitions/updatecustomfielddefinition.md) ### Delete a custom field definition - [DELETE /custom-field-definitions/{customFieldDefinitionId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/custom-field-definitions/deletecustomfielddefinition.md) ## contract-owner-sub-brands ### Get a list of available contract owner sub-brands - [GET /contract-owner-sub-brands](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owner-sub-brands/getcontractownersubbrands.md) ### Check if contract owner sub-brands exist - [HEAD /contract-owner-sub-brands](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owner-sub-brands/checkcontractownersubbrands.md) ### Create a new contract owner sub brand - [POST /contract-owner-sub-brands](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owner-sub-brands/createcontractownersubbrand.md) ### Update a contract_owner sub brand - [PATCH /contract-owner-sub-brands/{contractOwnerSubBrandId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owner-sub-brands/updatecontractownersubbrand.md) ### Get a specific contract owner sub brand - [GET /contract-owner-sub-brands/{contractOwnerSubBrandId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owner-sub-brands/getcontractownersubbrand.md) ### Delete a contract owner sub brand - [DELETE /contract-owner-sub-brands/{contractOwnerSubBrandId}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/contract-owner-sub-brands/deletecontractownersubbrand.md): Delete a contract owner sub brand ## invoice-marketing-info-trial-preview ### Generate a preview invoice PDF for passed in invoice marketing info - [POST /invoice-marketing-info-trial-preview](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-admin/invoice-marketing-info-trial-preview/generateinvoicetrialpreviewpdf.md)