FairePlace Property Management API

PDF

Endpointhttps://api.faireplace.com/api

Generate a lease PDF

POST

https://api.faireplace.com/api

/leases/{lease_id}/pdf

Generates a PDF document from a lease template with the provided data. Returns the PDF directly as binary with performance headers.

Generate a lease PDF › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

Generate a lease PDF › Request Body

Request to generate a lease PDF

template_id

string · uuid · required

Document template ID to use

Example: 550e8400-e29b-41d4-a716-446655440000

template_type

string · enum · required

Template type (LeaseContract, Amendment, InventoryReport, etc.)

Enum values:

LeaseContract

Amendment

InventoryReport

RentReceipt

NoticeToVacate

OtherDocument

Example: LeaseContract

object · required

Data to insert into the template (JSON format)

Example: {"tenant_name":"Jean Dupont","property_address":"123 Rue de la Paix, 75001 Paris","rent_amount":850}

object

PDF formatting options

Generate a lease PDF › Responses

PDF generated successfully

string

POST/leases/{lease_id}/pdf

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/pdf \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_id": "550e8400-e29b-41d4-a716-446655440000",
  "template_type": "LeaseContract",
  "data": {
    "tenant_name": "Jean Dupont",
    "property_address": "123 Rue de la Paix, 75001 Paris",
    "rent_amount": 850
  },
  "format_options": {
    "paper_size": "A4",
    "margins": {
      "top": 25,
      "right": 25,
      "bottom": 25,
      "left": 25
    },
    "font_size": 12,
    "add_metadata": true,
    "custom_variables": {},
    "pdf_standard": "PDF/A-1b",
    "page_ranges": [
      "1-5",
      "10"
    ],
    "compress": false,
    "add_form_fields": false,
    "custom_form_fields": {}
  }
}
'

shell

Example Request Body

{
  "template_id": "550e8400-e29b-41d4-a716-446655440000",
  "template_type": "LeaseContract",
  "data": {
    "tenant_name": "Jean Dupont",
    "property_address": "123 Rue de la Paix, 75001 Paris",
    "rent_amount": 850
  },
  "format_options": {
    "paper_size": "A4",
    "margins": {
      "top": 25,
      "right": 25,
      "bottom": 25,
      "left": 25
    },
    "font_size": 12,
    "add_metadata": true,
    "custom_variables": {},
    "pdf_standard": "PDF/A-1b",
    "page_ranges": [
      "1-5",
      "10"
    ],
    "compress": false,
    "add_form_fields": false,
    "custom_form_fields": {}
  }
}

json

Example Responses

string

plain

application/pdf

List lease PDFs

GET

https://api.faireplace.com/api

/leases/{lease_id}/pdfs

Retrieves the list of all generated PDFs for a specific lease

List lease PDFs › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

List lease PDFs › Responses

PDF list retrieved successfully

object[]

Generated PDF metadata

id

string · uuid · required

Unique identifier of the generated PDF

Example: 550e8400-e29b-41d4-a716-446655440000

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440001

template_id

string · uuid · required

Template ID used

Example: 550e8400-e29b-41d4-a716-446655440002

template_type

string · enum · required

Template type used

Enum values:

LeaseContract

Amendment

InventoryReport

RentReceipt

NoticeToVacate

OtherDocument

Example: LeaseContract

file_path

string · required

Path or URL of the generated PDF file

Example: https://storage.example.com/pdfs/lease_contract_123.pdf

file_size

integer · int64 · min: 0 · required

File size in bytes

Example: 524288

creation_timestamp

string · date-time · required

PDF creation date and time

Example: 2024-01-15T10:30:00Z

object | null

Custom variables used during generation

GET/leases/{lease_id}/pdfs

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/pdfs

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lease_id": "550e8400-e29b-41d4-a716-446655440001",
    "template_id": "550e8400-e29b-41d4-a716-446655440002",
    "template_type": "LeaseContract",
    "file_path": "https://storage.example.com/pdfs/lease_contract_123.pdf",
    "file_size": 524288,
    "creation_timestamp": "2024-01-15T10:30:00Z",
    "custom_variables": {}
  }
]

json

application/json

Download a lease PDF

GET

https://api.faireplace.com/api

/leases/pdf/{pdf_id}

Downloads a generated PDF document for a lease

Download a lease PDF › path Parameters

pdf_id

string · uuid · required

Unique generated PDF ID

Example: 550e8400-e29b-41d4-a716-446655440000

Download a lease PDF › Responses

PDF downloaded successfully

string

GET/leases/pdf/{pdf_id}

curl --request GET \
  --url https://api.faireplace.com/api/leases/pdf/:pdf_id

shell

Example Responses

string

plain

application/pdf

Delete a lease PDF

DELETE

https://api.faireplace.com/api

/leases/pdf/{pdf_id}

Deletes a generated PDF document for a lease

Delete a lease PDF › path Parameters

pdf_id

string · uuid · required

Unique generated PDF ID

Example: 550e8400-e29b-41d4-a716-446655440000

Delete a lease PDF › Responses

PDF deleted successfully

message

string

DELETE/leases/pdf/{pdf_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/pdf/:pdf_id

shell

Example Responses

{
  "message": "PDF deleted successfully"
}

json

application/json

PDF cache statistics

GET

https://api.faireplace.com/api

/leases/cache/stats

Retrieves PDF generation cache statistics

PDF cache statistics › Responses

Cache statistics retrieved successfully

hit_count

integer

Number of cache hits

Example: 42

miss_count

integer

Number of cache misses

Example: 8

size

integer

Number of cache entries

Example: 15

GET/leases/cache/stats

curl --request GET \
  --url https://api.faireplace.com/api/leases/cache/stats

shell

Example Responses

{
  "hit_count": 42,
  "miss_count": 8,
  "size": 15
}

json

application/json

Clear PDF cache

POST

https://api.faireplace.com/api

/leases/cache/clear

Clears the PDF generation cache

Clear PDF cache › Responses

Cache cleared successfully

message

string

cleared_entries

integer

Number of entries removed from cache

Example: 15

POST/leases/cache/clear

curl --request POST \
  --url https://api.faireplace.com/api/leases/cache/clear

shell

Example Responses

{
  "message": "PDF cache cleared successfully",
  "cleared_entries": 15
}

json

application/json

Documents Payments

FairePlace Property Management API

PDF

Endpointhttps://api.faireplace.com/api

Generate a lease PDF

POST

https://api.faireplace.com/api

/leases/{lease_id}/pdf

Generates a PDF document from a lease template with the provided data. Returns the PDF directly as binary with performance headers.

Generate a lease PDF › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

Generate a lease PDF › Request Body

Request to generate a lease PDF

template_id

string · uuid · required

Document template ID to use

Example: 550e8400-e29b-41d4-a716-446655440000

template_type

string · enum · required

Template type (LeaseContract, Amendment, InventoryReport, etc.)

Enum values:

LeaseContract

Amendment

InventoryReport

RentReceipt

NoticeToVacate

OtherDocument

Example: LeaseContract

object · required

Data to insert into the template (JSON format)

Example: {"tenant_name":"Jean Dupont","property_address":"123 Rue de la Paix, 75001 Paris","rent_amount":850}

object

PDF formatting options

Generate a lease PDF › Responses

PDF generated successfully

string

POST/leases/{lease_id}/pdf

curl --request POST \
  --url https://api.faireplace.com/api/leases/:lease_id/pdf \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_id": "550e8400-e29b-41d4-a716-446655440000",
  "template_type": "LeaseContract",
  "data": {
    "tenant_name": "Jean Dupont",
    "property_address": "123 Rue de la Paix, 75001 Paris",
    "rent_amount": 850
  },
  "format_options": {
    "paper_size": "A4",
    "margins": {
      "top": 25,
      "right": 25,
      "bottom": 25,
      "left": 25
    },
    "font_size": 12,
    "add_metadata": true,
    "custom_variables": {},
    "pdf_standard": "PDF/A-1b",
    "page_ranges": [
      "1-5",
      "10"
    ],
    "compress": false,
    "add_form_fields": false,
    "custom_form_fields": {}
  }
}
'

shell

Example Request Body

{
  "template_id": "550e8400-e29b-41d4-a716-446655440000",
  "template_type": "LeaseContract",
  "data": {
    "tenant_name": "Jean Dupont",
    "property_address": "123 Rue de la Paix, 75001 Paris",
    "rent_amount": 850
  },
  "format_options": {
    "paper_size": "A4",
    "margins": {
      "top": 25,
      "right": 25,
      "bottom": 25,
      "left": 25
    },
    "font_size": 12,
    "add_metadata": true,
    "custom_variables": {},
    "pdf_standard": "PDF/A-1b",
    "page_ranges": [
      "1-5",
      "10"
    ],
    "compress": false,
    "add_form_fields": false,
    "custom_form_fields": {}
  }
}

json

Example Responses

string

plain

application/pdf

List lease PDFs

GET

https://api.faireplace.com/api

/leases/{lease_id}/pdfs

Retrieves the list of all generated PDFs for a specific lease

List lease PDFs › path Parameters

lease_id

string · uuid · required

Unique lease ID

Example: 550e8400-e29b-41d4-a716-446655440000

List lease PDFs › Responses

PDF list retrieved successfully

object[]

Generated PDF metadata

id

string · uuid · required

Unique identifier of the generated PDF

Example: 550e8400-e29b-41d4-a716-446655440000

lease_id

string · uuid · required

Associated lease ID

Example: 550e8400-e29b-41d4-a716-446655440001

template_id

string · uuid · required

Template ID used

Example: 550e8400-e29b-41d4-a716-446655440002

template_type

string · enum · required

Template type used

Enum values:

LeaseContract

Amendment

InventoryReport

RentReceipt

NoticeToVacate

OtherDocument

Example: LeaseContract

file_path

string · required

Path or URL of the generated PDF file

Example: https://storage.example.com/pdfs/lease_contract_123.pdf

file_size

integer · int64 · min: 0 · required

File size in bytes

Example: 524288

creation_timestamp

string · date-time · required

PDF creation date and time

Example: 2024-01-15T10:30:00Z

object | null

Custom variables used during generation

GET/leases/{lease_id}/pdfs

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/pdfs

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lease_id": "550e8400-e29b-41d4-a716-446655440001",
    "template_id": "550e8400-e29b-41d4-a716-446655440002",
    "template_type": "LeaseContract",
    "file_path": "https://storage.example.com/pdfs/lease_contract_123.pdf",
    "file_size": 524288,
    "creation_timestamp": "2024-01-15T10:30:00Z",
    "custom_variables": {}
  }
]

json

application/json

Download a lease PDF

GET

https://api.faireplace.com/api

/leases/pdf/{pdf_id}

Downloads a generated PDF document for a lease

Download a lease PDF › path Parameters

pdf_id

string · uuid · required

Unique generated PDF ID

Example: 550e8400-e29b-41d4-a716-446655440000

Download a lease PDF › Responses

PDF downloaded successfully

string

GET/leases/pdf/{pdf_id}

curl --request GET \
  --url https://api.faireplace.com/api/leases/pdf/:pdf_id

shell

Example Responses

string

plain

application/pdf

Delete a lease PDF

DELETE

https://api.faireplace.com/api

/leases/pdf/{pdf_id}

Deletes a generated PDF document for a lease

Delete a lease PDF › path Parameters

pdf_id

string · uuid · required

Unique generated PDF ID

Example: 550e8400-e29b-41d4-a716-446655440000

Delete a lease PDF › Responses

PDF deleted successfully

message

string

DELETE/leases/pdf/{pdf_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/pdf/:pdf_id

shell

Example Responses

{
  "message": "PDF deleted successfully"
}

json

application/json

PDF cache statistics

GET

https://api.faireplace.com/api

/leases/cache/stats

Retrieves PDF generation cache statistics

PDF cache statistics › Responses

Cache statistics retrieved successfully

hit_count

integer

Number of cache hits

Example: 42

miss_count

integer

Number of cache misses

Example: 8

size

integer

Number of cache entries

Example: 15

GET/leases/cache/stats

curl --request GET \
  --url https://api.faireplace.com/api/leases/cache/stats

shell

Example Responses

{
  "hit_count": 42,
  "miss_count": 8,
  "size": 15
}

json

application/json

Clear PDF cache

POST

https://api.faireplace.com/api

/leases/cache/clear

Clears the PDF generation cache

Clear PDF cache › Responses

Cache cleared successfully

message

string

cleared_entries

integer

Number of entries removed from cache

Example: 15

POST/leases/cache/clear

curl --request POST \
  --url https://api.faireplace.com/api/leases/cache/clear

shell

Example Responses

{
  "message": "PDF cache cleared successfully",
  "cleared_entries": 15
}

json

application/json

Documents Payments