Skip to content

Documentación API Sage 200 - Tandem Software

Novedades versión4.3.1

En esta versión se introduce la compatibilidad con multiempresa, lo que permite que un mismo cliente pueda trabajar con varias empresas dentro de la misma API.

  • Si el cliente dispone de varias empresas, la API solicitará el parámetro codigoEmpresa al inicio de cada petición. Este valor se validará de forma dinámica en función de la configuración del cliente.

  • Si el cliente solo tiene una empresa, el campo codigoEmpresa no será necesario. En este caso, la API tomará automáticamente el código correspondiente desde la configuración interna del cliente.

Unificación de endpoints “custom”

  • Los antiguos endpoints custom han sido integrados dentro de los endpoints estándar. Ahora, puedes personalizar la información devuelta mediante el nuevo campo campos.

  • En los endpoints de listado (por ejemplo, /api/clientes o /api/articulos), el campo campos permite indicar qué datos adicionales quieres incluir junto a los campos base (codigoCliente, cifDni, etc.). Si no se indica el campo campos, la API devuelve únicamente los campos estándar.

  • En los endpoints GET individuales (por ejemplo, al buscar un cliente o artículo concreto), el parámetro campos también puede usarse como una lista de nombres separados por comas.
    Ejemplo:
    ?campos=domicilio,codigoContable
    Si se omite, la API devuelve el objeto completo como hasta ahora.

Campos adicionales en peticiones POST

  • En los endpoints de creación o modificación (POST) para documentos, clientes, proveedores y artículos, se ha añadido el objeto camposAdicionales.

  • Este objeto permite incluir tus propios campos personalizados definidos en tu base de datos, además de los campos estándar de Sage 200.
    Ejemplo:

    {
    "miCampoPersonalizado": "valor1",
    "referenciaInterna": "ABC123"
    }

    Así puedes extender el modelo sin perder compatibilidad con la estructura base.

Mejoras en la gestión de artículos

  • El endpoint POST /api/common/ventas/articulos ahora solicita los parámetros codigoArticulo y tipoArticulo a través de la query, en lugar de enviarlos por el cuerpo de la petición.

  • El parámetro tipoArticulo puede seleccionarse desde una lista de valores disponibles:

    • Material
    • Inmaterial
    • Comentario
  • Se mantiene la compatibilidad con la configuración anterior, permitiendo que codigoArticulo y tipoArticulo siga enviándose en el body para clientes que ya tengan la integración implantada.

Filtrado de documentos por estado

  • El endpoint

    /api/common/documentos/{tipoDocumento}/{codigoCliente}/{page}/{pageSize}

    ahora incluye el nuevo parámetro estado, que permite filtrar los documentos según su situación actual.

  • Los valores disponibles de estado dependen del tipo de documento:

    Tipo de documentoEstados disponibles
    Pedidopendiente | servido
    Albaránfacturado | no facturado
    Ofertapendiente | servido
    Contratooferta | aceptado | finalizado
  • Si no se indica el parámetro estado, la API devolverá todos los documentos del cliente sin aplicar ningún filtro adicional.

  • Este nuevo campo puede combinarse con otros filtros como fechaInicio, fechaFin o numeroDocumento para acotar los resultados.

Adjuntar documentos

  • Ahora es posible adjuntar un fichero a un documento existente en la API.
    El tipo de documento debe seleccionarse entre las opciones válidas (por ejemplo, FacturaVenta, PedidoVenta, etc.).

  • Se han añadido dos nuevos endpoints:

    • POST /api/common/documentos/adjuntardocumento – Permite subir el archivo mediante Form-Data.
    • POST /api/common/documentos/adjuntardocumentobase64 – Permite enviar el contenido del archivo en Base64 dentro del cuerpo JSON.
  • Ambos métodos vinculan el archivo al documento indicado y lo dejan disponible para su consulta posterior.