Contract / Commitment / Period

What can you do with ContractCommitmentPeriod?


Properties

Property Details
id
"id": 958
Type: Number
This is the unique numeric identifier for the ContractCommitmentPeriod
contractCommitmentId
"contractCommitmentId": 524
Type: Number
Unique identifier for the associated ContractCommitment object.
periodOccurrences
"periodOccurrences": 620
Type: Number
periodFrequency
"periodFrequency": 158
Type: Number
frequencyTypeId
"frequencyTypeId": 259
Type: Number
Unique identifier for the associated FrequencyType object.
sortOrder
"sortOrder": 700
Type: Number
isRemainderOfTerm
"isRemainderOfTerm": true
Type: Boolean


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:

  • contractCommitmentId
  • periodOccurrences
  • periodFrequency
  • frequencyTypeId
  • sortOrder
  • isRemainderOfTerm

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 ContractCommitmentPeriod object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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