TAG LINE
SMALL TITLE

Contract / Commitment Type

(API Version v4)


This entity is the system defined type of contract commitment such as "invoice amount", "package", "service" and "usage".


What can you do with ContractCommitmentType?


Properties

Property Details
identity
READ-ONLY
"identity": 6
Type: Number
This is the unique numeric identifier for the ContractCommitmentType
name
"name": "Invoice Amount"
Type: String
System defined name for the Commitment Type
sortOrder
"sortOrder": 4
Type: Number
Unused


End Points

GETapi/v4/Contract/CommitmentType/
Retrieve all of the ContractCommitmentType objects.
Retrieve all of the ContractCommitmentType objects.
GET api/v4/Contract/CommitmentType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Invoice Amount",
            "sortOrder": 21
        }
    ]
}
GETapi/v4/Contract/CommitmentType/Paged
Retrieve all of the ContractCommitmentType 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 ContractCommitmentType objects in a paged fashion.
GET api/v4/Contract/CommitmentType/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": "Invoice Amount",
                "sortOrder": 22
            }
        ]
    }
}
GETapi/v4/Contract/CommitmentType/{id}
Retrieve an instance of the ContractCommitmentType object by its ID.
{id}Unique identifier for the ContractCommitmentType object.
Retrieve an instance of the ContractCommitmentType object by its ID.
GET api/v4/Contract/CommitmentType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Invoice Amount",
        "sortOrder": 20
    }
}
POSTapi/v4/Contract/CommitmentType/Search
Retreive a list of ContractCommitmentType 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 ContractCommitmentType objects based on search criteria.
POST api/v4/Contract/CommitmentType/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": "Invoice Amount",
            "sortOrder": 6
        }
    ]
}