Rents API Reference
API Reference/Rents

Rents

For authentication instructions, see API overview.

Endpoints

patch/api/v2/rents/payment/:id
patch/api/v2/rents/payment/:id/:term
patch/api/v2/rents/additionalinvoice/:id
get/api/v2/rents/tenant/:id
get/api/v2/rents/tenant/:id/:term
get/api/v2/rents/tenant/:id/:year/:month/:day
get/api/v2/rents/tenant/:id/:year/:month
get/api/v2/rents/:year/:month/:day
get/api/v2/rents/:year/:month
patch

Update rent payment

Update rent payment by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the lease

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/rents/payment/:id

Response

No response schema
patch

Update rent payment

Update rent payment by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the lease

  • termstring

    ID of the term

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/rents/payment/:id/:term

Response

No response schema
patch

Update rent additional invoice

Update rent additional invoice by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the lease

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/rents/additionalinvoice/:id

Response

No response schema
get

Retrieve rent

Returns a single ren, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the lease

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/rents/tenant/:id

Response

No response schema
get

Retrieve get tenant

Returns a single get tenan, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the lease

  • termstring

    ID of the term

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/rents/tenant/:id/:term

Response

No response schema
get

Retrieve get tenant rent by

Returns a single get tenant rent b, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the lease

  • yearstring

    Year of the lease

  • monthstring

    Month of the lease

  • daystring

    Day of the lease

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/rents/tenant/:id/:year/:month/:day

Response

No response schema
get

Retrieve get tenant rent by

Returns a single get tenant rent b, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the lease

  • yearstring

    Year of the lease

  • monthstring

    Month of the lease

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/rents/tenant/:id/:year/:month

Response

No response schema
get

Retrieve rent get by

Returns a single rent get b, which you can request by passing through an id in the url.

Path parameters

  • yearstring

    Year of the lease

  • monthstring

    Month of the lease

  • daystring

    Day of the lease

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/rents/:year/:month/:day

Response

No response schema
get

Retrieve rent get by

Returns a single rent get b, which you can request by passing through an id in the url.

Path parameters

  • yearstring

    Year of the lease

  • monthstring

    Month of the lease

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/rents/:year/:month

Response

No response schema