Update contract data partially
- 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Update contract data partially
- Updated on 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/contracts/{id}/
Operation is used to update specific fields in existing contract data. Available from product version 3.2.24.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of contract to update
Body parameters
Contract attributes and values to be updated
object
agreement
string
Contract Identifier
antenna
integer
Contract antenna
billing
integer
Contact Billing id
billingDay
integer
Contract billing day
billingPeriod
integer
Contract billing period
billingReference
string
Contract billing reference
cableUsage
string
Contract billing cable usage
comment
string
Contract comments
contractStatus
integer
Contract Status id
contractType
integer
Contract Type id
lessee
integer
Customer Lesee id
lessor
integer
Customer Lessor id
parentContract
integer
Parent Contract id
rent
number (float) Required
Contract rent. Normally a required attribute, can be set as not required on request.
rentBeginDate
string (date-time)
The date begin to rent
rentEndDate
string (date-time)
The date end of the rent
rent_2
number (float)
Contract rent 2
rent_3
number (float)
Contract rent 3
reserveBeginDate
string (date-time)
The date begin to reserved
reserveEndDate
string (date-time)
The date end of the reservation
termOfNotice
integer
Contract term of notice
Responses
200
Object was updated successfully
object
agreement
string
Contract Identifier
antenna
integer
Contract antenna
billing
integer
Contact Billing id
billingDay
integer
Contract billing day
billingPeriod
integer
Contract billing period
billingReference
string
Contract billing reference
cableUsage
string
Contract billing cable usage
comment
string
Contract comments
contractStatus
integer
Contract Status id
contractType
integer
Contract Type id
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
id
integer
Primary key
lessee
integer
Customer Lesee id
lessor
integer
Customer Lessor id
parentContract
integer
Parent Contract id
rent
number (float)
Contract rent. Normally a required attribute, can be set as not required on request.
rentBeginDate
string (date-time)
The date begin to rent
rentEndDate
string (date-time)
The date end of the rent
rent_2
number (float)
Contract rent 2
rent_3
number (float)
Contract rent 3
reserveBeginDate
string (date-time)
The date begin to reserved
reserveEndDate
string (date-time)
The date end of the reservation
termOfNotice
integer
Contract term of notice
updatedBy
string
Last updated
updatedTs
string (date-time)
Last update date time
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
404
Object was not found
{
"details": "Not found."
}object
details
string
Detailed description of error
Was this article helpful?
