Saltar al contenido
Facturador

Listar clientes o proveedores (scroll)

GET /api/persons/records-scroll/{person_type}

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Lista para scroll infinito con paginación por cursor, ordenada por nombre. person_type: customers o suppliers.

Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).

Formato de respuesta: listado con paginación por cursor {success, data[], pagination: {next_cursor, has_more}}. Sin el campo success: devuelve {data[], pagination: {next_cursor, has_more}}.

Reglas:

  • limit máximo 100 (por defecto 20).
  • Hoy la búsqueda por input se combina con OR de forma que el tipo de la URL solo se aplica a la coincidencia por número: con input vacío o que coincida por nombre pueden aparecer también personas del otro tipo. Filtra por tu lado si necesitas exactitud.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
person_type ruta sí customers
input query no Texto a buscar en nombre o número de documento.
identity_document_type_id query no 6 Filtra por tipo de documento (1 DNI, 6 RUC...).
enabled query no 1 1 solo habilitados, 0 solo inhabilitados.
limit query no 15 Registros por página, de 1 a 100. Por defecto 15.
cursor query no Valor de pagination.next_cursor de la respuesta anterior para obtener la página siguiente.

Respuestas

200 — Página

{
  "data": [
    {
      "id": 25,
      "description": "20601234567 - COMERCIAL NORTE E.I.R.L.",
      "name": "COMERCIAL NORTE E.I.R.L.",
      "number": "20601234567",
      "addresses": [
        {
          "id": 8,
          "trade_name": null,
          "country_id": "PE",
          "location_id": [
            "04",
            "0401",
            "040101"
          ],
          "address": "CALLE MERCADERES 456, AREQUIPA",
          "phone": "054223344",
          "email": "almacen@comercialnorte.pe",
          "main": false,
          "department_id": "04",
          "province_id": "0401",
          "district_id": "040101",
          "establishment_code": "0001",
          "has_consigned": false,
          "consigned_id": null,
          "consigned_name": null
        }
      ],
      "identity_document_type_id": "6",
      "identity_document_type_code": "6",
      "address": "AV. PRINCIPAL 123, LIMA",
      "telephone": "987654321",
      "country_id": "PE",
      "district_id": "150101",
      "email": "compras@comercialnorte.pe",
      "enabled": true,
      "selected": false,
      "identity_document_type_description": "RUC",
      "location_id": [
        "15",
        "1501",
        "150101"
      ]
    }
  ],
  "pagination": {
    "next_cursor": "eyJuYW1lIjoiQ09NRVJDSUFMIn0",
    "has_more": true
  }
}

Pruébalo

Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.