Contract / Commitment

What can you do with ContractCommitment?


Properties

Property Details
id
"id": 22
Type: Number
This is the unique numeric identifier for the ContractCommitment
accountContractId
"accountContractId": 10
Type: Number
Unique identifier for the associated AccountContract object.
contractCommitmentTypeId
"contractCommitmentTypeId": 819
Type: Number
Unique identifier for the associated ContractCommitmentType object.
penaltyServiceId
"penaltyServiceId": 699
Type: Number
Unique identifier for the associated Service object.
penaltyDescription
"penaltyDescription": "Hello World"
Type: String
packageFrequencyId
"packageFrequencyId": 185
Type: Number
Unique identifier for the associated PackageFrequency object.
serviceId
"serviceId": 829
Type: Number
Unique identifier for the associated Service object.
usageClassId
"usageClassId": 845
Type: Number
Unique identifier for the associated UsageClass object.


Update Request Filters

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:

  • identity
  • accountContractId
  • contractCommitmentTypeId
  • penaltyServiceId
  • penaltyDescription
  • packageFrequencyId
  • serviceId
  • usageClassId

Patch Types

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 or nested within the envelope of a DataFlow. 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:


End Points

DELETEapi/v1/Contract/Commitment/{id:int}
Delete an instance of the ContractCommitment object.
GETapi/v1/Contract/Commitment
Retrieve all of the ContractCommitment objects.
GETapi/v1/Contract/Commitment/Metadata
Retrieve all of the meta data details of the ContractCommitment object.
GETapi/v1/Contract/Commitment/Metadata/{option}
Retrieve all the meta data details of the ContractCommitment object based on provided options.
{option}Metadata options for the ContractCommitment object.
GETapi/v1/Contract/Commitment/Paged
Retreive all of the ContractCommitment objects in a paged fashion.
GETapi/v1/Contract/Commitment/Paged/Detail
Retreive all of the ContractCommitment objects in a paged fashion with all object details.
GETapi/v1/Contract/Commitment/{id:int}
Retrieve an instance of the ContractCommitment object by it's ID.
{id:int}Unique identifier for the ContractCommitment object.
GETapi/v1/Contract/Commitment/{id:int}/Detail
Retreive all of the Detail objects for the specified ContractCommitment.
{id:int}Unique identifier for the ContractCommitment object.
PATCHapi/v1/Contract/Commitment/{id:int}
Update the ContractCommitment object and optionally make changes to any child objects.
POSTapi/v1/Contract/Commitment
Create a new instance of the ContractCommitment object.
PUTapi/v1/Contract/Commitment/{id:int}
Update an existing instance of the ContractCommitment object.