AmendmentsGetResultResponse

Paginated list of amendments for an organization

data object[]required

Page of amendments, ordered by ascending internal id

Array [

organizationCodestringrequired

Organization code that owns this amendment

Default value:

Example: ORGA

codestringrequired

Amendment business code (natural ID inside the organization)

Default value:

Example: A1

contractCodestringrequired

Business code of the contract this amendment applies to

Default value:

Example: L1

effectiveDatedaterequired

Date on which the amendment takes effect

Default value:

Example: 2024-01-01

amendmentTypestringrequired

Type of the amendment (see AmendmentType enum). Unknown values from upstream are mapped to UNKNOWN.

Default value:

Example: INFORMATION

namestring | nullnullable

Human-readable label for the amendment

Default value:

Example: Renewal 2024

rentEvolutiondoublenullable

Variation of rent introduced by the amendment, when applicable

Default value:

Example: 12.34

areaEvolutiondoublenullable

Variation of area introduced by the amendment, when applicable

Default value:

Example: 5.5

signatureDatedatenullable

Date on which the amendment was signed

Default value:

Example: 2023-12-15

integrationDatedate-timerequired

Server-side timestamp recorded when the amendment was integrated

Default value:

Example: 2024-01-02T08:30:00

]

paginate objectrequired

Pagination envelope; cursor is null when iteration is complete

sizeint32

Number of results

Possible values: <= 2000

Default value: 50

cursorstring | nullnullable

A marker indicating the position in a dataset, used to determine where to continue fetching results in paginated data

Default value: 0

AmendmentsGetResultResponse

{
  "data": [
    {
      "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"
    }
  ],
  "paginate": {
    "size": 50,
    "cursor": "0"
  }
}