Skip to content
/
Get a specific contract o...

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

Get a list of available contract owner sub-brands

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
contractOwnerIdinteger(int64)(IdParam)>= 1

Contract owner identifier

Example: contractOwnerId=1
activeCustomersBillingCycleIdstring(StringFilterParam)

Filter sub-brands that are used by active customers and associated to the billing cycle identifier

Example: activeCustomersBillingCycleId=xyz | in:x,y | like:xyz
adhocBillRunIdstring(StringFilterParam)

Filter sub-brands that are associated to the adhoc bill run

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

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Identifier

Example: 1
createdAtstring(date)

Created at

Example: "2023-10-05 16:40:04"
updatedAtstring(date)

Updated at

Example: "2023-10-05 16:40:04"
accountNumberFormatstring[ 0 .. 255 ] characters

Account number format

Example: "SI0000"
attachInvoiceToEmailboolean

Attach invoice to email

Example: "0x01"
bacsReferencestring[ 0 .. 255 ] characters

Bacs reference

Example: "Bacs Reference"
bankAccountNamestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Bank account name

Example: "Bank Account Name"
bankAccountNumberstring[ 0 .. 255 ] characters[0-9]*

Bank account number

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

An alternative name for the “account number” label that will appear on the invoice

Example: "Summary customer account number label"
bankSortCodestring[ 0 .. 255 ] characters[0-9]*

Bank sort code

Example: "123456"
swiftCodestring[ 8 .. 11 ] characters[0-9A-Z]*

SWIFT - ISO 9362 is an international standard for Business Identifier Codes

Example: "DEUTDEFFXXX"
billingPeriodEndDateLabelstring[ 1 .. 50 ] charactersrequired

An alternative name for the “End date” label that will appear on the invoice

Example: "Billing Period (Ending)"
companyRegistrationNumberstring[ 0 .. 255 ] characters[A-Za-z0-9]*

Company registration number to appear on the invoice

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

An alternative name for the “Company registration number” label that will appear on the invoice

Example: "Company Number"
vatRegistrationNumberstring[ 0 .. 255 ] charactersrequired

VAT registration number to appear on the invoice

Example: "Vat registration Number123"
customerServiceEmailstring[ 0 .. 255 ] characters(^$)|[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-z...

Customer service email address to appear on the invoice

Example: "customer@email.com"
customerServiceTelephoneNumberstring[ 0 .. 255 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Customer service telephone number to appear on the invoice

Example: "123-456-7890"
customerServiceWebSitestring

Customer service web site to appear on the invoice

Example: "https://www.customerservice.com"
defaultSubBrandbooleanrequired

Whether this sub brand is the default for the contract owner in hand

Example: true
emailBillingFromAddressstring[ 0 .. 255 ] charactersrequired

Email billing 'from' address

Example: "billing@example.com"
ibanstring[ 4 .. 34 ] characters[0-9A-Z]*

IBAN Number to appear on the invoice

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

An alternative name for the customer “Account number” label that will appear on the invoice

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

An alternative name for the “Invoice date” label that will appear on the invoice

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

Invoice email subject text

Example: "Invoice Email Subject"
invoiceNumberFormatstring[ 0 .. 255 ] characters

Invoice number format

Example: "InvoiceFormat123"
invoiceNumberLabelstring[ 1 .. 50 ] charactersrequired

An alternative name for the “Invoice number” label that will appear on the invoice

Example: "Invoice Number Label"
invoicePresentationNamestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Invoice presentation name

Example: "Invoice Presentation Name"
invoiceTaxLabelstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

An alternative name for the “Tax” label that will appear on the invoice

Example: "Invoice Tax Label"
namestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Name

Example: "bcn"
ofcomRidstring[ 0 .. 255 ] characters

Ofcom Reseller identification codes (RID)

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

An alternative name for the “Product reference” label that will appear on the invoice summary

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

An alternative name for the “invoice number” label that will appear on the invoice summary

Example: "Summary invoice number label"
taxExemptLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

If the invoice is set to Tax Exempt, a standard text to show on the invoice

Example: "Tax exempt label"
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"
contractOwnerIdintegerrequired

Contract Owner identifier

Example: 1
emailTemplateIdinteger(int64)required

Email template identifier to be used for the invoice email

Example: 1
prePopulatedTripwirePlanIdinteger(int64)

When creating a new customer, pre-populate this Tripwire plan identifier

Example: 1
invoiceNotesLabelstring[ 0 .. 100 ] characters

Notes to appear on the invoice

Example: "Invoice notes label"
]
Response
application/json
[
  {
    "id": 1,
    "createdAt": "2023-10-05 16:40:04",
    "updatedAt": "2023-10-05 16:40:04",
    "accountNumberFormat": "SI0000",
    "attachInvoiceToEmail": "0x01",
    "bacsReference": "Bacs Reference",
    "bankAccountName": "Bank Account Name",
    "bankAccountNumber": "1234567890",
    "summaryCustomerAccountNumberLabel": "Summary customer account number label",
    "bankSortCode": "123456",
    "swiftCode": "DEUTDEFFXXX",
    "billingPeriodEndDateLabel": "Billing Period (Ending)",
    "companyRegistrationNumber": "CompanyReg123",
    "companyRegistrationNumberLabel": "Company Number",
    "vatRegistrationNumber": "Vat registration Number123",
    "customerServiceEmail": "customer@email.com",
    "customerServiceTelephoneNumber": "123-456-7890",
    "customerServiceWebSite": "https://www.customerservice.com",
    "defaultSubBrand": true,
    "emailBillingFromAddress": "billing@example.com",
    "iban": "IBAN1234567890",
    "invoiceCustomerAccountNumberLabel": "Account Label",
    "invoiceDateLabel": "Invoice Date Label",
    "invoiceEmailSubject": "Invoice Email Subject",
    "invoiceNumberFormat": "InvoiceFormat123",
    "invoiceNumberLabel": "Invoice Number Label",
    "invoicePresentationName": "Invoice Presentation Name",
    "invoiceTaxLabel": "Invoice Tax Label",
    "name": "bcn",
    "ofcomRid": "OfcomRID123",
    "productReferenceLabel": "Product Reference Label",
    "summaryInvoiceNumberLabel": "Summary invoice number label",
    "taxExemptLabel": "Tax exempt label",
    "address": { … },
    "contractOwnerId": 1,
    "emailTemplateId": 1,
    "prePopulatedTripwirePlanId": 1,
    "invoiceNotesLabel": "Invoice notes label"
  }
]

Check if contract owner sub-brands exist

Request

Security
bearerAuth
Query
namestring(StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
contractOwnerIdinteger(int64)(IdParam)>= 1required

Contract owner identifier

Example: contractOwnerId=1
activeCustomersBillingCycleIdstring(StringFilterParam)

Filter for sub-brands that are used by customers who are active and associated to the billing cycle identifier

Example: activeCustomersBillingCycleId=xyz | in:x,y | like:xyz
adhocBillRunIdstring(StringFilterParam)

Filter sub-brands that are associated to the adhoc bill run

Example: adhocBillRunId=xyz | in:x,y | like:xyz
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v1/contract-owner-sub-brands?name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&contractOwnerId=1&activeCustomersBillingCycleId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&adhocBillRunId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exists

Headers
X-Total-Countinteger

Total number of sub-brands

Create a new contract owner sub brand

Request

Security
bearerAuth
Bodymultipart/form-datarequired

New contract owner sub brand

subBrandobject(ContractOwnerSubBrand)
logomultipartFile(binary)

Logo file content in image formats (png,jpg,etc)

curl -i -X POST \
  https://rest.elevatebilling.com/v1/contract-owner-sub-brands \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'subBrand[createdAt]=2023-10-05 16:40:04' \
  -F 'subBrand[updatedAt]=2023-10-05 16:40:04' \
  -F 'subBrand[accountNumberFormat]=SI0000' \
  -F 'subBrand[attachInvoiceToEmail]=0x01' \
  -F 'subBrand[bacsReference]=Bacs Reference' \
  -F 'subBrand[bankAccountName]=Bank Account Name' \
  -F 'subBrand[bankAccountNumber]=1234567890' \
  -F 'subBrand[summaryCustomerAccountNumberLabel]=Summary customer account number label' \
  -F 'subBrand[bankSortCode]=123456' \
  -F 'subBrand[swiftCode]=DEUTDEFFXXX' \
  -F 'subBrand[billingPeriodEndDateLabel]=Billing Period (Ending)' \
  -F 'subBrand[companyRegistrationNumber]=CompanyReg123' \
  -F 'subBrand[companyRegistrationNumberLabel]=Company Number' \
  -F 'subBrand[vatRegistrationNumber]=Vat registration Number123' \
  -F 'subBrand[customerServiceEmail]=customer@email.com' \
  -F 'subBrand[customerServiceTelephoneNumber]=123-456-7890' \
  -F 'subBrand[customerServiceWebSite]=https://www.customerservice.com' \
  -F 'subBrand[defaultSubBrand]=true' \
  -F 'subBrand[emailBillingFromAddress]=billing@example.com' \
  -F 'subBrand[iban]=IBAN1234567890' \
  -F 'subBrand[invoiceCustomerAccountNumberLabel]=Account Label' \
  -F 'subBrand[invoiceDateLabel]=Invoice Date Label' \
  -F 'subBrand[invoiceEmailSubject]=Invoice Email Subject' \
  -F 'subBrand[invoiceNumberFormat]=InvoiceFormat123' \
  -F 'subBrand[invoiceNumberLabel]=Invoice Number Label' \
  -F 'subBrand[invoicePresentationName]=Invoice Presentation Name' \
  -F 'subBrand[invoiceTaxLabel]=Invoice Tax Label' \
  -F 'subBrand[name]=bcn' \
  -F 'subBrand[ofcomRid]=OfcomRID123' \
  -F 'subBrand[productReferenceLabel]=Product Reference Label' \
  -F 'subBrand[summaryInvoiceNumberLabel]=Summary invoice number label' \
  -F 'subBrand[taxExemptLabel]=Tax exempt label' \
  -F 'subBrand[address][businessName]=string' \
  -F 'subBrand[address][address1]=string' \
  -F 'subBrand[address][address2]=string' \
  -F 'subBrand[address][address3]=string' \
  -F 'subBrand[address][town]=string' \
  -F 'subBrand[address][county]=string' \
  -F 'subBrand[address][postcode]=string' \
  -F 'subBrand[address][country]=GB' \
  -F 'subBrand[contractOwnerId]=1' \
  -F 'subBrand[emailTemplateId]=1' \
  -F 'subBrand[prePopulatedTripwirePlanId]=1' \
  -F 'subBrand[invoiceNotesLabel]=Invoice notes label' \
  -F logo=null

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Identifier

Example: 1
createdAtstring(date)

Created at

Example: "2023-10-05 16:40:04"
updatedAtstring(date)

Updated at

Example: "2023-10-05 16:40:04"
accountNumberFormatstring[ 0 .. 255 ] characters

Account number format

Example: "SI0000"
attachInvoiceToEmailboolean

Attach invoice to email

Example: "0x01"
bacsReferencestring[ 0 .. 255 ] characters

Bacs reference

Example: "Bacs Reference"
bankAccountNamestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Bank account name

Example: "Bank Account Name"
bankAccountNumberstring[ 0 .. 255 ] characters[0-9]*

Bank account number

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

An alternative name for the “account number” label that will appear on the invoice

Example: "Summary customer account number label"
bankSortCodestring[ 0 .. 255 ] characters[0-9]*

Bank sort code

Example: "123456"
swiftCodestring[ 8 .. 11 ] characters[0-9A-Z]*

SWIFT - ISO 9362 is an international standard for Business Identifier Codes

Example: "DEUTDEFFXXX"
billingPeriodEndDateLabelstring[ 1 .. 50 ] charactersrequired

An alternative name for the “End date” label that will appear on the invoice

Example: "Billing Period (Ending)"
companyRegistrationNumberstring[ 0 .. 255 ] characters[A-Za-z0-9]*

Company registration number to appear on the invoice

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

An alternative name for the “Company registration number” label that will appear on the invoice

Example: "Company Number"
vatRegistrationNumberstring[ 0 .. 255 ] charactersrequired

VAT registration number to appear on the invoice

Example: "Vat registration Number123"
customerServiceEmailstring[ 0 .. 255 ] characters(^$)|[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-z...

Customer service email address to appear on the invoice

Example: "customer@email.com"
customerServiceTelephoneNumberstring[ 0 .. 255 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Customer service telephone number to appear on the invoice

Example: "123-456-7890"
customerServiceWebSitestring

Customer service web site to appear on the invoice

Example: "https://www.customerservice.com"
defaultSubBrandbooleanrequired

Whether this sub brand is the default for the contract owner in hand

Example: true
emailBillingFromAddressstring[ 0 .. 255 ] charactersrequired

Email billing 'from' address

Example: "billing@example.com"
ibanstring[ 4 .. 34 ] characters[0-9A-Z]*

IBAN Number to appear on the invoice

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

An alternative name for the customer “Account number” label that will appear on the invoice

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

An alternative name for the “Invoice date” label that will appear on the invoice

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

Invoice email subject text

Example: "Invoice Email Subject"
invoiceNumberFormatstring[ 0 .. 255 ] characters

Invoice number format

Example: "InvoiceFormat123"
invoiceNumberLabelstring[ 1 .. 50 ] charactersrequired

An alternative name for the “Invoice number” label that will appear on the invoice

Example: "Invoice Number Label"
invoicePresentationNamestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Invoice presentation name

Example: "Invoice Presentation Name"
invoiceTaxLabelstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

An alternative name for the “Tax” label that will appear on the invoice

Example: "Invoice Tax Label"
namestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Name

Example: "bcn"
ofcomRidstring[ 0 .. 255 ] characters

Ofcom Reseller identification codes (RID)

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

An alternative name for the “Product reference” label that will appear on the invoice summary

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

An alternative name for the “invoice number” label that will appear on the invoice summary

Example: "Summary invoice number label"
taxExemptLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

If the invoice is set to Tax Exempt, a standard text to show on the invoice

Example: "Tax exempt label"
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"
contractOwnerIdintegerrequired

Contract Owner identifier

Example: 1
emailTemplateIdinteger(int64)required

Email template identifier to be used for the invoice email

Example: 1
prePopulatedTripwirePlanIdinteger(int64)

When creating a new customer, pre-populate this Tripwire plan identifier

Example: 1
invoiceNotesLabelstring[ 0 .. 100 ] characters

Notes to appear on the invoice

Example: "Invoice notes label"
Response
application/json
{
  "id": 1,
  "createdAt": "2023-10-05 16:40:04",
  "updatedAt": "2023-10-05 16:40:04",
  "accountNumberFormat": "SI0000",
  "attachInvoiceToEmail": "0x01",
  "bacsReference": "Bacs Reference",
  "bankAccountName": "Bank Account Name",
  "bankAccountNumber": "1234567890",
  "summaryCustomerAccountNumberLabel": "Summary customer account number label",
  "bankSortCode": "123456",
  "swiftCode": "DEUTDEFFXXX",
  "billingPeriodEndDateLabel": "Billing Period (Ending)",
  "companyRegistrationNumber": "CompanyReg123",
  "companyRegistrationNumberLabel": "Company Number",
  "vatRegistrationNumber": "Vat registration Number123",
  "customerServiceEmail": "customer@email.com",
  "customerServiceTelephoneNumber": "123-456-7890",
  "customerServiceWebSite": "https://www.customerservice.com",
  "defaultSubBrand": true,
  "emailBillingFromAddress": "billing@example.com",
  "iban": "IBAN1234567890",
  "invoiceCustomerAccountNumberLabel": "Account Label",
  "invoiceDateLabel": "Invoice Date Label",
  "invoiceEmailSubject": "Invoice Email Subject",
  "invoiceNumberFormat": "InvoiceFormat123",
  "invoiceNumberLabel": "Invoice Number Label",
  "invoicePresentationName": "Invoice Presentation Name",
  "invoiceTaxLabel": "Invoice Tax Label",
  "name": "bcn",
  "ofcomRid": "OfcomRID123",
  "productReferenceLabel": "Product Reference Label",
  "summaryInvoiceNumberLabel": "Summary invoice number label",
  "taxExemptLabel": "Tax exempt label",
  "address": {
    "id": 1,
    "businessName": "string",
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "country": "GB"
  },
  "contractOwnerId": 1,
  "emailTemplateId": 1,
  "prePopulatedTripwirePlanId": 1,
  "invoiceNotesLabel": "Invoice notes label"
}

Update a contract_owner sub brand

Request

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

Contract owner sub brand identifier

Example: 1
Body
required

A set of JSONPatch operations to be performed

filemultipartFile(binary)

Logo file content in image formats (png,jpg,etc)

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/contract-owner-sub-brands/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=null \
  -F 'patch[0][op]=add' \
  -F 'patch[0][path]=string' \
  -F 'patch[0][from]=string'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Identifier

Example: 1
createdAtstring(date)

Created at

Example: "2023-10-05 16:40:04"
updatedAtstring(date)

Updated at

Example: "2023-10-05 16:40:04"
accountNumberFormatstring[ 0 .. 255 ] characters

Account number format

Example: "SI0000"
attachInvoiceToEmailboolean

Attach invoice to email

Example: "0x01"
bacsReferencestring[ 0 .. 255 ] characters

Bacs reference

Example: "Bacs Reference"
bankAccountNamestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Bank account name

Example: "Bank Account Name"
bankAccountNumberstring[ 0 .. 255 ] characters[0-9]*

Bank account number

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

An alternative name for the “account number” label that will appear on the invoice

Example: "Summary customer account number label"
bankSortCodestring[ 0 .. 255 ] characters[0-9]*

Bank sort code

Example: "123456"
swiftCodestring[ 8 .. 11 ] characters[0-9A-Z]*

SWIFT - ISO 9362 is an international standard for Business Identifier Codes

Example: "DEUTDEFFXXX"
billingPeriodEndDateLabelstring[ 1 .. 50 ] charactersrequired

An alternative name for the “End date” label that will appear on the invoice

Example: "Billing Period (Ending)"
companyRegistrationNumberstring[ 0 .. 255 ] characters[A-Za-z0-9]*

Company registration number to appear on the invoice

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

An alternative name for the “Company registration number” label that will appear on the invoice

Example: "Company Number"
vatRegistrationNumberstring[ 0 .. 255 ] charactersrequired

VAT registration number to appear on the invoice

Example: "Vat registration Number123"
customerServiceEmailstring[ 0 .. 255 ] characters(^$)|[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-z...

Customer service email address to appear on the invoice

Example: "customer@email.com"
customerServiceTelephoneNumberstring[ 0 .. 255 ] characters^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Customer service telephone number to appear on the invoice

Example: "123-456-7890"
customerServiceWebSitestring

Customer service web site to appear on the invoice

Example: "https://www.customerservice.com"
defaultSubBrandbooleanrequired

Whether this sub brand is the default for the contract owner in hand

Example: true
emailBillingFromAddressstring[ 0 .. 255 ] charactersrequired

Email billing 'from' address

Example: "billing@example.com"
ibanstring[ 4 .. 34 ] characters[0-9A-Z]*

IBAN Number to appear on the invoice

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

An alternative name for the customer “Account number” label that will appear on the invoice

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

An alternative name for the “Invoice date” label that will appear on the invoice

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

Invoice email subject text

Example: "Invoice Email Subject"
invoiceNumberFormatstring[ 0 .. 255 ] characters

Invoice number format

Example: "InvoiceFormat123"
invoiceNumberLabelstring[ 1 .. 50 ] charactersrequired

An alternative name for the “Invoice number” label that will appear on the invoice

Example: "Invoice Number Label"
invoicePresentationNamestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Invoice presentation name

Example: "Invoice Presentation Name"
invoiceTaxLabelstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

An alternative name for the “Tax” label that will appear on the invoice

Example: "Invoice Tax Label"
namestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Name

Example: "bcn"
ofcomRidstring[ 0 .. 255 ] characters

Ofcom Reseller identification codes (RID)

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

An alternative name for the “Product reference” label that will appear on the invoice summary

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

An alternative name for the “invoice number” label that will appear on the invoice summary

Example: "Summary invoice number label"
taxExemptLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

If the invoice is set to Tax Exempt, a standard text to show on the invoice

Example: "Tax exempt label"
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"
contractOwnerIdintegerrequired

Contract Owner identifier

Example: 1
emailTemplateIdinteger(int64)required

Email template identifier to be used for the invoice email

Example: 1
prePopulatedTripwirePlanIdinteger(int64)

When creating a new customer, pre-populate this Tripwire plan identifier

Example: 1
invoiceNotesLabelstring[ 0 .. 100 ] characters

Notes to appear on the invoice

Example: "Invoice notes label"
Response
application/json
{
  "id": 1,
  "createdAt": "2023-10-05 16:40:04",
  "updatedAt": "2023-10-05 16:40:04",
  "accountNumberFormat": "SI0000",
  "attachInvoiceToEmail": "0x01",
  "bacsReference": "Bacs Reference",
  "bankAccountName": "Bank Account Name",
  "bankAccountNumber": "1234567890",
  "summaryCustomerAccountNumberLabel": "Summary customer account number label",
  "bankSortCode": "123456",
  "swiftCode": "DEUTDEFFXXX",
  "billingPeriodEndDateLabel": "Billing Period (Ending)",
  "companyRegistrationNumber": "CompanyReg123",
  "companyRegistrationNumberLabel": "Company Number",
  "vatRegistrationNumber": "Vat registration Number123",
  "customerServiceEmail": "customer@email.com",
  "customerServiceTelephoneNumber": "123-456-7890",
  "customerServiceWebSite": "https://www.customerservice.com",
  "defaultSubBrand": true,
  "emailBillingFromAddress": "billing@example.com",
  "iban": "IBAN1234567890",
  "invoiceCustomerAccountNumberLabel": "Account Label",
  "invoiceDateLabel": "Invoice Date Label",
  "invoiceEmailSubject": "Invoice Email Subject",
  "invoiceNumberFormat": "InvoiceFormat123",
  "invoiceNumberLabel": "Invoice Number Label",
  "invoicePresentationName": "Invoice Presentation Name",
  "invoiceTaxLabel": "Invoice Tax Label",
  "name": "bcn",
  "ofcomRid": "OfcomRID123",
  "productReferenceLabel": "Product Reference Label",
  "summaryInvoiceNumberLabel": "Summary invoice number label",
  "taxExemptLabel": "Tax exempt label",
  "address": {
    "id": 1,
    "businessName": "string",
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "country": "GB"
  },
  "contractOwnerId": 1,
  "emailTemplateId": 1,
  "prePopulatedTripwirePlanId": 1,
  "invoiceNotesLabel": "Invoice notes label"
}

Get a specific contract owner sub brand

Request

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

Contract owner sub brand identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v1/contract-owner-sub-brands/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Contract owner sub brand found

Bodymultipart/form-data
subBrandobject(ContractOwnerSubBrand)
logomultipartFile(binary)

Logo file content in image formats (png,jpg,etc)

Response
multipart/form-data
{
  "subBrand": {
    "id": 1,
    "createdAt": "2023-10-05 16:40:04",
    "updatedAt": "2023-10-05 16:40:04",
    "accountNumberFormat": "SI0000",
    "attachInvoiceToEmail": "0x01",
    "bacsReference": "Bacs Reference",
    "bankAccountName": "Bank Account Name",
    "bankAccountNumber": "1234567890",
    "summaryCustomerAccountNumberLabel": "Summary customer account number label",
    "bankSortCode": "123456",
    "swiftCode": "DEUTDEFFXXX",
    "billingPeriodEndDateLabel": "Billing Period (Ending)",
    "companyRegistrationNumber": "CompanyReg123",
    "companyRegistrationNumberLabel": "Company Number",
    "vatRegistrationNumber": "Vat registration Number123",
    "customerServiceEmail": "customer@email.com",
    "customerServiceTelephoneNumber": "123-456-7890",
    "customerServiceWebSite": "https://www.customerservice.com",
    "defaultSubBrand": true,
    "emailBillingFromAddress": "billing@example.com",
    "iban": "IBAN1234567890",
    "invoiceCustomerAccountNumberLabel": "Account Label",
    "invoiceDateLabel": "Invoice Date Label",
    "invoiceEmailSubject": "Invoice Email Subject",
    "invoiceNumberFormat": "InvoiceFormat123",
    "invoiceNumberLabel": "Invoice Number Label",
    "invoicePresentationName": "Invoice Presentation Name",
    "invoiceTaxLabel": "Invoice Tax Label",
    "name": "bcn",
    "ofcomRid": "OfcomRID123",
    "productReferenceLabel": "Product Reference Label",
    "summaryInvoiceNumberLabel": "Summary invoice number label",
    "taxExemptLabel": "Tax exempt label",
    "address": {
      "id": 1,
      "businessName": "string",
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "town": "string",
      "county": "string",
      "postcode": "string",
      "country": "GB"
    },
    "contractOwnerId": 1,
    "emailTemplateId": 1,
    "prePopulatedTripwirePlanId": 1,
    "invoiceNotesLabel": "Invoice notes label"
  },
  "logo": null
}

Delete a contract owner sub brand

Request

Delete a contract owner sub brand

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

Contract sub brand identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v1/contract-owner-sub-brands/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body

invoice-marketing-info-trial-preview

Operations