ProposalContractSchedules
Update ProposalContractSchedule
Update an existing ProposalContractSchedule record.
PUT
Update ProposalContractSchedule
Updates an existing ProposalContractSchedule record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the ProposalContractSchedule-Edit role.Request Body
Required Fields
integer
required
The Id of the ProposalContractSchedule record to update.
integer
required
ID of the quoted contract this price change belongs to; required, and the issuing location of that contract’s proposal owns this record..
string
required
Date the new price takes effect; required, and each price change on the same quoted contract needs its own date..
Optional Fields
string
Free-text note explaining the price change; it is carried onto the customer contract’s schedule on acceptance..
number
New per-unit price that takes effect on ApplyOn, in the issuing location’s currency..
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the proposalcontractschedule was updated successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response