> ## Documentation Index
> Fetch the complete documentation index at: https://docs.filexpress.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar planillas (v2)

> Igual que v1 (`GET /hr/payrolls`), con `branch_id` plano en cada planilla y el filtro `branch_id`. Solo planillas procesadas o pagadas.

**Permiso requerido:** `hr.payrolls`



## OpenAPI

````yaml /api-reference/openapi.json get /v2/hr/payrolls
openapi: 3.0.3
info:
  title: FileXpress API Externa
  version: 1.0.0
  description: >-
    API para integrar sistemas de terceros con FileXpress: facturación, RRHH,
    contabilidad, inventario, proyectos, cuentas por cobrar y pagar, tesorería,
    precios y promociones y caja. URL base vigente: /api/external/v1. La ruta
    heredada sin versión (/api/external) se elimina el 1 de enero de 2027; migre
    a /api/external/v1 (mismos endpoints, solo cambia la URL base). La API v2
    (/api/external/v2) expone monedas y tasas de cambio, ventas y compras con
    moneda extranjera, impuestos por id, planillas con sucursal y errores con
    `code` estable; sus operaciones llevan el prefijo /v2 en la ruta. Se sugiere
    migrar a las rutas v2 disponibles antes del 30 de marzo de 2027.
servers:
  - url: https://api.filexpress.app/api/external/v1
    description: Producción
security:
  - ApiKey: []
tags:
  - name: General
  - name: Facturación · Ventas
  - name: Facturación · Compras
  - name: Facturación · Clientes
  - name: Facturación · Proveedores
  - name: Facturación · Productos
  - name: Catálogos
  - name: RRHH · Empleados
  - name: RRHH · Asistencia
  - name: RRHH · Reglas laborales
  - name: RRHH · Horarios
  - name: RRHH · Feriados
  - name: RRHH · Resultados de asistencia
  - name: RRHH · Permisos
  - name: RRHH · Planillas
  - name: Contabilidad
  - name: Inventario
  - name: Proyectos
  - name: Cuentas por cobrar
  - name: Cuentas por pagar
  - name: Tesorería
  - name: Precios y promociones
  - name: Caja
  - name: Puntos de venta
  - name: API v2 · General
  - name: API v2 · Monedas y tasas
  - name: API v2 · Países
  - name: API v2 · Ventas
  - name: API v2 · Compras
  - name: API v2 · Planillas
paths:
  /v2/hr/payrolls:
    get:
      tags:
        - API v2 · Planillas
      summary: Listar planillas (v2)
      description: >-
        Igual que v1 (`GET /hr/payrolls`), con `branch_id` plano en cada
        planilla y el filtro `branch_id`. Solo planillas procesadas o pagadas.


        **Permiso requerido:** `hr.payrolls`
      parameters:
        - name: start_date
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: end_date
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - processed
              - paid
        - name: branch_id
          in: query
          required: false
          description: Solo las planillas de esa sucursal.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Éxito
          content:
            application/json:
              example:
                status: true
                data:
                  - id: 5f0e8d1a-3c2b-4a7e-9d4f-6b1c2a3e4f50
                    name: Primera quincena octubre 2026
                    start_date: '2026-10-01'
                    end_date: '2026-10-15'
                    status: paid
                    employees: 12
                    total_net_amount: 4820.35
                    branch_id: 7c1d4e2a-9b3f-4a6e-8d5c-0f2a1b3c4d5e
                    cost_center_id: null
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '429':
          $ref: '#/components/responses/E429'
components:
  responses:
    E401:
      description: API Key ausente o inválida
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integración sin el permiso requerido o desactivada
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E429:
      description: Límite de peticiones excedido
      content:
        application/json:
          example:
            status: false
            message: Rate limit exceeded. Please try again later.
            rate_limit: 100
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key de la integración (Integraciones → Nueva Integración).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.