Saltar al contenido principal
Las etiquetas son etiquetas definidas por la organización para recursos como facturas. Son útiles para colas de revisión, flujos de trabajo internos y agrupar recursos en tu integración. Las etiquetas de recursos son diferentes de las etiquetas de entidad: Al aplicar etiquetas a un recurso, envía la colección tags completa que deseas que tenga el recurso. La colección enviada reemplaza la colección anterior.
Las operaciones de etiquetas de entidad se listan en Entities porque etiquetan entidades. Esta sección cubre las etiquetas de recursos.

​
Cómo se usan las etiquetas

  1. Crea una etiqueta para el tipo de recurso que quieres etiquetar.
  2. Almacena el IRI de la etiqueta devuelto por Syntage, como /tags/{id}.
  3. Actualiza el recurso con la colección tags completa que debe tener.
  4. Usa etiquetas en tu propia integración para construir colas, estados de revisión, agrupaciones o flujos de conciliación.

​
Color de la etiqueta

Tanto las etiquetas de recursos como las de entidad aceptan un color opcional al crearlas o actualizarlas. Úsalo para mostrar cada etiqueta con un color consistente en tus dashboards, reportes o exportaciones.
  • Envía una cadena hexadecimal de 7 caracteres con el formato #RRGGBB. Los colores se almacenan en minúsculas.
  • Omite el campo o envía null para conservar el color por defecto (#a3aab5).
  • Cambiar el color de una etiqueta actualiza todos los recursos que ya la referencian.

​
Reemplazar las asignaciones de etiquetas

Cuando un endpoint acepta una colección tags, la solicitud reemplaza las asignaciones de etiquetas existentes del recurso. Para agregar una etiqueta sin eliminar las etiquetas actuales, primero recupera el recurso, conserva sus IRIs de etiquetas existentes, anexa el nuevo IRI de etiqueta y envía la lista completa de vuelta. Para detalles de endpoints, consulta la Referencia de API de Etiquetas.