AmendmentView
Public view of an amendment exposed by the listing API
organizationCodestringrequired
Organization code that owns this amendment
Default value:
Example:
ORGAcodestringrequired
Amendment business code (natural ID inside the organization)
Default value:
Example:
A1contractCodestringrequired
Business code of the contract this amendment applies to
Default value:
Example:
L1effectiveDatedaterequired
Date on which the amendment takes effect
Default value:
Example:
2024-01-01amendmentTypestringrequired
Type of the amendment (see AmendmentType enum). Unknown values from upstream are mapped to UNKNOWN.
Default value:
Example:
INFORMATIONnamestring | nullnullable
Human-readable label for the amendment
Default value:
Example:
Renewal 2024rentEvolutiondoublenullable
Variation of rent introduced by the amendment, when applicable
Default value:
Example:
12.34areaEvolutiondoublenullable
Variation of area introduced by the amendment, when applicable
Default value:
Example:
5.5signatureDatedatenullable
Date on which the amendment was signed
Default value:
Example:
2023-12-15integrationDatedate-timerequired
Server-side timestamp recorded when the amendment was integrated
Default value:
Example:
2024-01-02T08:30:00AmendmentView
{
"organizationCode": "ORGA",
"code": "A1",
"contractCode": "L1",
"effectiveDate": "2024-01-01",
"amendmentType": "INFORMATION",
"name": "Renewal 2024",
"rentEvolution": 12.34,
"areaEvolution": 5.5,
"signatureDate": "2023-12-15",
"integrationDate": "2024-01-02T08:30:00"
}