> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Metadatos

> Adjunta datos personalizados clave-valor a entidades de Midaz para extender el esquema estándar con información específica de tu integración.

Nuestra plataforma proporciona una forma flexible de enriquecer entidades con información definida por el usuario a través de **Metadatos**. Esta característica está disponible en todas las entidades dentro de nuestra API, permitiéndole adjuntar datos personalizados como pares clave-valor dentro de un objeto de metadatos.

Los metadatos son una herramienta poderosa para agregar información relevante definida por el usuario a las entidades de la API, permitiéndoles contener datos específicos para sus necesidades de integración. Los metadatos se pueden agregar en cualquier momento, haciendo que las entidades sean más adaptables a requisitos cambiantes.

Alentamos el uso de metadatos para mejorar sus integraciones de API, creando una experiencia que se alinee con las necesidades de su aplicación.

## ¿Qué son los metadatos?

***

Los metadatos le permiten almacenar información complementaria junto con el modelo de datos estándar de una entidad agregando atributos o anotaciones personalizados sin alterar el esquema predefinido de la entidad. Esta flexibilidad proporciona a las entidades contexto adicional, haciéndolas adaptables a requisitos específicos.

En Midaz, los metadatos son un objeto que admite pares clave-valor en estos tipos de datos: cadenas (**hasta 100 caracteres**), enteros, flotantes y booleanos.

<Warning>
  Los metadatos **no** admiten valores anidados.
</Warning>

### Ejemplo de metadatos

Considere una entidad Organización como se muestra a continuación:

<CodeGroup>
  ```json JSON theme={null}
  {
    "id": "cc15194a-6bc9-4ebb-b15d-43411a54ba4b",
    "parentOrganizationId": null,
    "legalName": "Empresa Teste Ltda",
    "doingBusinessAs": "Empresa Teste",
    "legalDocument": "86820799000188",
    "address": {
      "line1": "Rua Botucatu, 10",
      "line2": "Casa B",
      "zipCode": "04023060",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR"
    },
    "metadata": null,
    "status": {
      "code": "ACTIVE",
      "description": null
    },
    "createdAt": "2024-02-08T16:59:31+0300",
    "updatedAt": "2024-02-08T16:59:31+0300",
    "deletedAt": null
  }
  ```
</CodeGroup>

Para enriquecer esta organización con información adicional, como el sector industrial y el número de empleados, puede incluir un objeto de metadatos en sus solicitudes `POST`, `PUT` o `PATCH`:

<CodeGroup>
  ```json JSON theme={null}
  {
    "metadata": {
      "sector": "Fintech",
      "employees": "50-100"
    }
  }
  ```
</CodeGroup>

## Creación de entidades con metadatos

***

Al crear una entidad, puede enviar metadatos a través de nuestros endpoints `POST`, permitiéndole agregar datos personalizados desde el principio. Esta característica ayuda a crear una representación detallada y completa de cada entidad en su sistema.

## Actualización y eliminación de metadatos

***

Nuestra API sigue el RFC de JSON Merge Patch para las actualizaciones de metadatos, asegurando que los metadatos permanezcan adaptables y actuales:

* **Agregar o actualizar valores**: Enviar una clave con un nuevo valor en una solicitud `PUT` o `PATCH` actualiza los metadatos existentes.
* **Eliminar claves**: Omitir una clave previamente incluida en una solicitud `PUT` o `PATCH` subsiguiente elimina ese par clave-valor de los metadatos de la entidad.

### Ejemplo práctico: modificar metadatos

Suponga que una entidad Organización inicialmente incluía metadatos para el sector y el recuento de empleados. Para actualizar el recuento de empleados mientras se elimina el sector, envíe una solicitud `PATCH` con los siguientes metadatos:

<CodeGroup>
  ```json JSON theme={null}
  {
    "metadata": {
      "employees": "100-150"
    }
  }
  ```
</CodeGroup>

Después de procesar la solicitud, se eliminará la clave del sector y se actualizará el recuento de empleados.