Leases

Change amendment status

Change the status of an amendment (DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, ACTIVE, EXPIRED)

put/leases/{lease_id}/amendments/{amendment_id}/status

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/amendments/{amendment_id}/status
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

amendment_idstring uuid required

Amendment ID

Request body

status'DRAFT' | 'PENDING_SIGNATURE' | 'SIGNED' | 'ACTIVE' | 'CANCELLED' | 'REJECTED' | 'EXPIRED' required

Amendment status

reasonstring nullable

Reason for the status change

Example request

{
  "status": "DRAFT"
}

Response

Amendment status updated successfully

idstring uuid required

Unique identifier of the amendment

lease_idstring uuid required

Lease ID

amendment_numberstring required

Amendment number

amendment_type'RENT_MODIFICATION' | 'DURATION_MODIFICATION' | 'TENANT_MODIFICATION' | 'GUARANTOR_MODIFICATION' | 'CHARGE_MODIFICATION' | 'CONDITION_MODIFICATION' | 'EARLY_TERMINATION' | 'RENEWAL' | 'OTHER' required

Amendment type

status'DRAFT' | 'PENDING_SIGNATURE' | 'SIGNED' | 'ACTIVE' | 'CANCELLED' | 'REJECTED' | 'EXPIRED' required

Amendment status

effective_datestring date required

Effective date of the amendment

signature_datestring date nullable

Amendment signature date

validation_statusstring nullable

Validation status (VARCHAR in DB)

validation_datestring date-time nullable

Validation date

validated_bystring uuid nullable

ID of the user who validated

legal_referencestring nullable

Legal reference

descriptionstring nullable

Description of the amendment

special_conditionsstring nullable

Special conditions of the amendment

notesstring nullable

Internal notes

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

created_bystring uuid required

ID of the creator user

updated_bystring uuid required

ID of the last modifier user

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_id": "550e8400-e29b-41d4-a716-446655440001",
  "amendment_number": "AVE-001",
  "amendment_type": "RENT_MODIFICATION",
  "status": "DRAFT",
  "effective_date": "2024-06-01",
  "signature_date": "2024-05-15",
  "description": "Rent increase following IRL revision",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.