BRIDGE API - REST - Consulta de grupos de facturación

Fecha	Versión	Descripción	Autor
	1.0	Creación del documento	Andrea Veronica Asato

Este documento detalla el servicio de consulta sobre los grupos de facturación que se hayan enviado a Bridge API desde un sistema externo, con el fin de ser facturados en Bridge POS.

Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/billOrderGroup/query
1. Ejemplo: https://200.100.100.100:8090/billOrderGroup/query
Se invoca vía POST
Habilitado en tienda

Primero se debe invocar al servicio de autenticación para obtener un token.
Cuando se llama a cualquier servicio este token se envía como un parámetro más de la llamada en el header (x-access-token.
Si al llamar al servicio el token expiró, se recibirá respuesta de token inválido y se deberá volver a pedir uno nuevo.

Ver BRIDGE API - REST – Autenticación: token

Ejemplo de request con CURL:

curl --location --request POST 'https://200.100.100.100:8090/billOrderGroup/query' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientId":"bridge-api-client",
    "clientSecret":"DA39A3EE5E6B4B0D3255BFEF95601890AFD80709"
}'

clientId deben ser reemplazado por la autentificación
clientSecret deben ser reemplazado por la autentificación

Para todos los servicios se tiene un default de cantidad de registros a devolver de los primeros 3000

Si se desea ampliar la consulta, se debe enviar como parámetro el campo "max" pudiendo combinarse con el parámetro "skip" pudiendo ir solicitando la cantidad de registros siguientes en la respuesta. El skip indica la cantidad de registros a saltear en la próxima consulta.

Los parámetros max y skip en el servicio de consulta, a fin de limitar la cantidad de registros obtenidos.

El parámetro max determina la cantidad máxima de registros a obtener. Tiene tope según la SystemProperty system.apiQueryServicesMaxQtyRegister.

Napse > BRIDGE API - REST - Consulta de grupos de facturación > image-2025-10-2_11-55-6.png

El parámetro skip se utiliza para paginar los resultados.

Estos parámetros son opcionales y se envían en el cuerpo de la solicitud junto a los filtros requeridos.

-------------------

Ejemplo "skip": 500 saltea los primeros 500 registros informando los siguientes hasta la cantidad máxima indicada en el parámetro "max".

En caso de ser la primer consulta, indicarlo en 0

{
"max": 2000,
"skip": 0

}

Descripción:

billOrderGroup

Grupo de documentos a facturar: grupo de documentos enviados por un sistema externo para ser retomados y facturados en BRIDGE POS. Este servicio permite obtener información del estado de comandas con el uso de filtros que permitan reducir el resultado obtenido

Campos de filtro disponibles

Campo	Tipo	Descripción	Requerido	Ejemplo
DateTimeFrom	Date	Fecha y hora desde Formato "DD-MM-YYYY HH:MM"	No	`"2023-04-12 18:00"`
DateTimeTo	Date	Fecha y hora hasta Formato "DD-MM-YYYY HH:MM"	No	`"2023-04-12 20:00"`
ExternalNumber	String	Nro de grupo de facturación o comanda	No	"A1234"
Status	String	Estado de la comanda	No	"cancelled"
Store	String	Código de la tienda	No	"T1"

Respuesta

Por cada grupo de facturación o comanda, se informará:

Campo	Tipo	Descripción	Ejemplo
storeCode	String	Código de la tienda	"T1"
externalNumber	String	Código del grupo de documentos o comanda	"A1234"
internalNumber	String	Código de la comanda asignada por BRIDGE	"0000T1000009"
notes	String	Notas de la comanda
partyCode	String	Código del cliente	"19509604"
partyName	String	Nombre y apellido del cliente	"Juan Perez"
status	String	Estado de la comanda	"cancelled"
createdAt	Date	Fecha y hora de creación
updatedAt	Date	Fecha y hora de actualización
cancelledBy	String	Cancelado por	"Job"

Estados de una comanda:

Código del estado	Nombre del estado	Descripción
created	Abierto	El grupo de facturación o comandas ha ingresado a Bridge tienda
cancelled	Cancelado	El grupo de facturación o comandas ha sido cancelado a demanda por el operador o por el job de cancelación automática (por superar el tiempo definido)
invoiced	Facturado	El grupo de facturación o comandas fue facturado

{
    "ack": 0,
    "data": [
                {            
                    "storeCode": "T1",
                    "externalNumber": "A1234",
                    "internalNumber": "0000T1000009",
                    "notes": "notas",
                    "partyCode": "19509604",
                    "partyName": "Juan Perez",
                    "status": "cancelled",
                    "createdAt": "2025-09-01 19:33:21.506Z", 
                    "updatedAt": "2025-09-01 21:33:21.506Z",  
                    "cancelledBy": "Job"   
                  },
                    {                                
                    "storeCode": "T1", 
                    "externalNumber": "A1244",
                    "internalNumber":"0000T1000039",
                    "notes": "notas",
                    "partyCode": "425009604",
                    "partyName": "María López",
                    "status": "cancelled",
                    "createdAt": "2025-09-01 19:43:21.506Z", 
                    "updatedAt": "2025-09-01 21:43:21.506Z",  
                    "cancelledBy": "Job"   
                  }
              }  
            ]
        }