Comprobaciones:
- La sesión es válida (si están activadas las sesiones).
- Se comprueba que se pase el id de la empresa.
- Se comprueba que se pase el id de cliente.
{
"auth": {
"usuario":"USUARIO_API", //Ingresar el usuario dado de alta en dev.colppy.com
"password": "USUARIO_PASSWORD" //Contraseña en MD5 de usuario de dev.colppy.com
},
"service": {
"provision": "Cliente",
"operacion": "alta_cobro"
},
"parameters": {
"sesion": {
"usuario": "a",
"claveSesion": "8ca69e8354b2d2995ac20e7226a8091f"
},
"cobros": [
{
"idFactura": "4420",
"nroFactura": "0001-00001658",
"tipoComprobante": "FAV",
"fechaPago": "17-07-2014",
"moneda": "",
"totalFactura": "20.00",
"cobrado": "0.00",
"saldoAnterior": 20,
"esteCobro": 20,
"Saldo": 0,
"pagar": true
}
],
"mediospagos": [
{
"idMedioCobro": "Cheque Recibido Comun",
"idPlanCuenta": "Valores a Depositar",
"Banco": "",
"nroCheque": "",
"fechaValidez": "17/07/2014",
"importe": "20.00",
"VAD": "S"
}
],
"estesoreria": "0",
"idUsuario": "a",
"idCobro": "",
"idCliente": "2070",
"idEmpresa": "98",
"nroRecibo1": "0001",
"nroRecibo2": "00000336",
"fechaCobro": "17-07-2014",
"idEstadoCobro": "Aprobado",
"valorCambio": "0",
"totalEsteCobro": "20.00",
"saldoFacturas": "0.00",
"anticipo": "0.00",
"descuentos": "0.00",
"intereses": "0.00",
"retGanancias": "0.00",
"retIVA": "0.00",
"retSUSS": "0.00",
"retencionIIBB": "0.00",
"IIBBLocal": "",
"totalACobrar": "20.00",
"idMedioCobro": "Cheque Recibido Comun",
"totalCobrado": "20.00"
}
}
Errores posibles
- ID de empresa faltante.
- ID de cliente faltante.
- No se encuentra el cliente.
Respuesta (éxito)
{"service": {
"provision": "Cliente",
"operacion": "alta_cobro",
"version": "1_0_0_0",
"response_date": "2014-07-18 08:48:29"
},
"result": {
"estado": 0,
"mensaje": "La operación se realizó correctamente"
},
"response": {
"success": true,
"message": "Cobro validado con exito",
"fechaFactura": "2014-07-17",
"estesoreria": "0",
"idCobro": "407"
}
}Esqueleto de la llamada:
Code Block | ||
---|---|---|
| ||
{
"auth": {
"usuario": "ColppyAPI",
"password": "9410c05b7bfadea3ab7b573180862222"
},
"service": {
"provision": "Cliente",
"operacion": "alta_cobro"
},
"parameters": {
"sesion": {
"usuario": "a",
"claveSesion": "74cda059acc66cf0737657686fb0963a"
},
"cobros": [{
"idFactura": "12010",
"nroFactura": "0002-00000217",
"tipoComprobante": "FAV",
"fechaPago": "24-02-2016",
"moneda": "",
"totalFactura": "27.83",
"cobrado": 0,
"saldoAnterior": 27.83,
"esteCobro": "0.00",
"Saldo": 27.83
}],
"mediospagos": [{
"idMedioCobro": "Efectivo",
"idPlanCuenta": "Caja Chica $",
"Banco": "",
"nroCheque": "",
"fechaValidez": "",
"importe": 148.83,
"VAD": "S",
"Conciliado": "",
"idTabla": 0,
"idElemento": 0,
"idItem": 0
}],
"estesoreria": "0",
"idUsuario": "a",
"idCobro": "",
"idCliente": "2956",
"idEmpresa": "98",
"nroRecibo1": "0001",
"nroRecibo2": "00000359",
"fechaCobro": "16-08-2016",
"idEstadoCobro": "Aprobado",
"descripcion": "test",
"valorCambio": "0",
"totalEsteCobro": 148.83,
"saldoFacturas": 2464.35,
"anticipo": 0,
"descuentos": 0,
"intereses": 0,
"retencionIIBB": 0,
"totalACobrar": 148.83,
"idMedioCobro": "Efectivo",
"totalCobrado": 148.83,
"retencionOtras": 0,
"retsufridas": [],
"retsufridasotras": []
}
} |
Listado de parámetros disponibles:
Nombre | Descripción | Tipo de dato | Límite | Obligatorio | Posibles valores | Observación | ||
---|---|---|---|---|---|---|---|---|
cobros | custom | NO | (ver detalle más adelante) | Todos los países | ||||
mediospagos | custom | NO | (ver detalle más adelante) | Todos los países | ||||
estesoreria | ||||||||
idUsuario | ||||||||
idCobro | ||||||||
idCliente | ||||||||
idEmpresa | ||||||||
nroRecibo1 | ||||||||
nroRecibo2 | ||||||||
fechaCobro | ||||||||
idEstadoCobro | ||||||||
valorCambio | ||||||||
totalEsteCobro | ||||||||
saldoFacturas | ||||||||
anticipo | ||||||||
descuentos | ||||||||
intereses | ||||||||
retGanancias | ||||||||
retIVA | ||||||||
retSUSS | ||||||||
retencionIIBB | ||||||||
IIBBLocal | ||||||||
totalACobrar | ||||||||
idMedioCobro | ||||||||
totalCobrado |
Medios de pago
Nombre | Descripción | Tipo de dato | Límite | Obligatorio | Posibles valores | Observación | Disponibilidad |
---|---|---|---|---|---|---|---|
idMedioPago | Medio de Pago | Ver apéndice de Medios de Pago | SI | Todos los países | |||
idPlanCuenta | Nombre de la Cuenta como figura en el Plan de Cuentas de la Empresa. | Alfanumérico | SI | Todos los países | |||
nroCheque | Número de cheque | Numerico | NO | Todos los países | |||
fechaValidez | Fecha de validez del pago | Todos los países | |||||
importe | Importe del pago | Todos los países | |||||
idTabla | ??? | Todos los países | |||||
idElemento | ??? | Todos los países | |||||
idItem | ??? | Todos los países | |||||
CED | ?? | NO | S / N | Todos los países | |||
Conciliado | Esta Conciliado | NO | N / C o vacio | Todos los países |
Nombre | Descripción | Tipo de dato | Límite | Obligatorio | Posibles valores | Observación | Disponibilidad |
---|---|---|---|---|---|---|---|
idMedioPago | Medio de Pago | Ver apéndice de Medios de Pago | SI | Todos los países | |||
idPlanCuenta | Nombre de la Cuenta como figura en el Plan de Cuentas de la Empresa. | Alfanumérico | SI | Todos los países | |||
nroCheque | Número de cheque | Numerico | NO | Todos los países | |||
fechaValidez | Fecha de validez del pago | Todos los países | |||||
importe | Importe del pago | Todos los países | |||||
idTabla | ??? | Todos los países | |||||
idElemento | ??? | Todos los países | |||||
idItem | ??? | Todos los países | |||||
CED | ?? | NO | S / N | Todos los países | |||
Conciliado | Esta Conciliado | NO | N / C o vacio | Todos los países |