TAG LINE
SMALL TITLE

Contract / Termination / PeriodCharge

(API Version v1)


What can you do with ContractTerminationPeriodCharge?


Properties

Property Details
id
"id": 17
Type: Number
This is the unique numeric identifier for the ContractTerminationPeriodCharge
contractTerminationId
"contractTerminationId": 15
Type: Number
Unique identifier for the associated ContractTermination object.
isRemainderOfTerm
"isRemainderOfTerm": true
Type: Boolean
frequency
"frequency": 10
Type: Number
frequencyTypeId
"frequencyTypeId": 24
Type: Number
Unique identifier for the associated FrequencyType object.
flatFee
"flatFee": "Hello World"
Type: String
percentOfRemainder
"percentOfRemainder": "Hello World"
Type: String
sortOrder
"sortOrder": 18
Type: Number


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
  • contractTerminationId
  • isRemainderOfTerm
  • frequency
  • frequencyTypeId
  • flatFee
  • percentOfRemainder
  • sortOrder

DataFlow PATCH objects:


End Points

GETapi/v1/Contract/Termination/PeriodCharge
Retrieve all of the ContractTerminationPeriodCharge objects.
GETapi/v1/Contract/Termination/PeriodCharge/Paged
Retreive all of the ContractTerminationPeriodCharge objects in a paged fashion.
GETapi/v1/Contract/Termination/PeriodCharge/{id:int}
Retrieve an instance of the ContractTerminationPeriodCharge object by it's ID.
{id:int}Unique identifier for the ContractTerminationPeriodCharge object.