Create a new contract profile

post/contract-profiles
SecuritybearerAuth
Request
Request Body schema: application/json

New contract profile

name
required
string [ 1 .. 100 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Contract profile Name

contractOwnerId
required
integer <int32>

Contract Owner Identifier

contractTerm
required
integer <int32>

Contract term in months

earlyTerminationFixedCharge
required
number

Early termination fixed charge (in major currency)

earlyTerminationPercentageCharge
required
integer <int32> [ 0 .. 1000 ]

Early termination charge as a percentage

rolloverContractProfileId
integer <int64>

Once term of this contract profile ends, contract using this profile will auto-renew as this contract profile

renewalAlertDays
integer <int32> [ 0 .. 28 ]

Renewal alert will be given this many days before the contract ends

noticePeriodDays
integer <int32> [ 0 .. 2147483647 ]

Notice period alert will be given this many days before the contract ends

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Request samples
application/json
{
  • "name": "string",
  • "contractOwnerId": 0,
  • "contractTerm": 0,
  • "earlyTerminationFixedCharge": 0,
  • "earlyTerminationPercentageCharge": 1000,
  • "rolloverContractProfileId": 0,
  • "renewalAlertDays": 28,
  • "noticePeriodDays": 2147483647
}
Response samples
application/json
{
  • "id": 1,
  • "name": "string",
  • "contractOwnerId": 0,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "contractTerm": 0,
  • "earlyTerminationFixedCharge": 0,
  • "earlyTerminationPercentageCharge": 1000,
  • "rolloverContractProfileId": 0,
  • "renewalAlertDays": 28,
  • "noticePeriodDays": 2147483647,
  • "supersededByContractProfileId": 0
}