Inventories

Document where all tangible assets and the existence of a property are recorded and the information of who signed it.

inventoryType attribute are the code for the different types of inventories that can be created in Elyssa app

• 0 : captación

• 1 : colocación

• 2 : pre-visita

• 3 : desocupación

List all inventory with pagination

GET /v1/inventories

List the inventories that a company has registered in elyssa app; To improve performance, the information is paginated, the amount of data to be returned in each query is established

Query Parameters

Name	Type	Description
inventoryType	number	Values: 0,1,2,3 Default: null
isSigned	boolean	Values: true, false, null Default: null
sortBy	string	Values: createdAt or signatureDate Default: createdAt
sortOrder	string	Values: asc, desc Default: desc
page	number	Number of the page to display information. Default 1
pageSize	number	Number of records to display per page. Default: 20.

200: OK

{
  "success": true,
  "timestamp": "2026-02-06T18:55:45.036Z",
  "data": {
    "data": [
      {
        "inventoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "property": {
          "propertyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "code": "string",
          "address": "string",
          "city": "string"
        },
        "inventoryType": 0,
        "inventoryTypeName": "string",
        "isSigned": true,
        "isRemoteSigned": true,
        "rentalPrice": 0,
        "currency": "string",
        "pdfDownloadUrl": "string",
        "createdAt": "2026-02-06T18:55:45.036Z",
        "signatureDate": "2026-02-06T18:55:45.036Z"
      }
    ],
    "page": 0,
    "pageSize": 0,
    "totalRecords": 0,
    "totalPages": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

400: Bad Request

Detail inventory

GET /v1/inventories/details

Complete detail of an inventory, with basic information about the property, the number of levels that make it up. It also has the environments and the items that make it up, providing comments, quantities, description and photos. ⁉️ The level attribute of the environments indicates the level at which it is located within the house.

Query Parameters

Name	Type	Description
InventoryId*	uuid	Unique identifier of inventory

200: OK

{
  "success": true,
  "timestamp": "2026-02-06T18:50:27.065Z",
  "data": {
    "inventoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "property": {
      "propertyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "string",
      "address": "string",
      "city": "string",
      "neighborhood": "string"
    },
    "inventoryType": 0,
    "inventoryTypeName": "string",
    "isSigned": true,
    "isRemoteSigned": true,
    "rentalPrice": 0,
    "currency": "string",
    "approvalCode": "string",
    "signatures": {
      "agentSignatureDate": "2026-02-06T18:50:27.065Z",
      "ownerSignatureDate": "2026-02-06T18:50:27.065Z",
      "signatureDate": "2026-02-06T18:50:27.065Z"
    },
    "pdfDownloadUrl": "string",
    "stats": {
      "totalEnvironments": 0,
      "totalItems": 0
    },
    "createdAt": "2026-02-06T18:50:27.065Z"
  }
}

400: Bad Request

Inventories by property Id

GET /v1/inventories/by-property

Retrieve all inventory records associated with a property by ID.

Query Parameters

Name	Type	Description
propertyId*	uuid	Unique identifier of property
page	number	Number of the page to display information. Default 1
pageSize	number	Number of records to display per page. Default: 20.

200: OK

{
  "success": true,
  "timestamp": "2026-02-06T19:00:54.044Z",
  "data": {
    "data": [
      {
        "inventoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "property": {
          "propertyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "code": "string",
          "address": "string",
          "city": "string"
        },
        "inventoryType": 0,
        "inventoryTypeName": "string",
        "isSigned": true,
        "isRemoteSigned": true,
        "rentalPrice": 0,
        "currency": "string",
        "pdfDownloadUrl": "string",
        "createdAt": "2026-02-06T19:00:54.044Z",
        "signatureDate": "2026-02-06T19:00:54.044Z"
      }
    ],
    "page": 0,
    "pageSize": 0,
    "totalRecords": 0,
    "totalPages": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

400: Bad Request