Árbol del API · Tipos › CollectionInput
Datos de un cobro nuevo
CollectionInput
Los datos para registrar un cobro con createCollection y, si quieres, aplicarlo a facturas del cliente en la misma operación.
Envía los identificadores como texto ("1311"), la fecha con hora y
desfase, y los importes y el tipo de cambio como texto decimal
("13432.00").
Campos
15
| Campo | Tipo | Descripción |
|---|---|---|
amountMoney! |
Money! | Importe recibido, mayor que cero, en la moneda de la cuenta bancaria. Obligatorio. |
applications[CollectionApplicationInput!] |
[CollectionApplicationInput!] | Facturas del cliente a las que se aplica el cobro, hasta 100 y sin repetir factura. Si no aplicas, omítelo o envía []: con null la petición responde HTTP 422.
|
bankAccountIdID! |
ID! | Cuenta bancaria de la empresa donde se recibió el pago; debe ser del banco de bankId. Su moneda es la moneda del cobro.
Obligatorio.
|
bankIdID! |
ID! | Banco donde se recibió el pago. Obligatorio. |
cobdorIdID |
ID | Cobrador del cobro; debe ser un empleado marcado como cobrador. |
customerIdID! |
ID! | Cliente que hizo el pago. Obligatorio. |
dateDateTime! |
DateTime! | Fecha y hora en que se recibió el pago, con su desfase horario, p. ej. "2026-10-24T10:15:00-06:00". Es la fecha de pago que llevará el complemento de pago.
Obligatorio.
|
exchangeRateDecimal |
Decimal | Tipo de cambio del cobro en pesos por unidad de la moneda extranjera, mayor que cero, p. ej. "17.250000". Si lo omites se usa el vigente en AdvantaCloud para la moneda de la cuenta; si no hay uno vigente, la petición responde HTTP 422. Es obligatorio para aplicar un cobro en pesos a una factura en dólares.
|
paymentMethodIdID! |
ID! | Forma de cobro, de paymentMethodOptions. Si es con tarjeta (card: true), el cobro pide terminalId.
Obligatorio.
|
referenceString |
String | Referencia del pago, p. ej. la clave de rastreo de la transferencia. |
terminalIdID |
ID | Terminal bancaria de un cobro con tarjeta, activa, de bankTerminals; si la terminal tiene cuenta bancaria o empresa, deben ser las del cobro. Con otra forma de cobro se ignora.
|
tpcbroString |
String | Tipo de cobro, Cobro o Anticipo. Si lo omites, Cobro.
|
userIdID |
ID | Usuario activo de AdvantaCloud a nombre de quien se registra el cobro. Obligatorio con Llave API, aunque el schema lo marque opcional. |
warehouseIdID! |
ID! | Almacén del cobro. Si no envías xcumId, el cobro toma la unidad de negocio del almacén.
Obligatorio.
|
xcumIdID |
ID | Unidad de negocio del cobro, si no es la del almacén. Las facturas que apliques deben ser de esta unidad de negocio, salvo que la empresa permita repartir cobros entre unidades. |
Dónde se usa
Schema del 26 oct 2026 · Descargar schema.graphql¿Algo no cuadra? Repórtalo en ayuda.advanta.mx