TAG LINE
TAG LINE
SMALL TITLE
This entity is the top level container for a Contract Commitment that is associated with an Account Contract.
identity READ-ONLY | "identity": 24 Type: Number This is the unique numeric identifier for the ContractCommitment |
accountContractId | "accountContractId": 14 Type: Number Unique identifier for the associated AccountContract object. |
accountContractName | "accountContractName": "Sample Name" Type: String The name of the object associated with the accountContractId property. |
contractCommitmentTypeId | "contractCommitmentTypeId": 23 Type: Number Unique identifier for the associated ContractCommitmentType object. |
contractCommitmentTypeName | "contractCommitmentTypeName": "Sample Name" Type: String The name of the object associated with the contractCommitmentTypeId property. |
penaltyServiceId | "penaltyServiceId": 26 Type: Number Unique identifier for the associated Service object. |
penaltyServiceName | "penaltyServiceName": "Sample Name" Type: String The name of the object associated with the penaltyServiceId property. |
penaltyDescription | "penaltyDescription": "Minimum quantity commit." Type: String User friendly description for a penalty applied for this commitment |
includeChildAccounts | "includeChildAccounts": true Type: Boolean Whether or not child accounts should be considered in this rule. |
contractCommitmentPenaltyChargeTypeId | "contractCommitmentPenaltyChargeTypeId": 6 Type: Number Unique identifier for the associated ContractCommitmentPenaltyChargeType object. |
contractCommitmentPenaltyChargeTypeName | "contractCommitmentPenaltyChargeTypeName": "Sample Name" Type: String The name of the object associated with the contractCommitmentPenaltyChargeTypeId property. |
The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.
PATCH operations can be used as a standard API call. Below you will find the child objects that can be updated as part of PATCH operations for the ContractCommitment object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | Contract/Commitment/{id} |
| Delete an instance of the ContractCommitment object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the ContractCommitment object. |
Delete an instance of the ContractCommitment object. DELETE Contract/Commitment/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "contractCommitment"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Contract/Commitment/ |
| Retrieve all of the ContractCommitment objects. | |
Retrieve all of the ContractCommitment objects. GET Contract/Commitment/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"accountContractId": 7,
"accountContractName": "Sample Text Data",
"contractCommitmentTypeId": 19,
"contractCommitmentTypeName": "Sample Text Data",
"penaltyServiceId": 17,
"penaltyServiceName": "Sample Text Data",
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 9,
"contractCommitmentPenaltyChargeTypeName": "Sample Text Data"
}
]
} | |
| GET | Contract/Commitment/Paged |
| Retrieve all of the ContractCommitment 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 ContractCommitment objects in a paged fashion. GET Contract/Commitment/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,
"accountContractId": 2,
"accountContractName": "Sample Text Data",
"contractCommitmentTypeId": 12,
"contractCommitmentTypeName": "Sample Text Data",
"penaltyServiceId": 7,
"penaltyServiceName": "Sample Text Data",
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 9,
"contractCommitmentPenaltyChargeTypeName": "Sample Text Data"
}
]
}
} | |
| GET | Contract/Commitment/Paged/Detail |
| Retrieve all of the ContractCommitment objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the ContractCommitment objects in a paged fashion with all object details. GET Contract/Commitment/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"accountContractId": 1,
"accountContractName": "Sample Text Data",
"contractCommitmentTypeId": 5,
"contractCommitmentTypeName": "Sample Text Data",
"penaltyServiceId": 24,
"penaltyServiceName": "Sample Text Data",
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 26,
"contractCommitmentPenaltyChargeTypeName": "Sample Text Data",
"details": {
"periods": [
{
"identity": 79,
"contractCommitmentId": 81,
"periodOccurrences": 12,
"periodFrequency": 20,
"frequencyTypeId": 75,
"frequencyTypeName": "Sample Text Data",
"sortOrder": 14,
"isRemainderOfTerm": true
}
],
"services": [
{
"identity": 13,
"contractCommitmentId": 46,
"serviceId": 54,
"serviceName": "Sample Text Data"
}
],
"packageFrequencies": [
{
"identity": 89,
"contractCommitmentId": 28,
"packageFrequencyId": 22,
"packageFrequencyName": "Sample Text Data",
"packageId": 0,
"packageName": "Sample Text Data"
}
],
"usageClasses": [
{
"identity": 63,
"contractCommitmentId": 54,
"usageClassId": 18,
"usageClassName": "Sample Text Data"
}
]
}
}
]
}
} | |
| GET | Contract/Commitment/{id} |
| Retrieve an instance of the ContractCommitment object by its ID. | |
| {id} | Unique identifier for the ContractCommitment object. |
Retrieve an instance of the ContractCommitment object by its ID. GET Contract/Commitment/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"accountContractId": 12,
"accountContractName": "Sample Text Data",
"contractCommitmentTypeId": 25,
"contractCommitmentTypeName": "Sample Text Data",
"penaltyServiceId": 24,
"penaltyServiceName": "Sample Text Data",
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 22,
"contractCommitmentPenaltyChargeTypeName": "Sample Text Data"
}
} | |
| GET | Contract/Commitment/{id}/Detail |
| Retrieve deep detail of the ContractCommitment object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the ContractCommitment object. |
Retrieve deep detail of the ContractCommitment object by its ID. GET Contract/Commitment/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"accountContractId": 5,
"accountContractName": "Sample Text Data",
"contractCommitmentTypeId": 1,
"contractCommitmentTypeName": "Sample Text Data",
"penaltyServiceId": 8,
"penaltyServiceName": "Sample Text Data",
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 12,
"contractCommitmentPenaltyChargeTypeName": "Sample Text Data",
"details": {
"periods": [
{
"identity": 79,
"contractCommitmentId": 81,
"periodOccurrences": 12,
"periodFrequency": 20,
"frequencyTypeId": 75,
"frequencyTypeName": "Sample Text Data",
"sortOrder": 14,
"isRemainderOfTerm": true
}
],
"services": [
{
"identity": 13,
"contractCommitmentId": 46,
"serviceId": 54,
"serviceName": "Sample Text Data"
}
],
"packageFrequencies": [
{
"identity": 89,
"contractCommitmentId": 28,
"packageFrequencyId": 22,
"packageFrequencyName": "Sample Text Data",
"packageId": 0,
"packageName": "Sample Text Data"
}
],
"usageClasses": [
{
"identity": 63,
"contractCommitmentId": 54,
"usageClassId": 18,
"usageClassName": "Sample Text Data"
}
]
}
}
} | |
| PATCH | Contract/Commitment/{id} |
| Update or Add the ContractCommitment object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the ContractCommitment object. |
Update or Add the ContractCommitment object and optionally make changes to any child objects. PATCH Contract/Commitment/{id}
{
"details": {},
"contractCommitments": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"accountContractId": 24,
"contractCommitmentTypeId": 15,
"penaltyServiceId": 12,
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 4
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "contractCommitment",
"instance": {
"identity": 1,
"accountContractId": 14,
"accountContractName": "Sample Text Data",
"contractCommitmentTypeId": 4,
"contractCommitmentTypeName": "Sample Text Data",
"penaltyServiceId": 17,
"penaltyServiceName": "Sample Text Data",
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 21,
"contractCommitmentPenaltyChargeTypeName": "Sample Text Data"
}
}
]
}
} | |
| POST | Contract/Commitment/ |
| Create a new instance of the ContractCommitment object. | |
Create a new instance of the ContractCommitment object. POST Contract/Commitment/
{
"accountContractId": 23,
"contractCommitmentTypeId": 14,
"penaltyServiceId": 23,
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 7
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"accountContractId": 13,
"accountContractName": "Sample Text Data",
"contractCommitmentTypeId": 11,
"contractCommitmentTypeName": "Sample Text Data",
"penaltyServiceId": 25,
"penaltyServiceName": "Sample Text Data",
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 14,
"contractCommitmentPenaltyChargeTypeName": "Sample Text Data"
}
]
}
} | |
| PUT | Contract/Commitment/{id} |
| Update an existing instance of the ContractCommitment object. | |
Update an existing instance of the ContractCommitment object. PUT Contract/Commitment/{id}
{
"identity": 1,
"accountContractId": 7,
"contractCommitmentTypeId": 24,
"penaltyServiceId": 8,
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 4
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"accountContractId": 12,
"accountContractName": "Sample Text Data",
"contractCommitmentTypeId": 18,
"contractCommitmentTypeName": "Sample Text Data",
"penaltyServiceId": 4,
"penaltyServiceName": "Sample Text Data",
"penaltyDescription": "Minimum quantity commit.",
"includeChildAccounts": true,
"contractCommitmentPenaltyChargeTypeId": 15,
"contractCommitmentPenaltyChargeTypeName": "Sample Text Data"
}
]
}
} | |