ItemsListar ítems anulados

Listar ítems anulados

GEThttps://api.copayex.com/api/v1/items/void

Parámetros de solicitud

CampoTipoUbicaciónRequeridoDescripción
pageSizenumberQueryNoCantidad por página.
pageIndexnumberQueryNoPágina (base 0).
querystringQueryNoTexto libre.
dateFromstring (ISO8601)QueryNoFecha inicial.
dateTostring (ISO8601)QueryNoFecha final.

Parámetros de respuesta

Devuelve una lista paginada de ítems en estado void. Campos principales:

CampoTipoDescripción
idnumberIdentificador interno del ítem.
numbernumberConsecutivo recomendado para su uso en frontend.
uuidstringIdentificador global (UUID) del ítem.
amountnumberMonto total configurado.
amountPayednumberMonto pagado hasta la fecha.
titlestringNombre del ítem.
descriptionstringDescripción opcional.
status"active" | "finished" | "void"Estado actual (aquí será void).
paymentMethodsstring[]Métodos de pago habilitados.
staticQrstring | nullnull si no hay QR; de lo contrario, ID del QR asociado.
createdAtstring (ISO8601)Fecha de creación.
pageIndexnumberÍndice actual cuando se envían parámetros de paginado.
pageSizenumberCantidad de registros por página aplicada.
totalnumberTotal de ítems que cumplen con los filtros.

Ejemplos de solicitud

curl -G "https://api.copayex.com/api/v1/items/void" \
  -H "Authorization: Bearer <client_access_token>" \
  --data-urlencode "pageIndex=0" \
  --data-urlencode "pageSize=20"

Respuesta de ejemplo

[
  {
    "uuid": "a1474c92-f58e-4066-9421-2cdf0e06e435",
    "id": 15,
    "amount": 1200,
    "amountPayed": 0,
    "number": 13,
    "title": "Combo latte",
    "description": "cafe + medialunas",
    "createdAt": "2025-11-11T21:44:01.000Z",
    "status": "void",
    "paymentMethods": ["mercadopago"],
    "staticQr": null
  }
]