Descripción General

Endpoint /custom-fields

Los campos adicionales son campos personalizados que se pueden crear según la necesidad del negocio en recursos particulares como productos. En la aplicación web se gestionan en Inventario > atributos > Campos adicionales, contiene los siguientes atributos:

Nombre

Tipo

Descripción

Ejemplo

id

Integer

Identificador único que representa un campo adicional específico. La aplicación lo asigna automáticamente.

1

name

String

Indica el nombre del atributo adicional

Código de barras

description

String

Descripción del atributo

Campo para adicionar el código de barras

defaultValue

String

Indicar un valor por defecto

1234

resourceType

String

Recurso asociado al atributo.

Las opciones disponibles son:

  • item

item

status

String

Estado del atributo

Las opciones disponibles son:

  • active: Indica que el campo se encuentra activo y puede ser usado.
  • inactive: Indica que el campo se encuentra inactivo y no puede ser usado.

active

key

String

Key para identificar si el campo es un campo de sistema.

Visita la lista de campos de sistema disponibles por país aquí.

barcode

type

String

Tipo de dato del atributo.

Las opciones disponibles son:

  • text: Indica que el campo es un campo de texto.
  • int: Indica que el campo es un campo numérico.
  • date: Indica que el campo es de tipo fecha.
  • boolean: indica que el campo es de tipo booleano (true o false)
  • optionsList: Indica que el campo es una lista de opciones pre-establecida.

text

settings

Object

Objeto con la configuraciones del campo adicional.

Contiene los siguientes atributos:

  • isRequired (Boolean): indica si el campo es obligatorio o no.
  • printOnInvoices (Boolean): Indica si el campo se desea imprimir en facturas.
  • showInItemVariants (Boolean): Indica si el campo se debe usar a nivel de items variantes o a nivel de item padre en items con variantes.
{
    "isRequired": false,         
    "showInItemVariants": false,
    "printOnInvoices": true
}

options

Array

Array de strings con las opciones disponibles para el campo adicional.

Únicamente aplica cuando el tipo del campo es optionsList

["ORO", "PLATA", "BRONCE"]