Tipos de datos

El API utiliza siguientes tipos de datos:

Tipo Descripción
string Cadena de texto.
uuid Una cadena de texto que representa un identificador UUID.
integer Un numero entero entre -2.147.483.648 y 2.147.483.647.
Para los valores hash utilizamos un 32bit unsigned int, entre 0 y 4.294.967.295.
decimal Un numero decimal.
datetime Una fecha y hora en formato yyyy-mm-ddThh:mm:ss (según el ISO8601).
Para fechas sin hora indicamos siempre 00:00:00. No incluye la zona horaria.
bool Un valor lógico: true o false.
X Un valor de tipo X indicado. El X esta definido en esta documentación.
[X, ] Una lista/array del tipo X indicado.

Estructuras de datos

El api implementa las siguientes estructuras de datos:

Adjunto

Representa el fichero adjunto como una imagen del artículo. 

{
    "datos": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8... ...AAAAAElFTkSuQmCC",
    "datos_vista_previa": "",
    "formato": "jpg",
    "nombre": "Imagen_1045",
    "por_defecto": true
}
Campo Tipo Descripción
nombre string nombre del adjunto
formato string el formato del fichero adjunto como png, jpg etc.
datos string bytes del fichero como base64
datos_vista_previa string bytes de la vista previa del fichero o vacío si no esta disponible. Codificado en base64.
por_defecto bool true si es la imagen por defecto

Apunte

Representa un apunte contable 

{
    "debe": 1210.0,
    "descripcion": "F20001",
    "haber": 0.0,
    "interlocutor": {
        "codigo": "10001",
        "hash": 0,
        "id": "71ea6353-9150-11eb-9321-54e1ade9de7d",
        "nombre": "GRUPO HOSTELEROS S.L.",
        "tipo": "cliente"
    },
    "numero": 1,
    "subcuenta": "4300000321"
}
Campo Tipo Descripción
numero integer número de apunte
descripcion string descripción del apunte
subcuenta string subcuenta del apunte
debe decimal importe al debe
haber decimal importe al haber
interlocutor InterlocutorComercialResumen interlocutor comercial asociado con el apunto o None

Articulo

Representa un artículo para la venta. El artículo tiene uno o varios formatos. Opcionalmente puede tener ficheros adjuntos como por ejemplo imagen de artículo. 

{
    "adjuntos": [
        {
            "datos": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8... ...AAAAAElFTkSuQmCC",
            "datos_vista_previa": "",
            "formato": "jpg",
            "nombre": "Imagen_1045",
            "por_defecto": true
        }
    ],
    "capacidad": "33cl",
    "codigo": "1045",
    "descripcion": "Cerveza San Miguel 1/3, cerveza rubia de sabor fresco y de ligero amargor.",
    "dimension1_codigo": "",
    "dimension1_descripcion": "",
    "dimension2_codigo": "",
    "dimension2_descripcion": "",
    "dimension3_codigo": "",
    "dimension3_descripcion": "",
    "dimension4_codigo": "",
    "dimension4_descripcion": "",
    "fabricante_codigo": "24",
    "fabricante_descripcion": "San Miguel",
    "formatos": [
        {
            "baja": false,
            "codigo": "1045-24",
            "control_stock": true,
            "descripcion": "San Miguel 1/3 24x",
            "envase_id": "36c06667-0069-4cca-9455-0847daed37eb",
            "equivalencia": 24.0,
            "etiquetas": [
                {
                    "descripcion": "cerveza nacional",
                    "nombre": "nacional"
                },
                {
                    "descripcion": "",
                    "nombre": "tercio"
                }
            ],
            "id": "3b3ab89d-427f-4a79-9863-2060ef5c9d0c",
            "litros": 0.33,
            "nivel_refrigeracion": "SinFrio",
            "nombre": "San Miguel 1/3 Caja 24 botellas",
            "peso": 9.6,
            "peso_neto": 7.2,
            "peso_por_defecto": 0.0,
            "tasas": [
                {
                    "tipo": "SIG",
                    "valor": 0.05
                }
            ],
            "tipo": "caja",
            "unidad_medida": "Caja",
            "volumen": 0.0072
        },
        {
            "baja": false,
            "codigo": "1045-1",
            "control_stock": true,
            "descripcion": "San Miguel 1/3",
            "envase_id": "",
            "equivalencia": 1.0,
            "etiquetas": [
                "nacional",
                "tercio"
            ],
            "id": "3b3ab89d-427f-7563-9863-87644d89e8bd",
            "litros": 0.33,
            "nivel_refrigeracion": "SinFrio",
            "nombre": "San Miguel 1/3 botella",
            "peso": 0.4,
            "peso_neto": 0.3,
            "peso_por_defecto": 0.0,
            "tasas": [
                {
                    "tipo": "SIG",
                    "valor": 1.2
                }
            ],
            "tipo": "unidad",
            "unidad_medida": "Botella",
            "unidades_fraccion": 4,
            "volumen": 0.0003
        }
    ],
    "grados_alcohol": 4.5,
    "hash": 32145,
    "id": "8fd593d0-f7d8-44c9-bfb9-026d823b3d95",
    "impuestos": [
        {
            "base": 100.0,
            "descripcion": "IVA general",
            "grupo": "general",
            "iva": 21.0,
            "recargo": 5.2
        }
    ],
    "marca": "",
    "nombre": "San Miguel 1/3",
    "organizacion_venta": "Bebidas",
    "subcuenta_compras": "6000000001",
    "subcuenta_ventas": "7000000001",
    "subtipo": "",
    "subtipo_descripcion": "",
    "tipo": "producto",
    "tipo_descripcion": "Producto"
}
Campo Tipo Descripción
id uuid identificador del artículo
tipo string tipo de articulo: producto, envase, plv, cargo
codigo string código de articulo
nombre string nombre de artículo
descripcion string descripción larga de artículo
hash integer valor de hash para identificar la versión del registro. Este valor cambia cada vez que el artículo cambia.
tipo_descripcion string descripción de tipo de artículo
dimension1_codigo string
dimension1_descripcion string
dimension2_codigo string
dimension2_descripcion string
dimension3_codigo string
dimension3_descripcion string
dimension4_codigo string
dimension4_descripcion string
fabricante_codigo string código del fabricante
fabricante_descripcion string descripción del fabricante del artículo
marca string la marca del articulo
organizacion_venta string código de organización de la venta
subtipo string código de subtipo
subtipo_descripcion string descripción de subtipo
formatos [Formato, ] lista de formatos de articulo
adjuntos [Adjunto, ] lista de ficheros adjuntos al articulo
impuestos [Impuesto, ] lista de impuestos asociados con el artículo
capacidad string una descripción informativa de capacidad, por ejemplo 75cl
grados_alcohol decimal graduación alcohólica de etanol expresada en porcentajes
subcuenta_compras string subcuenta para compras nacionales
subcuenta_ventas string subcuenta para ventas nacionales

ArticuloGrupo

Representa un grupo de artículos. 

{
    "adjuntos": [
        {
            "datos": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8... ...AAAAAElFTkSuQmCC",
            "datos_vista_previa": "",
            "formato": "jpg",
            "nombre": "Imagen_1045",
            "por_defecto": true
        }
    ],
    "codigo": "1",
    "destacado": false,
    "id": "0a2c1075-569b-11eb-9fa0-54e1ade9de7d",
    "nombre": "Cervezas",
    "tipo": "GAMA"
}
Campo Tipo Descripción
id uuid identificador del grupo
codigo string código de grupo
nombre string nombre de grupo
tipo string tipo de grupo. Varios grupos pueden ser del mismo tipo, por ejemplo grupos 'limón' y 'naranja' son de tipo 'sabor'. El campo puede estar vacío.
adjuntos [Adjunto, ] lista de ficheros adjuntos al grupo
destacado bool true si es un grupo de los artículos destacados, por ejemplo promoción o oferta

ArticuloResumen

Representa una versión resumida de artículo para mostrar como resultado de la búsqueda etc. 

{
    "codigo": "1045",
    "hash": 32145,
    "id": "8fd593d0-f7d8-44c9-bfb9-026d823b3d95",
    "nombre": "San Miguel 1/3",
    "tipo": "producto"
}
Campo Tipo Descripción
id string identificador del articulo
codigo string código de articulo
nombre string nombre de artículo
tipo string tipo de articulo véase Articulo
hash integer valor de hash para identificar la versión del registro. Este valor cambia cada vez que el artículo cambia. Este valor solo esta calculado en la llamada a /articulos/

Asiento

Representa un asiento contable 

{
    "apuntes": [
        {
            "debe": 1210.0,
            "descripcion": "F20001",
            "haber": 0.0,
            "interlocutor": {
                "codigo": "10001",
                "hash": 0,
                "id": "71ea6353-9150-11eb-9321-54e1ade9de7d",
                "nombre": "GRUPO HOSTELEROS S.L.",
                "tipo": "cliente"
            },
            "numero": 1,
            "subcuenta": "4300000321"
        },
        {
            "debe": 0.0,
            "descripcion": "N/FRA F20001",
            "haber": 1210.0,
            "interlocutor": null,
            "numero": 2,
            "subcuenta": "6000000001"
        }
    ],
    "descripcion": "ASIENTO FACTURA",
    "ejercicio": 2020,
    "fecha": "2020-05-30T00:00:00",
    "numero": 100,
    "periodo": "MAR",
    "registros": [
        {
            "desgloses": [
                {
                    "base": 1210.0,
                    "cuota_iva": 254.1,
                    "cuota_recargo": 62.92,
                    "grupo": "general",
                    "iva": 21.0,
                    "recargo": 5.2
                }
            ],
            "factura": "F20001",
            "fecha": "2020-05-30T00:00:00",
            "idfiscal": {
                "codigo_documento": "B98798757",
                "forma_juridica": "B",
                "idfiscal_id": "002e9612-4180-4644-aa36-72b201175cea",
                "nombre": "GRUPO HOSTELEROS S.L.",
                "tipo_documento": "CIF"
            },
            "numero_emitido": 20001,
            "numero_recepcion": 0,
            "serie_emitida": "F",
            "tipo": "Expedidas",
            "tipo_iva": "Repercutido"
        }
    ]
}
Campo Tipo Descripción
numero integer número de asiento
descripcion string descripción del asiento
fecha datetime fecha del asiento
ejercicio integer ejercicio contable
periodo string periodo contable
apuntes [Apunte, ] lista de apuntes del asiento
registros [RegistroIva, ] lista de registros de iva asociados al asiento

CargaMovil

Representa una carga móvil disponible para descargar. 

{
    "carga_id": "10da09fd-cff0-11ea-ab4c-54e1ade9de7d",
    "version": "20200727120046"
}
Campo Tipo Descripción
carga_id uuid identificador de la carga disponible. Utiliza el identificador para descargar el fichero de la carga.
version string numero de la versión de carga. Utiliza la versión para comprobar si existe una nueva carga preparada antes de descargarla.

CentroCoste

Representa un centro de coste. 

{
    "clave_dimension": "P",
    "codigo": "CERV",
    "descripcion": "CERVEZA",
    "id": "94a3365a-2cd2-11ec-9784-54e1ade9de7d",
    "nivel": 1,
    "tipo_dimension": "Organizacion"
}
Campo Tipo Descripción
id uuid identificador del centro
codigo string código del centro
descripcion string descripción del centro
clave_dimension string clave de la dimensión
tipo_dimension string tipo de dimensión, uno de: almacen, organizacion, personal_tipo, tipo_distribucion, contabilidad
nivel integer nivel del centro

Compra

Representa documento de compra. 

{
    "almacen_codigo": "001",
    "almacen_nombre": "General",
    "canal": "",
    "delegacion": "X",
    "dto_pronto_pago": 0.0,
    "estado": "Recepcionado",
    "factura_fecha": "2020-11-15T00:00:00",
    "factura_numero": 2346,
    "factura_serie": "FC",
    "fecha_documento": "2020-10-28T00:00:00",
    "fecha_recepcion": "2020-10-28T00:00:00",
    "forma_pago": "1",
    "forma_pago_descripcion": "CONTADO",
    "hash": 456724,
    "id": "47564104-b242-11ea-97da-00155d0a2014",
    "lineas": [
        {
            "cantidad_entrega": 1.0,
            "cantidad_pedido": 1.0,
            "cantidad_valoracion": 1.0,
            "envase_codigo": "",
            "envase_id": "",
            "envase_nombre": "",
            "euros_descuento": 0.0,
            "euros_descuento_cesion": 0.0,
            "formato_codigo": "LI106",
            "formato_id": "fc0e5e6d-4ad6-4ebc-a2ea-da2ff30d3107",
            "formato_nombre": "BARRIL CERVEZA 30 L.",
            "importe_sig": 0.0,
            "impuestoenvase": 0.0,
            "impuestoliquido": 3.0,
            "orden": 0,
            "peso_bruto": 36.5,
            "peso_neto": 22.3,
            "precio": 30.0,
            "precio_envase": 0.0,
            "precio_neto": 21.0,
            "total": 30.0,
            "totalconimpuestos": 33.0,
            "totalenvase": 0.0,
            "totalliquido": 30.0,
            "valor_sig": 0.0,
            "valorimpuesto": "10.00",
            "valorimpuestoenvase": ""
        }
    ],
    "numero": 130,
    "proveedor": {
        "codigo": "10001",
        "hash": 0,
        "id": "71ea6353-9150-11eb-9321-54e1ade9de7d",
        "nombre": "BODEGAS ARRIATE S.L.",
        "tipo": "proveedor"
    },
    "serie": "CC",
    "tipo_documento": "Albaran",
    "total": 30.0,
    "total_con_impuestos": 33.0
}
Campo Tipo Descripción
almacen_codigo string código del almacen
almacen_nombre string nombre de almacen
proveedor InterlocutorComercialResumen proveedor de la compra
dto_pronto_pago decimal descuento de pronto pago aplicado (en porcentajes)
forma_pago string código de la forma de pago
forma_pago_descripcion string descripción de la forma de pago
lineas [CompraLinea, ] líneas de compra
delegacion string clave de dimensión del centro de costes del almacén
factura_serie string serie de la factura si el documento esta facturado
factura_numero integer numero de la factura si el documento esta facturado
factura_fecha datetime fecha de la factura si el documento esta facturado

CompraLinea

Representa una linea de compra 

{
    "cantidad_entrega": 1.0,
    "cantidad_pedido": 1.0,
    "cantidad_valoracion": 1.0,
    "envase_codigo": "",
    "envase_id": "",
    "envase_nombre": "",
    "euros_descuento": 0.0,
    "euros_descuento_cesion": 0.0,
    "formato_codigo": "LI106",
    "formato_id": "fc0e5e6d-4ad6-4ebc-a2ea-da2ff30d3107",
    "formato_nombre": "BARRIL CERVEZA 30 L.",
    "importe_sig": 0.0,
    "impuestoenvase": 0.0,
    "impuestoliquido": 3.0,
    "orden": 0,
    "peso_bruto": 36.5,
    "peso_neto": 22.3,
    "precio": 30.0,
    "precio_envase": 0.0,
    "precio_neto": 21.0,
    "total": 30.0,
    "totalconimpuestos": 33.0,
    "totalenvase": 0.0,
    "totalliquido": 30.0,
    "valor_sig": 0.0,
    "valorimpuesto": "10.00",
    "valorimpuestoenvase": ""
}
Campo Tipo Descripción
cantidad_entrega decimal cantidad de mercancía recepcionada
cantidad_pedido decimal cantidad de mercancía pedida (cantidad original del pedido)
cantidad_valoracion decimal cantidad de mercancía para valorar la línea. Normalmente coincide con cantidad entregada, pero indica peso en los artículos de peso
envase_codigo string código de envase
envase_id uuid id del formato del envase asociado o vacío si el envase no es aplicable
envase_nombre string nombre de envase
euros_descuento decimal total descuento aplicado sobre la linea que no son de tipo cesion
euros_descuento_cesion decimal total descuento aplicado sobre la linea de tipo cesion
formato_codigo string código de formato
formato_id uuid id del formato
formato_nombre string nombre de formato
peso_bruto decimal total peso de la línea
peso_neto decimal total peso neto de la línea
importe_sig decimal importe total del SIG (punto verde)
impuestoenvase decimal total cuotas de IVA aplicadas sobre envase asociado
impuestoliquido decimal total cuotas de IVA aplicadas sobre liquido
orden integer orden de las lineas
precio_envase decimal precio de envase asociado
precio decimal precio aplicado sobre la línea
precio_neto decimal precio neto de la línea
totalconimpuestos decimal total de la linea incluyendo los impuestos
totalenvase decimal total del envase asociado
totalliquido decimal total del liquido
total decimal total de la linea
valor_sig decimal tasa de SIG (punto verde)
valorimpuestoenvase string una representación de porcentaje de IVA aplicado a envase, ej.: 10
valorimpuesto string una representación de porcentaje de IIVA aplicado a liquido, vacío si hay varios impuestos aplicados

CompraResumen

Representa un resumen del documento de compra. 

{
    "estado": "Recepcionado",
    "fecha_documento": "2020-10-28T00:00:00",
    "fecha_recepcion": "2020-10-28T00:00:00",
    "hash": 456724,
    "id": "47564104-b242-11ea-97da-00155d0a2014",
    "numero": 130,
    "serie": "CC",
    "tipo_documento": "Albaran",
    "total": 30.0,
    "total_con_impuestos": 33.0
}
Campo Tipo Descripción
id uuid identificador de la compra
serie string serie de documento de compra
numero integer numero de documento de compra
tipo_documento string tipo del documento: pedido, albaran, albaran consigna
estado string estado de documento: 'generado', 'solicitado al proveedor', 'asignado por el proveedor', 'asignada fecha de carga', 'recepcionado', 'facturado', 'anulado', 'rechazado'
fecha_documento datetime fecha de creación/valoración de la compra
fecha_recepcion datetime fecha de recepción de la mercancía
total decimal total de la compra antes de aplicar IVA
total_con_impuestos decimal total de la compra con impuestos
hash integer valor de hash para identificar la versión del registro. Este valor cambia cada vez que la compra cambia.

Contacto

Representa una persona de contacto con su telefono, email etc. 

{
    "cargo": "Director",
    "email": "pepe@faunamuseo.com",
    "fax": "",
    "fijo": "+34123123123",
    "movil": "+34321321321",
    "nombre": "Pepe Lopez"
}
Campo Tipo Descripción
nombre string nombre de la persona de contacto
cargo string cargo de la persona de contacto
fijo string numero de teléfono fijo
movil string numero de teléfono móvil
fax string numero de fax
email string dirección de correo electrónico

Descuento

Representa un descuento aplicado a un formato en el periodo indicado. Tipo del descuento indica que campo tiene valor aplicable. 

{
    "cargo": 0.0,
    "euros": 0.0,
    "fecha_desde": "2020-08-01T00:00:00",
    "fecha_hasta": "2020-08-31T00:00:00",
    "formato_codigo": "1045-24",
    "formato_id": "3b3ab89d-427f-4a79-9863-2060ef5c9d0c",
    "porcentaje": 20.0,
    "precio": 0.0,
    "regalo": 0.0,
    "tipo": "porcentaje"
}
Campo Tipo Descripción
formato_id uuid identificador del formato del artículo
formato_codigo string código del formato del artículo
fecha_desde datetime fecha desde la que aplicamos el descuento
fecha_hasta datetime fecha hasta la que aplicamos el descuento (inclusivo)
tipo string tipo de la condicion: porcentaje, euros, precio, regalo
minimo string cantidad minima desde la que hay que aplicar el descuento
porcentaje decimal un porcentaje de descuento
euros decimal cantidad de euros de descuento por formato
precio decimal un precio especial aplicable en lugar de la tarifa
cargo decimal cantidad de cargo para aplicar el regalo. 2+1 (paga 2 llevate 3) es cargo=2, regalo=1
regalo decimal cantidad regalada

DesgloseIva

Representa un detalle del registro de I.V.A. 

{
    "base": 1210.0,
    "cuota_iva": 254.1,
    "cuota_recargo": 62.92,
    "grupo": "general",
    "iva": 21.0,
    "recargo": 5.2
}
Campo Tipo Descripción
grupo string indica el tipo de IVA: general, reducido, super reducido, exento
base decimal base imponible
cuota_iva decimal cuota de I.V.A
cuota_recargo decimal cuota del recargo de equivalencia
iva decimal porcentaje de impuesto
recargo decimal porcentaje de recargo de equivalencia

Diario

Representa un diario contable

Campo Tipo Descripción
peticion_id uuid identificador de la petición
asientos [Asiento, ] lista de asientos del diario

Direccion

Representa una dirección de un interlocutor comercial o dirección fiscal. 

{
    "codigo_postal": "46680",
    "direccion": "Calle Museo 34",
    "pais": "ES",
    "poblacion": "Algemes\u00ed",
    "provincia": "Valencia",
    "tipo": "generica"
}
Campo Tipo Descripción
tipo string tipo de la dirección: generica, reparto
direccion string calle y numero
codigo_postal string código postal de la población
poblacion string nombre de la población
provincia string nombre de la provincia
pais string código de país alfa-2 según normativa ISO 3166-1

Empleado

Representa un empleado. 

{
    "clave_dimension": "repartidor",
    "codigo": "RP005",
    "id": "00301270-6e90-407d-813d-b2d26fc526ac",
    "idfiscal": {
        "codigo_documento": "B98798646",
        "forma_juridica": "B",
        "idfiscal_id": "002e9612-4180-4644-aa36-72b201175emp",
        "nombre": "FRANCISCO MONTES MONTES",
        "tipo_documento": "CIF"
    },
    "nombre": "PACO MONTES"
}
Campo Tipo Descripción
id uuid identificador del empleado
codigo string código del empleado
nombre string nombre del empleado
idfiscal IdentificacionFiscalResumen identificacion fiscal del empleado
clave_dimension string clave de la dimensión según el tipo de empleado
subcuenta string numero de subcuenta contable

Etiqueta

Representa una etiqueta con su nombre y descripción. 

{
    "descripcion": "cerveza nacional",
    "nombre": "nacional"
}
Campo Tipo Descripción
nombre string nombre de la etiqueta
descripcion string descripccion de la etiqueta

Formato

Representa un formato del artículo. 

{
    "baja": false,
    "codigo": "1045-24",
    "control_stock": true,
    "descripcion": "San Miguel 1/3 24x",
    "envase_id": "36c06667-0069-4cca-9455-0847daed37eb",
    "equivalencia": 24.0,
    "etiquetas": [
        {
            "descripcion": "cerveza nacional",
            "nombre": "nacional"
        },
        {
            "descripcion": "",
            "nombre": "tercio"
        }
    ],
    "id": "3b3ab89d-427f-4a79-9863-2060ef5c9d0c",
    "litros": 0.33,
    "nivel_refrigeracion": "SinFrio",
    "nombre": "San Miguel 1/3 Caja 24 botellas",
    "peso": 9.6,
    "peso_neto": 7.2,
    "peso_por_defecto": 0.0,
    "tasas": [
        {
            "tipo": "SIG",
            "valor": 0.05
        }
    ],
    "tipo": "caja",
    "unidad_medida": "Caja",
    "volumen": 0.0072
}
Campo Tipo Descripción
id uuid identificador del formato
tipo string tipo de formato: unidad o caja
codigo string código del formato
nombre string nombre de formato
descripcion string descripción abreviada del formato
equivalencia decimal número de unidades incluidas en el formato (por ejemplo pack de 6, caja de 4 botellas)
baja bool true si el formato está de baja
peso decimal peso en kilogramos
peso_neto decimal peso del producto neto en kilogramos
peso_por_defecto decimal en los productos que hay que pesar, esto es peso por defecto de la pieza ej. 6.5 para una pieza de jamón. Esto no es aplicable a los artículos que se venden a granel.
volumen decimal volumen del embalaje en m3
litros decimal volumen del producto liquido en litros
tasas [FormatoTasa, ] lista de tasas aplicables al formato
etiquetas [Etiqueta, ] lista de etiquetas asociadas con el formato
unidad_medida string nombre de la unidad de medida de formato ej. unidad, caja, paquete, botella etc.
unidades_fraccion decimal numero de unidades dentro de la caja
control_stock bool si cuenta para stock
nivel_refrigeracion string nivel de refrigeración (Sin frio, Frio positivo, Frio negativo)
envase_id uuid identificador del envase asociado

FormatoStock

Representa información sobre el stock disponible del Formato 

{
    "almacen_codigo": "001",
    "almacen_nombre": "General",
    "fecha_stock": "2021-03-08T15:00:00",
    "formato_codigo": "1045-24",
    "formato_id": "3b3ab89d-427f-4a79-9863-2060ef5c9d0c",
    "formato_nombre": "San Miguel 1/3 Caja 24 botellas",
    "stock": 15.0
}
Campo Tipo Descripción
formato_id uuid identificador del formato
formato_codigo string código del formato
formato_nombre string nombre de formato
almacen_codigo string código del almacen
almacen_nombre string nombre de almacen
stock decimal stock disponible a la fecha indicada
fecha_stock datetime fecha y hora de validez de stock

FormatoTasa

Representa una tasa aplicable al formato 

{
    "tipo": "SIG",
    "valor": 0.05
}
Campo Tipo Descripción
tipo string tipo de la tasa: SIG (Sistema integrado de gestión), IBAE5, IBAE8 (Impuesto sobre las bebidas azucaradas envasadas, 5-8g, >8g)
valor decimal valor de la tasa en euros

IdentificacionFiscal

Representa una identificación fiscal. 

{
    "codigo_documento": "G98798798",
    "direccion": {
        "codigo_postal": "46680",
        "direccion": "Calle Museo 34",
        "pais": "ES",
        "poblacion": "Algemes\u00ed",
        "provincia": "Valencia",
        "tipo": "generica"
    },
    "forma_juridica": "V",
    "idfiscal_id": "05cd76fc-8236-4bfb-a5a2-dfe55647356e",
    "nombre": "Fundacion Pepe Lopez",
    "tipo_documento": "DNI"
}
Campo Tipo Descripción
idfiscal_id uuid identificador de la identicación fiscal
forma_juridica string forma jurídica: A, B, C,... (definidas en Hacienda)
tipo_documento string tipo del documento: CIF, DNI, ...
codigo_documento string código del documento: número del CIF, número del DNI, ...
nombre string razón social
direccion Direccion Dirección fiscal.

IdentificacionFiscalResumen

Representa una versión reducida de las identificaciones fiscales 

{
    "codigo_documento": "B98798757",
    "forma_juridica": "B",
    "idfiscal_id": "002e9612-4180-4644-aa36-72b201175cea",
    "nombre": "GRUPO HOSTELEROS S.L.",
    "tipo_documento": "CIF"
}
Campo Tipo Descripción
idfiscal_id uuid identificador de la identicación fiscal
forma_juridica string forma jurídica: A, B, C,... (definidas en Hacienda)
tipo_documento string tipo del documento: CIF, DNI, ...
codigo_documento string código del documento: número del CIF, número del DNI, ...
nombre string razón social

Impuesto

Representa el impuesto asociado con el artículo. 

{
    "base": 100.0,
    "descripcion": "IVA general",
    "grupo": "general",
    "iva": 21.0,
    "recargo": 5.2
}
Campo Tipo Descripción
descripcion string descripción del impuesto
grupo string indica el tipo de IVA: general, reducido, super reducido, exento
base decimal porcentaje de base al que hay que aplicar el impuesto
iva decimal porcentaje de impuesto
recargo decimal porcentaje de recargo

InformeGrupo

Representa una agrupación para informe. 

{
    "articulos": [],
    "nombre": "CERVEZAS",
    "subgrupos": [
        {
            "articulos": [
                {
                    "baja": false,
                    "codigo": "1045-24",
                    "control_stock": true,
                    "descripcion": "San Miguel 1/3 24x",
                    "envase_id": "36c06667-0069-4cca-9455-0847daed37eb",
                    "equivalencia": 24.0,
                    "etiquetas": [
                        {
                            "descripcion": "cerveza nacional",
                            "nombre": "nacional"
                        },
                        {
                            "descripcion": "",
                            "nombre": "tercio"
                        }
                    ],
                    "id": "000d2ddd-95ea-4a45-9d0d-ef381150e86e",
                    "litros": 0.33,
                    "nivel_refrigeracion": "SinFrio",
                    "nombre": "San Miguel 1/3 Caja 24 botellas",
                    "peso": 9.6,
                    "peso_neto": 7.2,
                    "peso_por_defecto": 0.0,
                    "tasas": [
                        {
                            "tipo": "SIG",
                            "valor": 0.05
                        }
                    ],
                    "tipo": "caja",
                    "unidad_medida": "Caja",
                    "volumen": 0.0072
                }
            ],
            "nombre": "CAJA RETORNABLE",
            "subgrupos": []
        },
        {
            "articulos": [
                {
                    "baja": false,
                    "codigo": "1045-1",
                    "control_stock": true,
                    "descripcion": "Barril San Miguel 30",
                    "envase_id": "",
                    "equivalencia": 1.0,
                    "etiquetas": [
                        "nacional",
                        "barril"
                    ],
                    "id": "000b32d6-018f-45c0-a93c-3dc785ef24b8",
                    "litros": 30.0,
                    "nivel_refrigeracion": "SinFrio",
                    "nombre": "Barril San Miguel 30",
                    "peso": 4.0,
                    "peso_neto": 3.0,
                    "peso_por_defecto": 0.0,
                    "tasas": [
                        {
                            "tipo": "SIG",
                            "valor": 1.2
                        }
                    ],
                    "tipo": "unidad",
                    "unidad_medida": "Unidad",
                    "unidades_fraccion": 1,
                    "volumen": 0.0
                }
            ],
            "nombre": "BARRIL",
            "subgrupos": []
        }
    ]
}
Campo Tipo Descripción
nombre string Descripción
subgrupos [InformeGrupo, ] lista de subgrupos que componen el árbol
articulos [Formato, ] lista de artículos que contiene el informe grupo

InterlocutorComercial

Representa un interlocutor comercial como el cliente, proveedor o acreedor. 

{
    "baja": false,
    "canal": "Z",
    "cargar_envases": "documentoaparte",
    "codigo": "10000",
    "codigo_barras": "",
    "contactos": [
        {
            "cargo": "Director",
            "email": "pepe@faunamuseo.com",
            "fax": "",
            "fijo": "+34123123123",
            "movil": "+34321321321",
            "nombre": "Pepe Lopez"
        }
    ],
    "delegacion": "X",
    "direcciones": [
        {
            "codigo_postal": "46680",
            "direccion": "Calle Museo 34",
            "pais": "ES",
            "poblacion": "Algemes\u00ed",
            "provincia": "Valencia",
            "tipo": "generica"
        }
    ],
    "documento_entrega": "factura",
    "email_facturacion": "info@faunamuseo.com",
    "exento_iva": true,
    "exento_sig": false,
    "forma_pago": "contado",
    "hash": 4153754459,
    "id": "3d61abd3-d01d-42d8-ab39-50ff691d044c",
    "idfiscal": {
        "codigo_documento": "G98798798",
        "direccion": {
            "codigo_postal": "46680",
            "direccion": "Calle Museo 34",
            "pais": "ES",
            "poblacion": "Algemes\u00ed",
            "provincia": "Valencia",
            "tipo": "generica"
        },
        "forma_juridica": "V",
        "idfiscal_id": "05cd76fc-8236-4bfb-a5a2-dfe55647356e",
        "nombre": "Fundacion Pepe Lopez",
        "tipo_documento": "DNI"
    },
    "nombre": "MUSEO DE LA FAUNA SALVAJE",
    "referencia_pedido_obligatoria": false,
    "regimen_fiscal": "general",
    "rutas_reparto": [
        {
            "codigo": "002",
            "descripcion": "Ruta 2",
            "tipo": "reparto"
        }
    ],
    "rutas_venta": [
        {
            "codigo": "001",
            "descripcion": "Ruta 1",
            "tipo": "venta"
        }
    ],
    "subcuenta": "430010000",
    "tarifa": "D",
    "tipo": "cliente",
    "tiposcliente": [
        {
            "codigo": "bar",
            "descripcion": "BARES"
        }
    ]
}
Campo Tipo Descripción
id uuid identificador único del interlocutor
tipo string tipo de interlocutor: cliente, proveedor, acreedor
codigo string código de interlocutor
nombre string nombre de interlocutor
subcuenta string numero de subcuenta contable
idfiscal IdentificacionFiscal identificación fiscal asociada con el interlocutor
email_facturacion string correo electrónico de facturación
codigo_barras string código de barras asociado con el interlocutor
regimen_fiscal string tipo de régimen fiscal: general, recargo, exento
exento_sig bool true si el interlocutor es exento de SIG (ecotasa)
exento_iva bool true si el interlocutor es exento de IVA
referencia_pedido_obligatoria bool true si hay que indicar la referencia de pedido del cliente.
cargar_envases string indica si hay que cargar los envases: cargar, nocargar, documento_aparte o cadena vacía si no es aplicable.
documento_entrega string indica el tipo de documento de entrega al cliente: albaran, factura o cadena vacía si no es aplicable.
tarifa string Código de la tarifa por defecto
forma_pago string Código de la forma de pago
direcciones [Direccion, ] la lista de las direcciones del interlocutor
contactos [Contacto, ] la lista de contactos de interlocutor
baja bool true si el cliente esta de baja
tiposcliente [TipoCliente, ] la lista de tipos de cliente. Este campo solo esta disponible si el tipo es cliente. El primer tipo es genérico, las demás tipos dependen del fabricante.
hash integer valor de hash para identificar la versión del registro. Este valor cambia cada vez que el interlocutor, dirección o datos fiscales cambian.
delegacion string Clave de dimensión del centro de costes. Este campo solo esta disponible para cliente.
canal string Clave de dimensión del centro de costes. Este campo solo esta disponible para cliente.
rutas_venta [Ruta, ] Lista de rutas de tipo venta a las que pertenece el cliente. Este campo solo esta disponible para cliente.
rutas_reparto [Ruta, ] Lista de rutas de tipo reparto a las que pertenece el cliente. Este campo solo esta disponible para cliente.

InterlocutorComercialResumen

Representa un resumen de interlocutor comercial como el cliente, proveedor o acreedor. 

{
    "codigo": "10001",
    "hash": 0,
    "id": "71ea6353-9150-11eb-9321-54e1ade9de7d",
    "nombre": "GRUPO HOSTELEROS S.L.",
    "tipo": "cliente"
}
Campo Tipo Descripción
id uuid identificador único del interlocutor
tipo string tipo de interlocutor: "cliente", "proveedor", "acreedor"
codigo string código de interlocutor
nombre string nombre de interlocutor
hash integer valor de hash para identificar la versión del registro. Este valor cambia cada vez que el interlocutor cambia.

Modelo347

Representa un registro de datos para la declaración del modelo 347. 

{
    "clave_operacion": "A",
    "detalles": [
        {
            "documento": "11111111",
            "fecha": "2021-04-14T00:00:00",
            "importe": 12100.0
        },
        {
            "documento": "0312463896",
            "fecha": "2021-07-29T00:00:00",
            "importe": 1619.69
        }
    ],
    "ejercicio": 2021,
    "id": "7205e4ed-4606-11ec-a736-fa163e6ae230",
    "idfiscal": {
        "codigo_documento": "B98798757",
        "forma_juridica": "B",
        "idfiscal_id": "002e9612-4180-4644-aa36-72b201175cea",
        "nombre": "GRUPO HOSTELEROS S.L.",
        "tipo_documento": "CIF"
    },
    "importe_percibido_metalico_calculo": 0.0,
    "importe_percibido_metalico_declarar": 0.0,
    "importe_trimestre_1_calculo": 0.0,
    "importe_trimestre_1_declarar": 0.0,
    "importe_trimestre_2_calculo": 12100.0,
    "importe_trimestre_2_declarar": 12100.0,
    "importe_trimestre_3_calculo": 1619.69,
    "importe_trimestre_3_declarar": 1619.69,
    "importe_trimestre_4_calculo": 0.0,
    "importe_trimestre_4_declarar": 0.0,
    "validado": true
}
Campo Tipo Descripción
id uuid Identificador del registro. Utiliza el identificador para validar el registro.
ejercicio integer ejercicio
idfiscal IdentificacionFiscalResumen identificación fiscal al que pertenece el registro
clave_operacion string la clave según el modelo 347. Uno de 'A', 'B', 'C', 'D', 'E', 'F', 'G'
importe_trimestre_1_calculo decimal importe acumulado del trimestre 1
importe_trimestre_2_calculo decimal importe acumulado del trimestre 2
importe_trimestre_3_calculo decimal importe acumulado del trimestre 3
importe_trimestre_4_calculo decimal importe acumulado del trimestre 4
importe_trimestre_1_declarar decimal importe a declarar en el trimestre 1
importe_trimestre_2_declarar decimal importe a declarar en el trimestre 2
importe_trimestre_3_declarar decimal importe a declarar en el trimestre 3
importe_trimestre_4_declarar decimal importe a declarar en el trimestre 4
importe_percibido_metalico_calculo decimal importe en metálico calculado
importe_percibido_metalico_declarar decimal importe en metálico a declarar
validado bool true si los importes a declarar han sido validadas. Utiliza /api_v1/modelo347_validar/ para validar el registro.
detalles [Modelo347Detalle, ] lista de documentos incluidos en los totales

Modelo347Detalle

Representa un documento incluido en los totales de los importes de Modelo347 

{
    "documento": "11111111",
    "fecha": "2021-04-14T00:00:00",
    "importe": 12100.0
}
Campo Tipo Descripción
documento string serie y numero de documento
fecha datetime fecha del documento
importe decimal importe del documento

Pedido

Representa un pedido para grabar en winfra. 

{
    "cliente_direccion": {
        "codigo_postal": "46680",
        "direccion": "Calle Museo 34",
        "pais": "ES",
        "poblacion": "Algemes\u00ed",
        "provincia": "Valencia",
        "tipo": "generica"
    },
    "cliente_nombre": "Pepe Lopez",
    "comentario": "Entregar por la ma\u00f1ana",
    "email": "pepe@faunamuseo.com",
    "identicket": "",
    "identificador": "",
    "idfiscal": {
        "codigo_documento": "B321321",
        "direccion": {
            "codigo_postal": "46680",
            "direccion": "Calle Museo 34",
            "pais": "ES",
            "poblacion": "Algemes\u00ed",
            "provincia": "Valencia",
            "tipo": "generica"
        },
        "nombre": "Pepe Lopez S.A.",
        "tipo_documento": "CIF"
    },
    "lineas": [
        {
            "cantidad": 2.0,
            "descuentos": [
                {
                    "tipo": "porcentaje",
                    "valor": 15.0
                }
            ],
            "formato_codigo": "",
            "formato_id": "3b3ab89d-427f-4a79-9863-2060ef5c9d0c",
            "precio": 1.5
        }
    ],
    "telefono": "+34123123123",
    "total_con_impuestos": 29.64
}
Campo Tipo Descripción
cliente_nombre string Nombre/apellidos del cliente
cliente_direccion Direccion Dirección de la entrega de pedido
comentario string Comentario del cliente/información adicional
telefono string telefono de contacto
email string dirección de correo electrónico del cliente
total_con_impuestos decimal total del pedido con impuestos que se utiliza para confirmar la valoración correcta del pedido.
identicket string Identicket. Opcional.
identificador string Identificador de pedido del cliente. Opcional.
lineas [PedidoLinea, ] lineas de pedido
idfiscal PedidoIdentificacionFiscal identificación fiscal del cliente para generar factura a su nombre/empresa. Este campo es opcional.

PedidoCRM

Representa un pedido para grabar en winfra proveniente de un sistema CRM. A diferencia de Pedido el PedidoCRM genera un pedido para el InterlocutorComercial que ya existe. 

{
    "cliente_id": "3d61abd3-d01d-42d8-ab39-50ff691d044c",
    "comentario": "servir por la ma\u00f1ana",
    "dto_pronto_pago": 1.0,
    "fecha_documento": "2020-09-18T00:00:00",
    "fecha_servicio": "2020-09-21T00:00:00",
    "identicket": "",
    "identificador": "",
    "lineas": [
        {
            "cantidad": 2.0,
            "descuentos": [
                {
                    "campana_id": "",
                    "euros": 0.0,
                    "porcentaje": 15.0,
                    "precio": 0.0,
                    "regalo": 0.0,
                    "tipo": "porcentaje"
                }
            ],
            "formato_codigo": "",
            "formato_id": "3b3ab89d-427f-4a79-9863-2060ef5c9d0c"
        }
    ]
}
Campo Tipo Descripción
cliente_id uuid identificador de InterlocutorComercial de tipo cliente. Este campo es opcional si se ha indicado cliente_codigo.
cliente_codigo string código de InterlocutorComercial de tipo cliente. Este campo es opcional.
dto_pronto_pago decimal Un porcentaje de descuento de pronto pago aplicado al documento.
comentario string comentario o información adicional
fecha_documento datetime fecha de creación/toma del pedido
fecha_servicio datetime fecha deseada de la entrega
identicket string identicket
identificador string identificador de pedido del cliente
lineas [PedidoCRMLinea, ] lineas de venta

PedidoCRMDescuento

Representa un descuento aplicado desde CRM a la linea de venta. 

{
    "campana_id": "",
    "euros": 0.0,
    "porcentaje": 15.0,
    "precio": 0.0,
    "regalo": 0.0,
    "tipo": "porcentaje"
}
Campo Tipo Descripción
campana_id uuid identificador de la campaña. Este campo es opcional.
tipo string tipo de la condicion: porcentaje, euros, precio, regalo
porcentaje decimal un porcentaje de descuento. Este campo es opcional, según el tipo.
euros decimal cantidad de euros de descuento por formato. Este campo es opcional, según el tipo.
precio decimal un precio especial aplicable en lugar de la tarifa. Este campo es opcional, según el tipo.
regalo decimal la cantidad regalada. Para un 2+1 (paga 2 llevate 3) es regalo=1 y PedidoCRMLinea.cantidad=3. Este campo es opcional, según el tipo.

PedidoCRMLinea

Representa un linea de pedido de CRM que se va a grabar en Winfra. Indica el formato_id o opcionalmente el formato_codigo. 

{
    "cantidad": 2.0,
    "descuentos": [
        {
            "campana_id": "",
            "euros": 0.0,
            "porcentaje": 15.0,
            "precio": 0.0,
            "regalo": 0.0,
            "tipo": "porcentaje"
        }
    ],
    "formato_codigo": "",
    "formato_id": "3b3ab89d-427f-4a79-9863-2060ef5c9d0c"
}
Campo Tipo Descripción
formato_id uuid identificador del formato del artículo. Este campo es opcional si se ha indicado formato_codigo
formato_codigo string código del formato del artículo. Este campo es opcional.
cantidad decimal la cantidad para entregar, incluye regalos. Indica la cantidad regalada como descuento.
descuentos [PedidoCRMDescuento, ] descuentos aplicados sobre la línea. Este campo es opcional.

PedidoCobro

Representa un cobro para grabar en winfra. 

{
    "codigo_vendedor": "VT0001",
    "entidad_cheque": "1111",
    "fecha_cobro": "2021-04-24T00:00:00",
    "fecha_emision_cheque": "2021-05-24T00:00:00",
    "fecha_vencimiento_cheque": "2021-04-24T00:00:00",
    "forma_pago": "Cheque",
    "importe": 50.0,
    "numero_cheque": "1234567891",
    "numero_documento": "F2021001",
    "oficina_cheque": "2222"
}
Campo Tipo Descripción
codigo_vendedor string Código del Vendedor.
numero_documento string Código del documento cobrados (serie+número).
fecha_cobro datetime Fecha de creación del cobro.
importe decimal Importe cobrado.
forma_pago string Forma de Pago (Efectivo,Cheque,Pagare).
numero_cheque string Número de cheque.
entidad_cheque string Entidad bancaria.
oficina_cheque string Oficina bancaria.
fecha_vencimiento_cheque datetime Fecha de vencimiento del cheque.
fecha_emision_cheque datetime Fecha de emision del cheque.

PedidoConfirmacion

Los datos necesarios para confirmar pedido subido a winfra. 

{
    "codigo_autorizacion": "003555",
    "codigo_orden": "1590751280",
    "importe": 0.0,
    "transaccion_id": "90002091-dd89-11ea-a983-54e1ade9de7d"
}
Campo Tipo Descripción
transaccion_id uuid identificador de la transacción. Subida de los pedidos devuelve el transaccion_id.
importe decimal importe cobrado de la transacción. Este valor debería coincidir con el Pedido.total_con_impuestos. El valor es obligatorio con la integración directa de los pedidos.
codigo_autorizacion string código de autorización de pago
codigo_orden string código de orden de pago

PedidoDescuento

Representa un descuento aplicado a una linea de pedido. 

{
    "tipo": "porcentaje",
    "valor": 15.0
}
Campo Tipo Descripción
tipo string tipo de la condicion: porcentaje, euros, regalo
valor decimal el descuento aplicado, según el tipo el valor representa cantidad de porcentajes, euros por unidad o cantidad regalada

PedidoIdentificacionFiscal

Identificación fiscal del cliente para la confirmación del pedido en caso que hay que generar la factura a su nombre/empresa 

{
    "codigo_documento": "B321321",
    "direccion": {
        "codigo_postal": "46680",
        "direccion": "Calle Museo 34",
        "pais": "ES",
        "poblacion": "Algemes\u00ed",
        "provincia": "Valencia",
        "tipo": "generica"
    },
    "nombre": "Pepe Lopez S.A.",
    "tipo_documento": "CIF"
}
Campo Tipo Descripción
tipo_documento string tipo del documento: CIF, DNI, ...
codigo_documento string código del documento: número del CIF, número del DNI, ...
nombre string razón social
direccion Direccion dirección fiscal del cliente

PedidoLinea

Representa un linea de pedido que se va a grabar en winfra. Indica el formato_id o opcionalmente el formato_codigo. 

{
    "cantidad": 2.0,
    "descuentos": [
        {
            "tipo": "porcentaje",
            "valor": 15.0
        }
    ],
    "formato_codigo": "",
    "formato_id": "3b3ab89d-427f-4a79-9863-2060ef5c9d0c",
    "precio": 1.5
}
Campo Tipo Descripción
formato_id uuid identificador del formato del artículo. Este campo es opcional si se ha indicado el formato_codigo
formato_codigo string código del formato del artículo. Este campo es opcional.
precio decimal precio de venta. Este campo es opcional.
cantidad decimal la cantidad vendida
descuentos [PedidoDescuento, ] descuentos aplicados a la linea. Si no esta en modo de integración directa no hace falta indicar los descuentos.

PedidoTransaccion

Indica la transacción a la que pertenece el pedido subido para grabar en winfra. Incluye información de estado de pedido. 

{
    "estado": "confirmado",
    "fecha_creacion": "2020-09-21T12:24:36",
    "transaccion_id": "90002091-dd89-11ea-a983-54e1ade9de7d"
}
Campo Tipo Descripción
transaccion_id uuid identificador de la transacción. Utilizalo para confirmar los pedidos.
fecha_creacion datetime fecha y hora de la creación de transacción - subida del pedido
estado string representa el estado del pedido:
  • desconocido - el pedido no esta en Winfra o alguien lo ha eliminado
  • sin_confirmar - el pedido está en Winfra pendiente de confirmación por la plataforma de ecommerce
  • confirmado - el pedido se ha confirmado en Winfra
  • en_preparacion - el pedido se está preparando
  • despachado - el pedido está en tránsito

RegistroIva

Representa un registro de I.V.A. 

{
    "desgloses": [
        {
            "base": 1210.0,
            "cuota_iva": 254.1,
            "cuota_recargo": 62.92,
            "grupo": "general",
            "iva": 21.0,
            "recargo": 5.2
        }
    ],
    "factura": "F20001",
    "fecha": "2020-05-30T00:00:00",
    "idfiscal": {
        "codigo_documento": "B98798757",
        "forma_juridica": "B",
        "idfiscal_id": "002e9612-4180-4644-aa36-72b201175cea",
        "nombre": "GRUPO HOSTELEROS S.L.",
        "tipo_documento": "CIF"
    },
    "numero_emitido": 20001,
    "numero_recepcion": 0,
    "serie_emitida": "F",
    "tipo": "Expedidas",
    "tipo_iva": "Repercutido"
}
Campo Tipo Descripción
idfiscal IdentificacionFiscalResumen identicación fiscal resumida
fecha datetime fecha del registro
fecha_expedicion datetime fecha de la expedición del documento original
factura string documento que identifica el registro
tipo string tipo de registro: Expedidas, Recibidas, Inversion, Intracomunitarias
tipo_iva string tipo de iva del registro: Soportado, Repercutido
numero_recepcion string número de recepción del registro
desgloses [DesgloseIva, ] lista de detalles del registro
serie_emitida string serie del documento para los documentos expedidos
numero_emitido integer numero del documento para los documentos expedidos

Ruta

Representa una ruta de reparto o una ruta de venta a la que pertenece el cliente. 

{
    "codigo": "001",
    "descripcion": "Ruta 1",
    "tipo": "venta"
}
Campo Tipo Descripción
codigo string código de ruta
descripcion string descripción de ruta
tipo string tipo de ruta, uno de: reparto, venta

ServerInfo

Contiene información sobre la instalación 

{
    "fechahora": "2020-05-24T13:37:21",
    "version": "20200524"
}
Campo Tipo Descripción
version string Numero de versión de la instalación
fechahora datetime Fecha y hora actual del servidor

Subcuenta

Representa una subcuenta contable. 

{
    "centro_coste1_codigo": "COMERC",
    "centro_coste1_descripcion": "COMERCIAL",
    "centro_coste2_codigo": "CERV",
    "centro_coste2_descripcion": "CERVEZA",
    "codigo": "4300011010",
    "descripcion": "BAR EL ABREVADERO",
    "interlocutor_comercial": "C021",
    "proyecto_codigo": "CERV",
    "proyecto_descripcion": "CERVEZA",
    "subcuenta_exportacion": "4300311010"
}
Campo Tipo Descripción
codigo string código de la subcuenta
descripcion string descripción de la cuenta
subcuenta_exportacion string número de la cuenta para exportación, si este difiere del código
interlocutor_comercial string código de interlocutor si es diferente que indica el código
centro_coste1_codigo string código del centro de costes
centro_coste1_descripcion string descripción del centro de costes
centro_coste2_codigo string código del centro de costes
centro_coste2_descripcion string descripción del centro de costes
proyecto_codigo string código de proyecto
proyecto_descripcion string descripción del proyecto

Tarifa

Representa una tarifa de precios de un artículo 

{
    "fecha_desde": "2020-06-01T00:00:00",
    "formato_codigo": "1045-24",
    "formato_id": "3b3ab89d-427f-4a79-9863-2060ef5c9d0c",
    "precio": 12.25,
    "precio_con_impuestos": 13.475
}
Campo Tipo Descripción
formato_id uuid identificador del formato del artículo
formato_codigo string código del formato del artículo
fecha_desde datetime fecha desde la que está en vigor la tarifa
precio decimal precio de tarifa del artículo
precio_con_impuestos decimal precio de tarifa del artículo incluyendo impuestos y tasas (IVA, SIG)

TipoCliente

Representa tipo de cliente/clasificación de los establecimientos. 

{
    "codigo": "bar",
    "descripcion": "BARES"
}
Campo Tipo Descripción
codigo string código del tipo
descripción string descripción del tipo

Vehiculo

Representa un vehículo. 

{
    "baja": false,
    "id": "0651c7aa-c5a7-486d-89c9-7b0f22e530c8",
    "matricula": "11-685DZY",
    "modelo": "MEGANE"
}
Campo Tipo Descripción
id uuid identificador del vehículo
modelo string modelo del vehículo
matricula string matrícula del vehículo
baja bool true si el vehículo está de baja

Venta

Representa documento de venta. 

{
    "almacen_codigo": "001",
    "almacen_nombre": "General",
    "aplicar_flete": false,
    "bultos": 1.0,
    "canal": "Z",
    "cargar_envase": "cargar",
    "cliente": {
        "codigo": "10000",
        "hash": 4153754459,
        "id": "3d61abd3-d01d-42d8-ab39-50ff691d044c",
        "nombre": "MUSEO DE LA FAUNA SALVAJE",
        "tipo": "cliente"
    },
    "delegacion": "X",
    "dto_pronto_pago": 0.0,
    "entrega": {
        "codigo_postal": "46680",
        "direccion": "Calle Museo 34",
        "pais": "ES",
        "poblacion": "Algemes\u00ed",
        "provincia": "Valencia",
        "tipo": "generica"
    },
    "estado": "Bloqueado",
    "factura_fecha": "2020-11-15T00:00:00",
    "factura_numero": 102346,
    "factura_serie": "FM",
    "fecha_documento": "2020-10-28T00:00:00",
    "fecha_servicio": "2020-10-28T00:00:00",
    "forma_pago": "1",
    "forma_pago_descripcion": "CONTADO",
    "hash": 456724,
    "id": "3b433c26-7032-11eb-82dd-54e1ade9de7d",
    "idfiscal": {
        "codigo_documento": "G98798798",
        "direccion": {
            "codigo_postal": "46680",
            "direccion": "Calle Museo 34",
            "pais": "ES",
            "poblacion": "Algemes\u00ed",
            "provincia": "Valencia",
            "tipo": "generica"
        },
        "forma_juridica": "V",
        "idfiscal_id": "05cd76fc-8236-4bfb-a5a2-dfe55647356e",
        "nombre": "Fundacion Pepe Lopez",
        "tipo_documento": "DNI"
    },
    "lineas": [
        {
            "cantidad_entrega": 1.0,
            "cantidad_pedido": 1.0,
            "cantidad_valoracion": 1.0,
            "cargo_abono_adicional": 0.0,
            "codigogrupo": 0,
            "coste_dimension1": null,
            "coste_dimension2": null,
            "coste_dimension3": {
                "clave_dimension": "P",
                "codigo": "CERV",
                "descripcion": "CERVEZA",
                "id": "94a3365a-2cd2-11ec-9784-54e1ade9de7d",
                "nivel": 1,
                "tipo_dimension": "Organizacion"
            },
            "coste_dimension4": null,
            "descripcion_modificable": "",
            "dotacion_apoyo_comercial": 0.0,
            "dotacion_comision_servicio": 0.0,
            "dotacion_contrato": 0.0,
            "dotacion_descuento_recuperable": 0.0,
            "dotacion_rappel": 0.0,
            "dotacion_referencia": "",
            "envase_codigo": "",
            "envase_id": "",
            "envase_nombre": "",
            "euros_descuento_operativo": 0.0,
            "formato_codigo": "LI106",
            "formato_id": "fc0e5e6d-4ad6-4ebc-a2ea-da2ff30d3107",
            "formato_nombre": "BARRIL CERVEZA 30 L.",
            "importe_azucar": 0.0,
            "importe_cesion": 0.0,
            "importe_presupuesto": 0.0,
            "importe_sig": 0.0,
            "impuestoenvase": 0.0,
            "impuestoliquido": 3.0,
            "litros": 30.0,
            "lote_codigo": "",
            "lote_descripcion": "",
            "orden": 0,
            "peso_neto": 30.0,
            "precio": 30.0,
            "precio_coste": 21.0,
            "precio_envase": 0.0,
            "tarifa_codigo": "3",
            "total": 30.0,
            "totalconimpuestos": 33.0,
            "totalenvase": 0.0,
            "totalliquido": 30.0,
            "valor_azucar": 0.0,
            "valor_coeficientecarga": 1.0,
            "valor_coste": 21.0,
            "valor_flete": 0.0,
            "valor_margen": 2.0,
            "valor_sig": 0.0,
            "valorimpuesto": "10.00",
            "valorimpuestoenvase": ""
        }
    ],
    "matricula": "ABC0102",
    "numero": 820,
    "numero_pedido": "P147",
    "organizacion_venta": "GENERAL",
    "peso_bruto": 30.0,
    "proveedor": null,
    "punto_venta_codigo": "10000",
    "punto_venta_descripcion": "MUSEO DE LA FAUNA SALVAJE",
    "repartidor": {
        "clave_dimension": "repartidor",
        "codigo": "RP005",
        "id": "00301270-6e90-407d-813d-b2d26fc526ac",
        "idfiscal": {
            "codigo_documento": "B98798646",
            "forma_juridica": "B",
            "idfiscal_id": "002e9612-4180-4644-aa36-72b201175emp",
            "nombre": "FRANCISCO MONTES MONTES",
            "tipo_documento": "CIF"
        },
        "nombre": "PACO MONTES"
    },
    "responsable": {
        "clave_dimension": "repartidor",
        "codigo": "RP005",
        "id": "00301270-6e90-407d-813d-b2d26fc526ac",
        "idfiscal": {
            "codigo_documento": "B98798646",
            "forma_juridica": "B",
            "idfiscal_id": "002e9612-4180-4644-aa36-72b201175emp",
            "nombre": "FRANCISCO MONTES MONTES",
            "tipo_documento": "CIF"
        },
        "nombre": "PACO MONTES"
    },
    "responsable_codigo": "4.V",
    "responsable_nombre": "RAFAEL",
    "ruta_reparto": {
        "codigo": "002",
        "descripcion": "Ruta 2",
        "tipo": "reparto"
    },
    "serie": "20T/",
    "tipo_documento": "Factura Directa",
    "tipo_facturacion": "Factura Diaria",
    "total": 30.0,
    "total_con_impuestos": 33.0,
    "transaccion_id": "88fa2b73-7b2f-4d01-a98c-7a2ed800731f"
}
Campo Tipo Descripción
almacen_codigo string código de almacén
almacen_nombre string nombre de almacén
aplicar_flete bool true si aplicamos flete
bultos decimal numero de bultos servidos
cargar_envase string indica si hay que cargar los envases: cargar, nocargar, documento_aparte
cliente InterlocutorComercialResumen cliente de la venta
dto_pronto_pago decimal descuento de pronto pago aplicado (en porcentajes)
entrega Direccion dirección de la entrega
estado string estado de documento. Ej.: Bloqueado, Facturado
fecha_documento datetime fecha de creación/valoración de la venta
fecha_servicio datetime fecha del servicio/entrega
forma_pago string código de la forma de pago
formato_descripcion string descripción de la forma de pago
hash integer valor de hash para identificar la versión del registro. Este valor cambia cada vez que la venta cambia.
idfiscal IdentificacionFiscal identificación fiscal de la venta
id uuid identificador de la venta
lineas [VentaLinea, ] líneas de venta
numero integer numero de documento de venta
organizacion_venta string organización de venta
proveedor InterlocutorComercialResumen proveedor de la venta en caso de servicio por cuenta de terceros (intermediación)
punto_venta_codigo string código del punto de venta
punto_venta_descripcion string descripción del punto de venta
responsable Empleado responsable de la venta
responsable_codigo string código del responsable
responsable_nombre string nombre del responsable
serie string serie de documento de venta
tipo_documento string tipo del documento Ej.: Albaran_Preventa, Factura_Directa, Factura_Rectificativa
tipo_facturacion string tipo de facturación
total_con_impuestos decimal total de la venta con impuestos
total decimal total de la venta antes de aplicar IVA
transaccion_id uuid Identificador de la transaccion para confirmar el pedido con /pedidocrm_confirmar/.
El campo solo esta disponible si la venta se ha creado con /pedidocrm_valorar/.
delegacion string clave de dimensión del centro de costes
canal string clave de dimensión del centro de costes
matricula string matricula del vehículo de reparto
repartidor Empleado empleado que reparte el documento
ruta_reparto Ruta ruta en la que se reparte el documento
peso_bruto decimal total peso del documento
factura_serie string serie de la factura si el documento esta facturado
factura_numero integer numero de la factura si el documento esta facturado
factura_fecha datetime fecha de la factura si el documento esta facturado
numero_pedido string número de pedido del que procede el albarán

VentaLinea

Representa una linea de venta 

{
    "cantidad_entrega": 1.0,
    "cantidad_pedido": 1.0,
    "cantidad_valoracion": 1.0,
    "cargo_abono_adicional": 0.0,
    "codigogrupo": 0,
    "coste_dimension1": null,
    "coste_dimension2": null,
    "coste_dimension3": {
        "clave_dimension": "P",
        "codigo": "CERV",
        "descripcion": "CERVEZA",
        "id": "94a3365a-2cd2-11ec-9784-54e1ade9de7d",
        "nivel": 1,
        "tipo_dimension": "Organizacion"
    },
    "coste_dimension4": null,
    "descripcion_modificable": "",
    "dotacion_apoyo_comercial": 0.0,
    "dotacion_comision_servicio": 0.0,
    "dotacion_contrato": 0.0,
    "dotacion_descuento_recuperable": 0.0,
    "dotacion_rappel": 0.0,
    "dotacion_referencia": "",
    "envase_codigo": "",
    "envase_id": "",
    "envase_nombre": "",
    "euros_descuento_operativo": 0.0,
    "formato_codigo": "LI106",
    "formato_id": "fc0e5e6d-4ad6-4ebc-a2ea-da2ff30d3107",
    "formato_nombre": "BARRIL CERVEZA 30 L.",
    "importe_azucar": 0.0,
    "importe_cesion": 0.0,
    "importe_presupuesto": 0.0,
    "importe_sig": 0.0,
    "impuestoenvase": 0.0,
    "impuestoliquido": 3.0,
    "litros": 30.0,
    "lote_codigo": "",
    "lote_descripcion": "",
    "orden": 0,
    "peso_neto": 30.0,
    "precio": 30.0,
    "precio_coste": 21.0,
    "precio_envase": 0.0,
    "tarifa_codigo": "3",
    "total": 30.0,
    "totalconimpuestos": 33.0,
    "totalenvase": 0.0,
    "totalliquido": 30.0,
    "valor_azucar": 0.0,
    "valor_coeficientecarga": 1.0,
    "valor_coste": 21.0,
    "valor_flete": 0.0,
    "valor_margen": 2.0,
    "valor_sig": 0.0,
    "valorimpuesto": "10.00",
    "valorimpuestoenvase": ""
}
Campo Tipo Descripción
cantidad_entrega decimal cantidad de mercancía entregada
cantidad_pedido decimal cantidad de mercancía pedida (cantidad original del pedido)
cantidad_valoracion decimal cantidad de mercancía para valorar la línea. Normalmente coincide con cantidad entregada, pero indica peso en los artículos de peso
cargo_abono_adicional decimal cargos adicionales como flete
codigogrupo integer identificador de grupo de las lineas, para imprimir ciertas lineas juntas
descripcion_modificable string descripción de la línea alternativa
dotacion_apoyo_comercial decimal apoyo proveedor fuera factura compra
dotacion_comision_servicio decimal comision de servicios terceros/intermediaciones
dotacion_contrato decimal dotacion contratos fabricantes con clientes comprados
dotacion_descuento_recuperable decimal Descuento a liquidar con el proveedor
dotacion_rappel decimal Descuento diferido o rapel a cliente
dotacion_referencia string Numero de referencia del contrato de rapel
envase_codigo string código de envase
envase_id uuid id del formato del envase asociado o vacío si el envase no es aplicable
envase_nombre string nombre de envase
euros_descuento_operativo decimal total descuento aplicado sobre la linea
formato_codigo string código de formato
formato_id uuid id del formato
formato_nombre string nombre de formato
importe_azucar decimal importe total de impuesto de bebidas azucaradas
importe_cesion decimal importe total de la cesion del gasto abonada por el proveedor
importe_presupuesto decimal objetivo en importe
importe_sig decimal importe total del SIG (punto verde)
impuestoenvase decimal total cuotas de IVA aplicadas sobre envase asociado
impuestoliquido decimal total cuotas de IVA aplicadas sobre liquido
lote_codigo string código de lote de los artículos, si la linea es parte de un lote
lote_descripcion string descripción de lote de los artículos, si la linea es parte de un lote
orden integer orden de las lineas
precio_coste decimal precio de coste
precio_envase decimal precio de envase asociado
precio decimal precio aplicado sobre la línea
tarifa_codigo string código de tarifa aplicado
totalconimpuestos decimal total de la linea incluyendo los impuestos
totalenvase decimal total del envase asociado
totalliquido decimal total del liquido
total decimal total de la linea
valor_azucar decimal tasa de impuesto de bebidas
valor_coeficientecarga decimal coeficiente de carga
valor_coste decimal precio de coste medio
valor_margen decimal margen unitario
valor_flete decimal tasa de flete
valor_sig decimal tasa de SIG (punto verde)
valorimpuestoenvase string una representación de porcentaje de IVA aplicado a envase, ej.: 10
valorimpuesto string una representación de porcentaje de IIVA aplicado a liquido, vacío si hay varios impuestos aplicados
coste_dimension1 CentroCoste coste dimensión nivel 1
coste_dimension2 CentroCoste coste dimensión nivel 2
coste_dimension3 CentroCoste coste dimensión nivel 3
coste_dimension4 CentroCoste coste dimensión nivel 4
peso_neto decimal indica peso neto de la linea (peso del producto por cantidad)
litros decimal indica litros de la linea (litros de producto por cantidad)

VentaResumen

Representa un resumen del documento de venta. 

{
    "bultos": 1.0,
    "estado": "Bloqueado",
    "fecha_documento": "2020-10-28T00:00:00",
    "fecha_servicio": "2020-10-28T00:00:00",
    "hash": 456724,
    "id": "3b433c26-7032-11eb-82dd-54e1ade9de7d",
    "numero": 820,
    "serie": "20T/",
    "tipo_documento": "Factura Directa",
    "total": 30.0,
    "total_con_impuestos": 33.0
}
Campo Tipo Descripción
bultos decimal numero de bultos servidos
estado string estado de documento. Ej.: Bloqueado, Facturado
fecha_documento datetime fecha de creación/valoración de la venta
fecha_servicio datetime fecha del servicio/entrega
hash integer valor de hash para identificar la versión del registro. Este valor cambia cada vez que la venta cambia.
id uuid identificador de la venta
numero integer numero de documento de venta
serie string serie de documento de venta
tipo_documento string tipo del documento Ej.: Albaran Preventa, Factura Directa, Factura Rectificativa
total_con_impuestos decimal total de la venta con impuestos
total decimal total de la venta antes de aplicar IVA