Contract owners segregate Customers for reporting and/or branding purposes
Elevate Admin API (1.44)
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.
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
Languages
Servers
https://rest.elevatebilling.com/v1
- https://rest.elevatebilling.com/v1/billing-cycles
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v1/billing-cycles?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'OK
Billing cycle name
Start day of period. If using a monthly billing cycle, then this would be the day of the month from 1 to 28. If using as weekly or daily billing cycle, then this would be the day of the week from 1 (Mon) to 7 (Sun)
This is the length of the billing period and should be set to one by default which is the monthly billing cycle. A value of three would indicate that it is a quarterly billing cycle.
Default 1
Example: 1
The number of days before the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too early (for example trying to close the 31st March 2014 bill run on 13th March 2014).
Default 15
Example: 15
The number of days after the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too late (for example trying to close the 31st March 2014 bill run on 30th April 2014).
Default 15
Example: 15
Any usage records in this bill cycle will not be billed out if older than this setting
ISO 4217 3-character currency code
Example: "GBP"
Default invoice dates
Enum"TODAY""END_OF_BILL_RUN""END_OF_BILL_RUN_PLUS_ONE"
How to auto-complete a bill run
Enum"DISABLED""CLOSE_ONLY""CLOSE_AND_FINALIZE"
Number of days after bill run period end date to automatically close the bill run. Must be within the maxDaysBeforeCloseable and maxDaysAfterCloseable boundaries
Identifier of user who will automatically close the bill run
Example: 1
a name to tag this billing cycle with. This is used to group billing cycles together for bulk processing
Response
application/json
[ { "id": 1, "name": "string", "startDayOfPeriod": 1, "lengthOfPeriod": 1, "periodUnit": "DAILY", "maxDaysBeforeCloseable": 15, "maxDaysAfterCloseable": 15, "maxBackDateableUsageInDays": 0, "currencyCode": "GBP", "defaultInvoiceDate": "TODAY", "completionType": "DISABLED", "autoCloseHour": 23, "autoCloseMinute": 59, "autoCloseOffsetDays": -9999, "autoCloseUserId": 1, "billingCycleRules": [ … ], "billingCycleStats": [ … ], "contractOwnerCustomerCounts": [ … ], "groupName": "string" } ]
Bodyapplication/jsonrequired
New billing cycle
Billing cycle name
Start day of period. If using a monthly billing cycle, then this would be the day of the month from 1 to 28. If using as weekly or daily billing cycle, then this would be the day of the week from 1 (Mon) to 7 (Sun)
This is the length of the billing period and should be set to one by default which is the monthly billing cycle. A value of three would indicate that it is a quarterly billing cycle.
Default 1
Example: 1
The number of days before the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too early (for example trying to close the 31st March 2014 bill run on 13th March 2014).
Default 15
Example: 15
The number of days after the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too late (for example trying to close the 31st March 2014 bill run on 30th April 2014).
Default 15
Example: 15
Any usage records in this bill cycle will not be billed out if older than this setting
ISO 4217 3-character currency code
Example: "GBP"
Default invoice dates
Enum"TODAY""END_OF_BILL_RUN""END_OF_BILL_RUN_PLUS_ONE"
How to auto-complete a bill run
Enum"DISABLED""CLOSE_ONLY""CLOSE_AND_FINALIZE"
Number of days after bill run period end date to automatically close the bill run. Must be within the maxDaysBeforeCloseable and maxDaysAfterCloseable boundaries
Identifier of user who will automatically close the bill run
Example: 1
- https://rest.elevatebilling.com/v1/billing-cycles
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://rest.elevatebilling.com/v1/billing-cycles \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'defaultBillRunStartsOn: string' \
-d '{
"name": "string",
"startDayOfPeriod": 1,
"lengthOfPeriod": 1,
"periodUnit": "DAILY",
"maxDaysBeforeCloseable": 15,
"maxDaysAfterCloseable": 15,
"maxBackDateableUsageInDays": 0,
"currencyCode": "GBP",
"defaultInvoiceDate": "TODAY",
"completionType": "DISABLED",
"autoCloseHour": 23,
"autoCloseMinute": 59,
"autoCloseOffsetDays": -9999,
"autoCloseUserId": 1,
"billingCycleRules": [
{
"type": "REVENUE",
"thresholdPercentage": 1,
"thresholdMinValue": 50000,
"thresholdMaxValue": 50000,
"active": true,
"comparisonPeriod": "THREE_PERIODS",
"comparisonBasedOn": "VALUE"
}
],
"billingCycleStats": [
{
"type": "REVENUE",
"value": 0,
"comparisonPeriod": "THREE_PERIODS"
}
],
"contractOwnerCustomerCounts": [
{}
],
"groupName": "string"
}'OK
Billing cycle name
Start day of period. If using a monthly billing cycle, then this would be the day of the month from 1 to 28. If using as weekly or daily billing cycle, then this would be the day of the week from 1 (Mon) to 7 (Sun)
This is the length of the billing period and should be set to one by default which is the monthly billing cycle. A value of three would indicate that it is a quarterly billing cycle.
Default 1
Example: 1
The number of days before the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too early (for example trying to close the 31st March 2014 bill run on 13th March 2014).
Default 15
Example: 15
The number of days after the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too late (for example trying to close the 31st March 2014 bill run on 30th April 2014).
Default 15
Example: 15
Any usage records in this bill cycle will not be billed out if older than this setting
ISO 4217 3-character currency code
Example: "GBP"
Default invoice dates
Enum"TODAY""END_OF_BILL_RUN""END_OF_BILL_RUN_PLUS_ONE"
How to auto-complete a bill run
Enum"DISABLED""CLOSE_ONLY""CLOSE_AND_FINALIZE"
Number of days after bill run period end date to automatically close the bill run. Must be within the maxDaysBeforeCloseable and maxDaysAfterCloseable boundaries
Identifier of user who will automatically close the bill run
Example: 1
Response
application/json
{ "id": 1, "name": "string", "startDayOfPeriod": 1, "lengthOfPeriod": 1, "periodUnit": "DAILY", "maxDaysBeforeCloseable": 15, "maxDaysAfterCloseable": 15, "maxBackDateableUsageInDays": 0, "currencyCode": "GBP", "defaultInvoiceDate": "TODAY", "completionType": "DISABLED", "autoCloseHour": 23, "autoCloseMinute": 59, "autoCloseOffsetDays": -9999, "autoCloseUserId": 1, "billingCycleRules": [ { … } ], "billingCycleStats": [ { … } ], "contractOwnerCustomerCounts": [ { … } ], "groupName": "string" }
- https://rest.elevatebilling.com/v1/billing-cycles/{billing_cycle_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://rest.elevatebilling.com/v1/billing-cycles/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Billing cycle found
Billing cycle name
Start day of period. If using a monthly billing cycle, then this would be the day of the month from 1 to 28. If using as weekly or daily billing cycle, then this would be the day of the week from 1 (Mon) to 7 (Sun)
This is the length of the billing period and should be set to one by default which is the monthly billing cycle. A value of three would indicate that it is a quarterly billing cycle.
Default 1
Example: 1
The number of days before the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too early (for example trying to close the 31st March 2014 bill run on 13th March 2014).
Default 15
Example: 15
The number of days after the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too late (for example trying to close the 31st March 2014 bill run on 30th April 2014).
Default 15
Example: 15
Any usage records in this bill cycle will not be billed out if older than this setting
ISO 4217 3-character currency code
Example: "GBP"
Default invoice dates
Enum"TODAY""END_OF_BILL_RUN""END_OF_BILL_RUN_PLUS_ONE"
How to auto-complete a bill run
Enum"DISABLED""CLOSE_ONLY""CLOSE_AND_FINALIZE"
Number of days after bill run period end date to automatically close the bill run. Must be within the maxDaysBeforeCloseable and maxDaysAfterCloseable boundaries
Identifier of user who will automatically close the bill run
Example: 1
Response
application/json
{ "id": 1, "name": "string", "startDayOfPeriod": 1, "lengthOfPeriod": 1, "periodUnit": "DAILY", "maxDaysBeforeCloseable": 15, "maxDaysAfterCloseable": 15, "maxBackDateableUsageInDays": 0, "currencyCode": "GBP", "defaultInvoiceDate": "TODAY", "completionType": "DISABLED", "autoCloseHour": 23, "autoCloseMinute": 59, "autoCloseOffsetDays": -9999, "autoCloseUserId": 1, "billingCycleRules": [ { … } ], "billingCycleStats": [ { … } ], "contractOwnerCustomerCounts": [ { … } ], "groupName": "string" }
Bodyapplication/json-patch+jsonrequired
A set of JSONPatch operations to be performed
The JSON Patch operation to be performed
Enum"add""remove""replace""move""copy""test"
- https://rest.elevatebilling.com/v1/billing-cycles/{billing_cycle_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://rest.elevatebilling.com/v1/billing-cycles/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"op": "replace",
"path": "/name",
"value": "MyNewName"
}
]'Success
Billing cycle name
Start day of period. If using a monthly billing cycle, then this would be the day of the month from 1 to 28. If using as weekly or daily billing cycle, then this would be the day of the week from 1 (Mon) to 7 (Sun)
This is the length of the billing period and should be set to one by default which is the monthly billing cycle. A value of three would indicate that it is a quarterly billing cycle.
Default 1
Example: 1
The number of days before the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too early (for example trying to close the 31st March 2014 bill run on 13th March 2014).
Default 15
Example: 15
The number of days after the periodEndDate that the billing period can be closed. e.g it should be defaulted to a sensible value like 15 days and prevent the closure the billing run too late (for example trying to close the 31st March 2014 bill run on 30th April 2014).
Default 15
Example: 15
Any usage records in this bill cycle will not be billed out if older than this setting
ISO 4217 3-character currency code
Example: "GBP"
Default invoice dates
Enum"TODAY""END_OF_BILL_RUN""END_OF_BILL_RUN_PLUS_ONE"
How to auto-complete a bill run
Enum"DISABLED""CLOSE_ONLY""CLOSE_AND_FINALIZE"
Number of days after bill run period end date to automatically close the bill run. Must be within the maxDaysBeforeCloseable and maxDaysAfterCloseable boundaries
Identifier of user who will automatically close the bill run
Example: 1
Response
application/json
{ "id": 1, "name": "string", "startDayOfPeriod": 1, "lengthOfPeriod": 1, "periodUnit": "DAILY", "maxDaysBeforeCloseable": 15, "maxDaysAfterCloseable": 15, "maxBackDateableUsageInDays": 0, "currencyCode": "GBP", "defaultInvoiceDate": "TODAY", "completionType": "DISABLED", "autoCloseHour": 23, "autoCloseMinute": 59, "autoCloseOffsetDays": -9999, "autoCloseUserId": 1, "billingCycleRules": [ { … } ], "billingCycleStats": [ { … } ], "contractOwnerCustomerCounts": [ { … } ], "groupName": "string" }
- https://rest.elevatebilling.com/v1/billing-cycles/{billing_cycle_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://rest.elevatebilling.com/v1/billing-cycles/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'cascade: string'