TAG LINE
SMALL TITLE

Account / Contract / Renewal Type

(API Version v4)


This object lists the different types of contract renewals such as "Expires at End of Term", "New Contract" and "Auto Renew".


What can you do with AccountContractRenewalType?


Properties

Property Details
identity
READ-ONLY
"identity": 25
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": 4
Type: Number
Unused field and can be ignored


End Points

GETapi/v4/Account/Contract/RenewalType/
Retrieve all of the AccountContractRenewalType objects.
Retrieve all of the AccountContractRenewalType objects.
GET api/v4/Account/Contract/RenewalType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Expires at End of Term",
            "sortOrder": 4
        }
    ]
}
GETapi/v4/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/v4/Account/Contract/RenewalType/Paged
View Sample Response
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": 2
            }
        ]
    }
}
GETapi/v4/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/v4/Account/Contract/RenewalType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Expires at End of Term",
        "sortOrder": 8
    }
}
POSTapi/v4/Account/Contract/RenewalType/Search
Retreive a list of AccountContractRenewalType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of AccountContractRenewalType objects based on search criteria.
POST api/v4/Account/Contract/RenewalType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Expires at End of Term",
            "sortOrder": 22
        }
    ]
}