TAG LINE
TAG LINE
SMALL TITLE
This entity represents different types of penalty charges such as fixed penalties, per unit, per unit charge type or other categorizations of penalty charges.
identity READ-ONLY | "identity": 21 Type: Number This is the unique numeric identifier for the ContractCommitmentPenaltyChargeType |
name | "name": "Fixed Penalty Charge" Type: String User friendly name for a penalty charge type |
| GET | Contract/Commitment/PenaltyChargeType/ |
| Retrieve all of the ContractCommitmentPenaltyChargeType objects. | |
Retrieve all of the ContractCommitmentPenaltyChargeType objects. GET Contract/Commitment/PenaltyChargeType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Fixed Penalty Charge"
}
]
} | |
| GET | Contract/Commitment/PenaltyChargeType/Paged |
| Retrieve all of the ContractCommitmentPenaltyChargeType 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 ContractCommitmentPenaltyChargeType objects in a paged fashion. GET Contract/Commitment/PenaltyChargeType/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": "Fixed Penalty Charge"
}
]
}
} | |
| GET | Contract/Commitment/PenaltyChargeType/{id} |
| Retrieve an instance of the ContractCommitmentPenaltyChargeType object by its ID. | |
| {id} | Unique identifier for the ContractCommitmentPenaltyChargeType object. |
Retrieve an instance of the ContractCommitmentPenaltyChargeType object by its ID. GET Contract/Commitment/PenaltyChargeType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Fixed Penalty Charge"
}
} | |