Saltar al contenido
Falmus

Sincronizar puntos de venta

POST/api/v1/sucursales/:branchId/puntos-venta/sincronizar

Consulta los puntos de venta oficiales registrados en SIAT para una sucursal y los crea o actualiza localmente. No elimina registros históricos que no aparezcan en la respuesta oficial.

Contrato de la operación

Consulta los puntos de venta oficiales registrados en SIAT para una sucursal y los crea o actualiza localmente. No elimina registros históricos que no aparezcan en la respuesta oficial.

Autorización

Requiere únicamente X-API-Key con permiso sucursales.administrar. La clave determina el NIT y ambiente. branchId es el UUID de una sucursal de esa empresa; el código SIAT se resuelve internamente. No envíes Bearer, X-Tenant-ID, Idempotency-Key, CUIS ni Token Delegado.

La integración SIAT activa debe corresponder a la sucursal indicada. Falmus usa internamente el Token Delegado y CUIS cifrados; nunca los expone ni los registra en la respuesta.

Respuestas

200 OK devuelve un resumen de los cambios aplicados. Si el CUIS anterior fue invalidado, la primera solicitud autenticada solicita otro automáticamente antes de sincronizar. 400 indica UUID inválido; 404, sucursal inexistente para la empresa; 409, otra sincronización en curso; 422, credenciales SIAT rechazadas; 503, indisponibilidad temporal del SIAT.

Ejemplo

Solicitud de ejemplo

Clave ficticia; no se ejecuta desde esta página
cURL · POST
export FALMUS_API_URL='https://staging-api.falmus.com/api/v1'
export FALMUS_API_KEY='flm_test_REEMPLAZA_CON_TU_CLAVE'
export BRANCH_ID='REEMPLAZA_CON_BRANCH_ID'

curl --request POST \
  --url "$FALMUS_API_URL/sucursales/${BRANCH_ID}/puntos-venta/sincronizar" \
  --header "X-API-Key: $FALMUS_API_KEY"

Este ejemplo no incluye un cuerpo. Revisa el contrato para conocer los parámetros de ruta y consulta.

Respuesta

Ejemplo de respuesta

200 OKapplication/json
JSON
{
  "message": "puntos de venta sincronizados",
  "data": {
    "creados": 1,
    "actualizados": 0,
    "cerrados": 0,
    "totalSiat": 1
  }
}

Datos ficticios; los identificadores y valores cambian en cada respuesta.