Update or Add the ContractCommitment object and optionally make changes to any child objects.

patch

https://{server_address}/ResourceServer/api/v10/Contract/Commitment/{id}

Path Params

integer

required

Unique identifier for the ContractCommitment object.

Body Params

This entity is the top level container for a Contract Commitment that is associated with an Account Contract.

accountContractId

number

Unique identifier for the associated AccountContract object.

accountContractName

string

The name of the object associated with the accountContractId property.

contractCommitmentTypeId

number

Unique identifier for the associated ContractCommitmentType object.

contractCommitmentTypeName

string

The name of the object associated with the contractCommitmentTypeId property.

penaltyServiceId

number

Unique identifier for the associated Service object.

penaltyServiceName

string

The name of the object associated with the penaltyServiceId property.

penaltyDescription

string

includeChildAccounts

boolean

contractCommitmentPenaltyChargeTypeId

number

Unique identifier for the associated ContractCommitmentPenaltyChargeType object.

contractCommitmentPenaltyChargeTypeName

string

The name of the object associated with the contractCommitmentPenaltyChargeTypeId property.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Patch 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.