TAG LINE
SMALL TITLE
This object lists the different types of contract renewals such as "Expires at End of Term", "New Contract" and "Auto Renew".
identity READ-ONLY | "identity": 8 Type: Number This is the unique numeric identifier for the AccountContractRenewalType |
name READ-ONLY | "name": "Expires at End of Term" Type: String The system description of this renewal type. |
sortOrder READ-ONLY | "sortOrder": 7 Type: Number Unused field and can be ignored |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
| GET | api/v3/Account/Contract/RenewalType/ |
| Retrieve all of the AccountContractRenewalType objects. | |
Retrieve all of the AccountContractRenewalType objects. GET api/v3/Account/Contract/RenewalType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Expires at End of Term",
"sortOrder": 0
}
]
} | |
| GET | api/v3/Account/Contract/RenewalType/Paged |
| Retrieve all of the AccountContractRenewalType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the AccountContractRenewalType objects in a paged fashion. GET api/v3/Account/Contract/RenewalType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Expires at End of Term",
"sortOrder": 11
}
]
}
} | |
| GET | api/v3/Account/Contract/RenewalType/{id} |
| Retrieve an instance of the AccountContractRenewalType object by its ID. | |
| {id} | Unique identifier for the AccountContractRenewalType object. |
Retrieve an instance of the AccountContractRenewalType object by its ID. GET api/v3/Account/Contract/RenewalType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Expires at End of Term",
"sortOrder": 20
}
} | |