developers Entrar a AdvantaCloud
Árbol del API · Facturas y cobranza › collectionsConnection

Lista de cobros

collectionsConnection

Tipo

Query

Devuelve

CollectionConnection!

Permiso de la llave

Consultar Cobros

Página

20 por omisión · máx. 100

Estable

Lista los cobros de la empresa con su importe, su forma de cobro y las facturas a las que se aplicaron. Filtra por cliente y por fecha del pago, y recorre el resultado por páginas con cursores.

Úsala para saber qué pagos recibió la empresa y a qué facturas se aplicaron; con customerId ves los cobros de un cliente. El saldo que queda en cada factura está en invoicesConnection.

La llave ve los cobros de toda la empresa del subdominio, sin importar quién los registró.

collectionsConnection(
  first: Int  after: String  customerId: ID  from: Date
  to: Date
): CollectionConnection!

Argumentos

5

ArgumentoTipoDescripción
Paginación
firstInt Int

Cuántos cobros devolver desde el inicio o desde after. Sin first llegan 20; si pides más de 100 recibes 100.

afterString String

Cursor de la página anterior (pageInfo.endCursor). Devuelve los cobros que siguen.

Filtros
customerIdID ID

Sólo los cobros de este cliente.

fromDate Date

Pagos recibidos desde este día, inclusive (AAAA-MM-DD).

toDate Date

Pagos recibidos hasta este día, inclusive. Con Llave API el día se corta en la hora del centro de México.

Estatus de un cobro

CollectionStatus

REGISTEREDRegistrado, sin aplicar a facturas
PARTIALLY_APPLIEDAplicado en parte; le queda importe por aplicar
APPLIEDAplicado completo a facturas
RECONCILEDAplicado y conciliado con el banco
CANCELLEDCancelado
UNKNOWNSin equivalente; revisa rawStatus

Ver CollectionStatus

Lo que devuelve

CollectionConnection!

nodes[Collection]Los cobros de esta página. La forma más corta de leerlos.
edges[CollectionEdge]Los mismos cobros, cada uno con su cursor.
pageInfoPageInfo!Dónde estás en la lista.
hasNextPageBoolean!Hay más elementos después de esta página.
endCursorStringCursor del último elemento; pásalo en after para pedir la página siguiente.
hasPreviousPageBoolean!true si pediste esta página con after, es decir, si no es la primera.
startCursorStringCursor del primer elemento de esta página.

Campos principales de Collection

CampoTipoDescripción
idID! ID! Identificador del cobro; úsalo con collection(id:) y con paymentComplement(collectionId:).
statusCollectionStatus! CollectionStatus! Estatus del cobro.
dateDateTime DateTime Fecha y hora en que se recibió el pago. Es la fecha de pago que lleva el complemento de pago.
amountMoney Money Importe recibido, en la moneda de la cuenta bancaria que lo recibió.
currencyString String Clave SAT de la moneda del cobro, p. ej. MXN o USD.
paymentMethodPaymentMethod PaymentMethod Forma de cobro.
referenceString String Referencia del pago, p. ej. la clave de rastreo de una transferencia.
tpcbroString String Tipo de cobro, Cobro o Anticipo.
applicationsCollectionApplicationConnection! CollectionApplicationConnection! Las facturas a las que se aplicó el cobro, con el importe aplicado a cada una, por su último cambio.20 por omisión, hasta 100 por página.
receiptPdfUrlString String Liga al PDF del complemento de pago que incluye el cobro, aunque todavía no esté timbrado. Llega null mientras el cobro no está en un complemento. Está firmada y vence a los 10 minutos.

Ver todos los campos de Collection

Paginación

first · after

Pide hasta 100 cobros por página junto con pageInfo. Repite la misma consulta pasando endCursor en after mientras hasNextPage sea true. El orden es estable: no se saltan cobros entre páginas. Más sobre paginación.

Página 1

first: 100
endCursor: "WzEs…MTAwXQ"
hasNextPage: true

Página 2

after: "WzEs…MTAwXQ"
endCursor: "WzEs…MjAwXQ"
hasNextPage: true

Página 3

after: "WzEs…MjAwXQ"
endCursor: "WzEs…MjQ3XQ"
hasNextPage: false

Los cobros llegan por su última modificación, del más antiguo al más reciente: si uno cambia de estatus mientras recorres la lista, pasa al final y puede llegar otra vez con sus datos al día. Las aplicaciones de cada cobro (applications) son otra conexión con su propio límite de 100; si un cobro tiene más, pide el resto con collection(id:) y applications(after:).

Permisos

Llave API Integraciones

Consultar Cobros

La llave ve los registros de toda la empresa del subdominio.

Sin el permiso Sin error

La consulta responde sin error, pero nodes llega vacío y hasNextPage es false.

Así lo conserva el API para las integraciones que ya lo usan: revisa los permisos de la llave si una lista llega vacía sin razón.

Errores

CódigoCuándo ocurreQué hacer
HTTP 401Falta el header Authorization o la llave no existe en la empresa del subdominio. La respuesta no trae cuerpo.Revisa la llave y el subdominio. No reintentes.
argumentLiteralsIncompatibleUna fecha escrita en la consulta no es AAAA-MM-DD. Si el valor llega en una variable, el error trae extensions.problems y puede no traer code.Corrige la consulta; reintentar no ayuda.
VALIDATIONEl cursor de after está mal formado o es de otra lista, o first es negativo. También aplica al cursor de applications.Empieza de nuevo sin after y usa sólo cursores de pageInfo.
HTTP 422Falla interna o dato rechazado al guardar. El cuerpo es {"error": …}, sin data.Si no cambiaste nada, reintenta con espera exponencial.

Los errores de la consulta llegan con HTTP 200 en errors, con su código en extensions.code. Revisa siempre errors, no sólo el estatus HTTP. Errores y reintentos.

Relacionadas

Schema del 26 oct 2026 · Ver cambios¿Algo no cuadra? Repórtalo en ayuda.advanta.mx