Contract profiles are used to define early termination charges and contract term length
- Check if customer contract assignment exists
Get a list of customer contracts
Create a new customer contract
Check if customer contract exists
Get a specific customer contract
Update a customer contract
Delete a customer contract
Get a list of RPI and Customer Contract assignments
Create a new customer contract RPI assignment
Get a specific customer contract assignment
Delete a customer contract RPI assignment
Update a customer contract RPI assignment
Check if customer contrac...
Elevate Contract Management (1.12)
Provides read & write access to manage contract profiles and to allocate contracts to customers
Download OpenAPI description
Languages
Servers
https://rest.elevatebilling.com/v1
Query
Results to return per page
Example: pageSize=100
Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
Example: sort=id,name | name:desc
Comma-delimited list of the field(s) to return if only a subset is required
Example: fields=id,name
Filter by start date
Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
Filter by end date
Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
Filter by rollover contract profile
Example: rolloverContractProfileId=0
Filter by contracts within renewal alert day(s)
Example: renewalAlert=true | false
Filter by contracts within notice period alert day(s)
Example: noticePeriod=true | false
Filter by text (Name, Assignment Level, Profile Name or Roll-over Profile Name)
Example: filter=xyz | in:x,y | like:xyz
Filter to include superseded i.e. old versions of the customer contract
Example: includeSupersededVersions=true | false
If true, then return only customer contracts associated to RPIs that are 'recent', or customer contracts starting in the future
Example: recentWithRPIsOrFuture=true | false
The name of the site to which the customer is associated
Example: siteName=xyz | in:x,y | like:xyz
The name of the contract profile to which this customer contract is associated to
Example: contractProfileName=xyz | in:x,y | like:xyz
- https://rest.elevatebilling.com/v1/customer-contracts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v1/customer-contracts?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&id=0&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerId=0&siteId=0&contractProfileId=0&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&rolloverContractProfileId=0&renewalAlert=true+%2C+false¬icePeriod=true+%2C+false&filter=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&includeSupersededVersions=true+%2C+false&recentWithRPIsOrFuture=true+%2C+false&siteName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&contractProfileName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&logic=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'OK
Generated contract Name
Date when this customer contract ends based on start date and contract profile term
Once term of this contract ends, contract will auto-renew as this contract
Renewal alert will be given this many days before the contract ends
Notice period alert will be given this many days before the contract ends
Where this contract had rolled-over from a previous contract, contains the previous contract
Where this contract rolled-over, contains the next contract that replaced this contract
The amount that will be charged in major currency if the customer contract was to be ended today
Example: 15.54
Number of rental product inventories currently assigned to the customer contract
Response
application/json
[ { "id": 1, "name": "string", "customerId": 0, "siteId": 0, "contractProfileId": 0, "startDate": "2019-08-24", "endDate": "2019-08-24", "createdDate": "2019-08-24T14:15:22Z", "rolloverContractProfileId": 0, "renewalAlertDays": 28, "noticePeriodDays": 2147483647, "previousCustomerContractId": 0, "renewedCustomerContractId": 0, "earlyTerminationChargeAmount": 15.54, "inventoryCount": 0, "siteName": "string", "contractProfileName": "string" } ]
Bodyapplication/jsonrequired
New customer contract
Generated contract Name
Date when this customer contract ends based on start date and contract profile term
Once term of this contract ends, contract will auto-renew as this contract
Renewal alert will be given this many days before the contract ends
- https://rest.elevatebilling.com/v1/customer-contracts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://rest.elevatebilling.com/v1/customer-contracts \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"customerId": 0,
"siteId": 0,
"contractProfileId": 0,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"rolloverContractProfileId": 0,
"renewalAlertDays": 28,
"noticePeriodDays": 2147483647
}'OK
Generated contract Name
Date when this customer contract ends based on start date and contract profile term
Once term of this contract ends, contract will auto-renew as this contract
Renewal alert will be given this many days before the contract ends
Notice period alert will be given this many days before the contract ends
Where this contract had rolled-over from a previous contract, contains the previous contract
Where this contract rolled-over, contains the next contract that replaced this contract
The amount that will be charged in major currency if the customer contract was to be ended today
Example: 15.54
Number of rental product inventories currently assigned to the customer contract
Response
application/json
{ "id": 1, "name": "string", "customerId": 0, "siteId": 0, "contractProfileId": 0, "startDate": "2019-08-24", "endDate": "2019-08-24", "createdDate": "2019-08-24T14:15:22Z", "rolloverContractProfileId": 0, "renewalAlertDays": 28, "noticePeriodDays": 2147483647, "previousCustomerContractId": 0, "renewedCustomerContractId": 0, "earlyTerminationChargeAmount": 15.54, "inventoryCount": 0, "siteName": "string", "contractProfileName": "string" }
- https://rest.elevatebilling.com/v1/customer-contracts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X HEAD \
'https://rest.elevatebilling.com/v1/customer-contracts?name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerId=0&siteId=0&contractProfileId=0&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&rolloverContractProfileId=0&recentWithRPIsOrFuture=true+%2C+false' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- https://rest.elevatebilling.com/v1/customer-contracts/{customer_contract_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://rest.elevatebilling.com/v1/customer-contracts/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Customer contract found
Generated contract Name
Date when this customer contract ends based on start date and contract profile term
Once term of this contract ends, contract will auto-renew as this contract
Renewal alert will be given this many days before the contract ends
Notice period alert will be given this many days before the contract ends
Where this contract had rolled-over from a previous contract, contains the previous contract
Where this contract rolled-over, contains the next contract that replaced this contract
The amount that will be charged in major currency if the customer contract was to be ended today
Example: 15.54
Number of rental product inventories currently assigned to the customer contract
Response
application/json
{ "id": 1, "name": "string", "customerId": 0, "siteId": 0, "contractProfileId": 0, "startDate": "2019-08-24", "endDate": "2019-08-24", "createdDate": "2019-08-24T14:15:22Z", "rolloverContractProfileId": 0, "renewalAlertDays": 28, "noticePeriodDays": 2147483647, "previousCustomerContractId": 0, "renewedCustomerContractId": 0, "earlyTerminationChargeAmount": 15.54, "inventoryCount": 0, "siteName": "string", "contractProfileName": "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/customer-contracts/{customer_contract_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://rest.elevatebilling.com/v1/customer-contracts/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"op": "replace",
"path": "/name",
"value": "MyFavContractProfile"
}
]'Success
Generated contract Name
Date when this customer contract ends based on start date and contract profile term
Once term of this contract ends, contract will auto-renew as this contract
Renewal alert will be given this many days before the contract ends
Notice period alert will be given this many days before the contract ends
Where this contract had rolled-over from a previous contract, contains the previous contract
Where this contract rolled-over, contains the next contract that replaced this contract
The amount that will be charged in major currency if the customer contract was to be ended today
Example: 15.54
Number of rental product inventories currently assigned to the customer contract
Response
application/json
{ "id": 1, "name": "string", "customerId": 0, "siteId": 0, "contractProfileId": 0, "startDate": "2019-08-24", "endDate": "2019-08-24", "createdDate": "2019-08-24T14:15:22Z", "rolloverContractProfileId": 0, "renewalAlertDays": 28, "noticePeriodDays": 2147483647, "previousCustomerContractId": 0, "renewedCustomerContractId": 0, "earlyTerminationChargeAmount": 15.54, "inventoryCount": 0, "siteName": "string", "contractProfileName": "string" }
- https://rest.elevatebilling.com/v1/customer-contracts/{customer_contract_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://rest.elevatebilling.com/v1/customer-contracts/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- https://rest.elevatebilling.com/v1/customer-contract-assignments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v1/customer-contract-assignments?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&id=0&customerContractId=0&rentalProductInventoryId=0&active=true+%2C+false' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
[ { "id": 1, "rentalProductInventoryId": 0, "customerContractId": 0, "createdDate": "2019-08-24T14:15:22Z", "active": true } ]
Bodyapplication/jsonrequired
New customer contract assignment
Customer contract identifier to assign RPI - must be same customer (+ optionally site) as RPI
- https://rest.elevatebilling.com/v1/customer-contract-assignments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://rest.elevatebilling.com/v1/customer-contract-assignments \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"rentalProductInventoryId": 0,
"customerContractId": 0,
"active": true
}'Response
application/json
{ "id": 1, "rentalProductInventoryId": 0, "customerContractId": 0, "createdDate": "2019-08-24T14:15:22Z", "active": true }
- https://rest.elevatebilling.com/v1/customer-contract-assignments
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X HEAD \
'https://rest.elevatebilling.com/v1/customer-contract-assignments?customerContractId=0&rentalProductInventoryId=0&active=true+%2C+false' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- https://rest.elevatebilling.com/v1/customer-contract-assignments/{customer_contract_assignment_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://rest.elevatebilling.com/v1/customer-contract-assignments/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "id": 1, "rentalProductInventoryId": 0, "customerContractId": 0, "createdDate": "2019-08-24T14:15:22Z", "active": true }
- https://rest.elevatebilling.com/v1/customer-contract-assignments/{customer_contract_assignment_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://rest.elevatebilling.com/v1/customer-contract-assignments/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'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/customer-contract-assignments/{customer_contract_assignment_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://rest.elevatebilling.com/v1/customer-contract-assignments/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"op": "replace",
"path": "/active",
"value": "false"
}
]'Response
application/json
{ "id": 1, "rentalProductInventoryId": 0, "customerContractId": 0, "createdDate": "2019-08-24T14:15:22Z", "active": true }