YOM Docs

Loaned equipment is the equipment you hand over to your commerces for them to use, while you keep ownership of it.

What is reported as loaned equipment? Each record represents equipment provided to a commerce under a loaned equipment agreement — for example a freezer, a refrigerator, or a display case installed at the point of sale.

A Loaned Equipment record contains the equipment identification, the Commerce where it is installed, the agreement term, and the Seller responsible for it. With this information, YOM can show the installed equipment base at each commerce and give context to requests for new equipment.

Endpoint

The Loaned Equipment endpoint lets YOM access detailed information about each piece of equipment provided on loan.

GET /api/comodatos

Fields

The following table defines the base integration model for the Loaned Equipment entity. This model is the base contract and is extensible: it can be complemented with additional attributes through the otherProperties object, as described in the Additional attributes section.

Loaned Equipment

Field Type Requirement Description Examples
comodatoId 📝 Text 🟢 Required Unique identifier of the Loaned Equipment record.
*\It must be stable over time: it is the key YOM uses to identify the record on every update. “COM-00123”
commerceId 📝 Text → Commerces 🟢 Required Id of the Commerce where the equipment is installed.
*\It must be the same identifier reported in the Commerces endpoint. “12345”
equipmentType 📝 Text 🟢 Required Type of equipment provided. “Congelador 400L”
equipmentCode 📝 Text ⚪ Optional Model or item code of the equipment. “CONG-400”
brand 📝 Text ⚪ Optional Equipment brand. “Electrolux”
serialNumber 📝 Text ⚪ Optional Serial number of the physical unit provided. “SN-8891233”
quantity 🔢 Number ⚪ Optional Number of units of the same equipment type covered by the record.
*\*If not reported, the assumed value is *1. When the equipment has a serial number, one record per unit is recommended. 1
contractNumber 📝 Text ⚪ Optional Number of the loaned equipment agreement signed with the Commerce. “CT-2026-0891”
startDate 📅 Date 🟢 Required Start date of the loan, that is, when the equipment is delivered or installed.
*\The date must be in ISO 8601 format. “2026-03-15”
“2026-03-15T00:00:00.000Z”
endDate 📅 Date ⚪ Optional End date of the agreement, when it has a defined term.
*\The date must be in ISO 8601 format. “2027-03-15”
withdrawalDate 📅 Date ⚪ Optional Date the equipment is actually removed from the Commerce.
*\The date must be in ISO 8601 format. “2026-11-02”
isInactive 🔘 Bool 🟢 Required Is the loan terminated?
*\*Equipment that has been removed or an agreement that has ended is reported as *true, keeping the historical record. true
false
status 📝 Text ⚪ Optional Status of the loan as named in your system.
*\*It is informational and complements *isInactive; it does not replace it. “Vigente”
“Retirado”
sellerId 📝 Text → Sellers ⚪ Optional Id of the Seller responsible for the equipment. “1234”
otherProperties 📝 Object ⚪ Optional Key-value object with additional attributes of the Loaned Equipment record. See the Additional attributes section. {"maintenanceFrequency": "Semestral", "assetOwner": "Planta Norte"}

Additional attributes (otherProperties)

The model documented on this page is the base contract for the Loaned Equipment entity. In addition to the base fields, customers can provide additional attributes for identification, classification, maintenance, or analysis through the otherProperties object.

Some examples of additional attributes are: maintenance frequency, the plant or warehouse that owns the asset, the book value of the equipment, capacity in liters, or the internal owner of the agreement.

The attributes inside otherProperties must meet the following conditions:

YOM can keep these attributes as extended information when the integration mechanism and the pipeline allow it. Receiving an attribute does not mean that YOM uses it automatically: its use must be validated during implementation.

Example with the additional attributes maintenanceFrequency, assetOwner, and capacityLiters:

{
  "comodatoId": "COM-00123",
  "commerceId": "12345",
  "equipmentType": "Congelador 400L",
  "startDate": "2026-03-15T00:00:00.000Z",
  "isInactive": false,
  "otherProperties": {
    "maintenanceFrequency": "Semestral",
    "assetOwner": "Planta Norte",
    "capacityLiters": 400
  }
}

Response