Pronajímatelé (Rents)

Tato dokumentace popisuje kolekci Pronajímatelů (Rents) v backendu Rentall.cz. Veškerá komunikace probíhá ve formátu JSON.

Základní URL: https://rentall.cz
Základní cesta: /api/rents

Poznámky k této dokumentaci:

Autentizace a oprávnění jsou specifické pro váš projekt. Chraňte endpointy dle potřeby.
ID jsou řetězce (např. 684dcbb7a60636d5a2618584). V příkladech používáme konkrétní ID pro srozumitelnost.

Endpointy

Výpis pronajímatelů — GET /api/rents
Vytvoření pronajímatele — POST /api/rents
Detail pronajímatele podle ID — GET /api/rents/:id
Aktualizace pronajímatele — PATCH /api/rents/:id
Smazání pronajímatele — DELETE /api/rents/:id

Související:

Depending on your setup, other methods like POST, PATCH, and DELETE may be available.

Path parameters

:id — rent ID string. Example: 684dcbb7a60636d5a2618584

Rent object (schema summary)

Common fields you will see in responses:

id — unique rent identifier
createdAt, updatedAt — ISO timestamps
basic — rent owner/company info
- rentalName, rentalContactPerson, rentalPhone, rentalEmail, rentalIco, rentalDic, rentalStyle, etc.
invoices — invoices listing
terms — array of terms objects (title, content as HTML, id)
products — products owned by this rent
- productsList.docs — array of product IDs or objects
settings, legacy — additional metadata
rentNameSystem — display name used in the system
email — contact email
sessions — array (session metadata if present)

Example rent (trimmed)


{
  "id": "684dcbb7a60636d5a2618584",
  "createdAt": "2025-06-14T19:21:27.434Z",
  "updatedAt": "2025-06-14T19:35:26.433Z",
  "basic": {
    "rentalName": "Example Rentals s.r.o.",
    "rentalContactPerson": "John Doe",
    "rentalPhone": "+420000000000",
    "rentalEmail": "info@rentall.cz",
    "rentalIco": "00000000",
    "rentalDic": null,
    "rentalMembership": "none",
    "rentalMembershipPayedDate": null,
    "rentalRegisterNote": null,
    "rentalStyle": "commission"
  },
  "terms": {
    "termsArray": [
      {
        "title": "Sample terms",
        "content": "<p>Custom HTML terms content...</p>",
        "id": "7uyi3a61u2f"
      }
    ]
  },
  "products": {
    "productsList": {
      "docs": ["684df524a60636d5a261cda5", "684df334a60636d5a261cc21"],
      "hasNextPage": false
    }
  },
  "rentNameSystem": "Example Rentals s.r.o.",
  "email": "info@rentall.cz"
}

Error shape (example)


{
  "errors": [
    {
      "message": "Rent not found",
      "code": "NOT_FOUND"
    }
  ]
}

Proceed to a method for details and examples: