Facturas

Consultar todas las facturas

Consulta una lista paginada de todas las facturas del negocio actual.

Autenticación requerida: Este endpoint requiere autenticación Bearer Token. Usar el campo tokenCurrent obtenido del servicio de login (/login) en el header: Authorization: Bearer {tokenCurrent}

Soporta múltiples filtros para búsqueda específica y paginación para manejo eficiente de grandes volúmenes de datos.

Limitaciones plan trial: Las cuentas en periodo de prueba solo pueden ver facturas de las últimas 24 horas.

Ejemplos de Uso

1. Consultar todas las facturas (primera página)

GET /invoices?pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui

Consulta las primeras 10 facturas ordenadas por fecha de creación.

2. Buscar facturas pagadas de hoy

GET /invoices?status=Pagada&dateInit=2025-08-05T00:00:00.000Z&dateEnd=2025-08-05T23:59:59.999Z
Authorization: Bearer tu_token_aqui

Filtra facturas con estado 'Pagada' creadas en el día actual.

3. Facturas de entrega a domicilio

GET /invoices?onlyDelivery=true&deliveryProvider=RAPPI
Authorization: Bearer tu_token_aqui

Consulta solo facturas que incluyen entrega a domicilio con Rappi.

4. Facturas por método de pago

GET /invoices?paymentMethodName=Efectivo&pagination=true&limit=20&page=1
Authorization: Bearer tu_token_aqui

Filtra facturas pagadas con efectivo, página 2 (20 elementos por página).

5. Facturas electrónicas exitosas

GET /invoices?type=FacturaElectronica&statusFE=00&statusSiigo=200
Authorization: Bearer tu_token_aqui

Consulta facturas electrónicas aceptadas por DIAN e integradas exitosamente con Siigo.

get/invoices

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/invoices
  • Auth
    HTTP bearer

Query parameters

paginationboolean

Activar paginación de resultados

limitinteger

Número máximo de facturas por página (máximo 5000)

pageinteger

Número de página (inicia en 0)

numberstring

Buscar por número específico de factura

status'Pendiente' | 'Pagada' | 'Anulada' | 'Todos'

Filtrar por estado de la factura

type'Normal' | 'FacturaElectronica'

Filtrar por tipo de factura

clientIdstring

Filtrar por ID del cliente

paymentMethodNamestring

Filtrar por método de pago

tableIdstring

Filtrar por ID de mesa

cashierIdstring

Filtrar por ID del cajero

deliveryProvider'RAPPI' | 'UBER_EATS' | 'DIDI_FOOD' | 'INTERNAL'

Filtrar por proveedor de entrega

onlyDeliveryboolean

Mostrar solo facturas con entrega a domicilio

deliveryGuyIdstring

Filtrar por ID del repartidor

dateInitstring date-time

Fecha inicial para filtrar facturas

dateEndstring date-time

Fecha final para filtrar facturas

cashboxstring

Filtrar por ID de caja registradora

statusFE'00' | '99'

Estado de facturación electrónica DIAN (00=Aceptada, 99=Con errores)

statusSiigo'200' | '400'

Estado de integración con Siigo (200=Exitosa, 400=Con errores)

statusLoggro'200' | '400'

Estado de integración con Loggro (200=Exitosa, 400=Con errores)

typeSort'asc' | 'desc'

Orden de clasificación por fecha de creación

cashBoxRegisterstring

Filtrar por registrador de caja específico o 'withoutCashbox' para facturas sin caja

paidInvoicesboolean

Mostrar solo facturas con crédito (que tienen fecha de vencimiento)

Response

Lista de facturas obtenida exitosamente

_idstring

ID único de la factura

businessIdstring

ID del negocio al que pertenece la factura

numberstring

Número de la factura

invoicePrefixstring

Prefijo de la factura

seqnumber

Número secuencial de la factura

totalnumber

Total de la factura

totalPaidnumber

Total pagado

status'Pendiente' | 'Pagada' | 'Anulada'

Estado de la factura

type'Normal' | 'FacturaElectronica'

Tipo de factura

deliveryCostnumber

Costo de entrega

createdOnstring date-time

Fecha de creación

modifiedOnstring date-time

Fecha de última modificación

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "businessId": "507f1f77bcf86cd799439012",
    "business": {
      "name": "Restaurante El Buen Sabor",
      "nit": "123456789-1",
      "address": "Calle 123 #45-67"
    },
    "number": "FAC-001",
    "invoicePrefix": "FAC",
    "seq": 1,
    "products": [
      {
        "name": "Hamburguesa Clásica",
        "quantity": 2,
        "price": 15000
      }
    ],
    "total": 35000,
    "totalPaid": 35000,
    "status": "Pagada",
    "type": "Normal",
    "table": {
      "name": "Mesa 5"
    },
    "client": {
      "name": "Juan Pérez",
      "phone": "+57 300 123 4567"
    },
    "cashier": {
      "name": "María González"
    },
    "paid": {
      "paymentMethodValue": {
        "paymentMethod": "Efectivo"
      }
    },
    "eInvoice": {
      "DIAN": {
        "dianState": "00"
      }
    },
    "externalIntegration": {
      "siigo": {
        "statusCode": 200
      },
      "loggro": {
        "statusCode": 200
      }
    },
    "createdOn": "2025-08-05T10:30:00.000Z",
    "modifiedOn": "2025-08-05T10:30:00.000Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.