Create a new customer contract

post/customer-contracts
SecuritybearerAuth
Request
Request Body schema: application/json

New customer contract

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

Generated contract Name

customerId
required
integer <int64>

Customer identifier

siteId
integer <int64>

Site identifier to restrict contract to a particular site (optional)

contractProfileId
required
integer <int64>

Contract profile for this customer contract

startDate
required
string <date>

Effective start date of the customer contract

endDate
string <date>

Date when this customer contract ends based on start date and contract profile term

rolloverContractProfileId
integer <int64>

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

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",
  • "customerId": 0,
  • "siteId": 0,
  • "contractProfileId": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "rolloverContractProfileId": 0,
  • "renewalAlertDays": 28,
  • "noticePeriodDays": 2147483647
}
Response samples
application/json
{
  • "id": 1,
  • "name": "string",
  • "customerId": 0,
  • "siteId": 0,
  • "contractProfileId": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "rolloverContractProfileId": 0,
  • "renewalAlertDays": 28,
  • "noticePeriodDays": 2147483647,
  • "previousCustomerContractId": 0,
  • "renewedCustomerContractId": 0
}