FairePlace Property Management API

Amendment Documents

Endpointhttps://api.faireplace.com/api

List amendment documents

GET

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/documents

Returns all documents attached to an amendment (drafts, signed copies, supporting documents).

List amendment documents › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

List amendment documents › Responses

List of documents

object[]

Document attached to an amendment

id

string · uuid · required

amendment_id

string · uuid · required

document_type

string · enum · required

Type of document

Enum values:

DRAFT

SIGNED_COPY

SUPPORTING_DOCUMENT

NOTICE

CALCULATION_DETAILS

LEGAL_NOTICE

Example: DRAFT

file_path

string · required

Path to the stored document (e.g., /api/media/serve/{media_id})

upload_date

string · date-time · required

is_validated

boolean · required

Whether the document has been validated

validation_date

string | null · date-time

validated_by

string | null · uuid

notes

string | null

GET/leases/{lease_id}/amendments/{amendment_id}/documents

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/documents

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "amendment_id": "00000000-0000-0000-0000-000000000000",
    "document_type": "DRAFT",
    "file_path": "file_path",
    "upload_date": "2024-08-25T15:00:00Z",
    "is_validated": true,
    "validation_date": "2024-08-25T15:00:00Z",
    "validated_by": "00000000-0000-0000-0000-000000000000",
    "notes": {}
  }
]

json

application/json

Attach a document to an amendment

POST

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/documents

Attach a document to an amendment › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

Attach a document to an amendment › Request Body

document_type

string · enum · required

Enum values:

DRAFT

SIGNED_COPY

SUPPORTING_DOCUMENT

NOTICE

CALCULATION_DETAILS

LEGAL_NOTICE

file_path

string · maxLength: 500 · required

notes

string | null · maxLength: 1000

Attach a document to an amendment › Responses

Document created

Document attached to an amendment

id

string · uuid · required

amendment_id

string · uuid · required

document_type

string · enum · required

Type of document

Enum values:

DRAFT

SIGNED_COPY

SUPPORTING_DOCUMENT

NOTICE

CALCULATION_DETAILS

LEGAL_NOTICE

Example: DRAFT

file_path

string · required

Path to the stored document (e.g., /api/media/serve/{media_id})

upload_date

string · date-time · required

is_validated

boolean · required

Whether the document has been validated

validation_date

string | null · date-time

validated_by

string | null · uuid

notes

string | null

POST/leases/{lease_id}/amendments/{amendment_id}/documents

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_type": "DRAFT",
  "file_path": "file_path",
  "notes": {}
}
'

shell

Example Request Body

{
  "document_type": "DRAFT",
  "file_path": "file_path",
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "amendment_id": "00000000-0000-0000-0000-000000000000",
  "document_type": "DRAFT",
  "file_path": "file_path",
  "upload_date": "2024-08-25T15:00:00Z",
  "is_validated": true,
  "validation_date": "2024-08-25T15:00:00Z",
  "validated_by": "00000000-0000-0000-0000-000000000000",
  "notes": {}
}

json

application/json

Get a specific document

GET

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}

Get a specific document › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

document_id

string · uuid · required

Get a specific document › Responses

Document details

Document attached to an amendment

id

string · uuid · required

amendment_id

string · uuid · required

document_type

string · enum · required

Type of document

Enum values:

DRAFT

SIGNED_COPY

SUPPORTING_DOCUMENT

NOTICE

CALCULATION_DETAILS

LEGAL_NOTICE

Example: DRAFT

file_path

string · required

Path to the stored document (e.g., /api/media/serve/{media_id})

upload_date

string · date-time · required

is_validated

boolean · required

Whether the document has been validated

validation_date

string | null · date-time

validated_by

string | null · uuid

notes

string | null

GET/leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/documents/:document_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "amendment_id": "00000000-0000-0000-0000-000000000000",
  "document_type": "DRAFT",
  "file_path": "file_path",
  "upload_date": "2024-08-25T15:00:00Z",
  "is_validated": true,
  "validation_date": "2024-08-25T15:00:00Z",
  "validated_by": "00000000-0000-0000-0000-000000000000",
  "notes": {}
}

json

application/json

Update an amendment document

PUT

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}

Update an amendment document › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

document_id

string · uuid · required

Update an amendment document › Request Body

document_type

string · enum · required

Enum values:

DRAFT

SIGNED_COPY

SUPPORTING_DOCUMENT

NOTICE

CALCULATION_DETAILS

LEGAL_NOTICE

file_path

string · maxLength: 500 · required

notes

string | null · maxLength: 1000

Update an amendment document › Responses

Document updated

Document attached to an amendment

id

string · uuid · required

amendment_id

string · uuid · required

document_type

string · enum · required

Type of document

Enum values:

DRAFT

SIGNED_COPY

SUPPORTING_DOCUMENT

NOTICE

CALCULATION_DETAILS

LEGAL_NOTICE

Example: DRAFT

file_path

string · required

Path to the stored document (e.g., /api/media/serve/{media_id})

upload_date

string · date-time · required

is_validated

boolean · required

Whether the document has been validated

validation_date

string | null · date-time

validated_by

string | null · uuid

notes

string | null

PUT/leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/documents/:document_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_type": "DRAFT",
  "file_path": "file_path",
  "notes": {}
}
'

shell

Example Request Body

{
  "document_type": "DRAFT",
  "file_path": "file_path",
  "notes": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "amendment_id": "00000000-0000-0000-0000-000000000000",
  "document_type": "DRAFT",
  "file_path": "file_path",
  "upload_date": "2024-08-25T15:00:00Z",
  "is_validated": true,
  "validation_date": "2024-08-25T15:00:00Z",
  "validated_by": "00000000-0000-0000-0000-000000000000",
  "notes": {}
}

json

application/json

Delete an amendment document

DELETE

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}

Delete an amendment document › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

document_id

string · uuid · required

Delete an amendment document › Responses

Document deleted

No data returned

DELETE/leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/documents/:document_id

shell

Example Responses

No example specified for this content type

Validate an amendment document

PUT

https://api.faireplace.com/api

/leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}/validate

Mark a document as validated by a specific user.

Validate an amendment document › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

document_id

string · uuid · required

Validate an amendment document › Request Body

validated_by

string · uuid · required

ID of the user validating the document

Validate an amendment document › Responses

Document validated

Document attached to an amendment

id

string · uuid · required

amendment_id

string · uuid · required

document_type

string · enum · required

Type of document

Enum values:

DRAFT

SIGNED_COPY

SUPPORTING_DOCUMENT

NOTICE

CALCULATION_DETAILS

LEGAL_NOTICE

Example: DRAFT

file_path

string · required

Path to the stored document (e.g., /api/media/serve/{media_id})

upload_date

string · date-time · required

is_validated

boolean · required

Whether the document has been validated

validation_date

string | null · date-time

validated_by

string | null · uuid

notes

string | null

PUT/leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}/validate

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/documents/:document_id/validate \
  --header 'Content-Type: application/json' \
  --data '
{
  "validated_by": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "validated_by": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "amendment_id": "00000000-0000-0000-0000-000000000000",
  "document_type": "DRAFT",
  "file_path": "file_path",
  "upload_date": "2024-08-25T15:00:00Z",
  "is_validated": true,
  "validation_date": "2024-08-25T15:00:00Z",
  "validated_by": "00000000-0000-0000-0000-000000000000",
  "notes": {}
}

json

application/json

Amendment Duration Details Amendment History