Esqueleto de la llamada:
| Code Block | ||
|---|---|---|
| ||
{
"auth": {
"usuario": "USUARIO_DESARROLLADOR",
"password": "PASSWORD_DESARROLLADOR"
},
"service": {
"provision": "Cliente",
"operacion": "alta_cobro"
},
"parameters": {
"sesion": {
"usuario": "a",
"claveSesion": "74cda059acc66cf0737657686fb0963a"
},
"cobros": [],
"mediospagos": [{
"idMedioCobro": "Efectivo",
"idPlanCuenta": "Caja en pes",
"Banco": "",
"nroCheque": "",
"fechaValidez": "",
"importe": 100,
"VAD": "S",
"Conciliado": "",
"idTabla": 0,
"idElemento": 0,
"idItem": 0
}],
"estesoreria": "0",
"idUsuario": "a@colppy.com",
"idCobro": "",
"idCliente": "*ID DEL CLIENTE AL QUE QUIERO APLICARLE EL PAGO*",
"idEmpresa": "*ID DE LA EMPRESA EN CUESTION*,",
"nroRecibo1": "0001",
"nroRecibo2": "00000364",
"fechaCobro": "16-08-2016",
"idEstadoCobro": "Aprobado",
"descripcion": "Pago",
"valorCambio": "0",
"totalEsteCobro": 0,
"anticipo": 0,
"descuentos": 0,
"intereses": 0,
"retencionIIBB": 0,
"totalACobrar": 0,
"idMedioCobro": "Efectivo",
"totalCobrado": 100,
"retencionOtras": 0,
"retsufridas": [],
"retsufridasotras": []
}
} |
Ejemplo de respuesta exitosa:
| Code Block | ||
|---|---|---|
| ||
{
"service": {
"provision": "Cliente",
"operacion": "alta_cobro",
"version": "1_0_0_0",
"response_date": "2016-08-18 13:53:53"
},
"result": {
"estado": 0,
"mensaje": "La operación se realizó correctamente"
},
"response": {
"success": true,
"message": "Cobro validado con exito",
"fechaFactura": "2016-08-16",
"estesoreria": "0",
"idCobro": "562"
}
} |
Ejemplo de respuesta Erronea:
| Code Block | ||
|---|---|---|
| ||
{ "service": { "provision": "Cliente", "operacion": "alta_cobro", "version": "1_0_0_0", "response_date": "2016-08-18 13:51:11" }, "result": { "estado": 0, "mensaje": "La operación se realizó correctamente" }, "response": { "success": false, "message": "Ya existe una recibo con el número de recibo 0001-00000364" } } |
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 | Integer | NO | 0 | Simpre 0 | Todos los países | |||
idUsuario | Usuario de colppy | String | SI | es correo con el que accede a Colppy | Todos los países | |||
idCobro | Id del cobro | Integer | SI | Vacio si es un nuevo pago | Todos los países | |||
idCliente | Id del cliente para el cual se crea el recibo | integer | SI | |||||
idEmpresa | Id de la empresa que crea el recibo | integer | SI | 98 | ||||
nroRecibo1 | Nro de talonario | Alfanumérico(4) | SI | |||||
nroRecibo2 | Nro de pago | Alfanumérico(8) | Si | |||||
fechaCobro | Fecha de cobro | Fecha | SI | Formato 'dd-mm-aaaa' | ||||
idEstadoCobro | Estado del cobro | custom | Si | Aprobado / Anulado | ||||
valorCambio | Valor de tipo de cambio | integer | SI | Siempre valor 0 | ||||
totalEsteCobro | Sumatoria del total de Comprobantes aplicados | decimal | NO | |||||
anticipo | anticipo | Monto en concepto de anticipo | decimal | SI | ||||
descuentos | Monto de Descuentos | decimal | NO | |||||
intereses | Monto de Intereses | decimal | NO | |||||
retGanancias | Monto de retencion de ganancias indicado en idRetGanacias1 | decimal | NO | |||||
retIVA | Retención de IVA | decimal | ||||||
retSUSS | Retención de SUSS | decimal | ||||||
retencionIIBB | Monto de Retención IIBB | decimal | NO | |||||
IIBBLocal | ||||||||
totalACobrar | Total a cobrar | decimal | SI | |||||
idMedioCobro | Medio de Cobro | Ver apéndice de Medios de Cobro | SI | |||||
totalCobrado | Total cobrado | decimal | SI | |||||
retencionOtras | Sumatoria del total de otras retenciones | decimal | NO | |||||
retsufridas | Retenciones IIBB | custom | NO | (ver detalle más adelante) | ||||
retsufridasotras | Retenciones | NO |
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 | |||
| Banco | |||||||
| 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 | |||||
| Conciliado | Esta Conciliado | NO | N / C o vacio | Todos los países |
Cobros
| 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 | Fecha | SI | Formato 'dd-mm-aaaa' | Todos los países | ||
| importe | Importe del Cobro | SI | Todos los países | ||||
| CED | Interno | NO | S | Siempre 'S' | Todos los países | ||
| Conciliado | Esta Conciliado | NO | N / C o vacio | Todos los países |
retsufridas(Retenciones IIBB)
| Nombre | Descripción | Tipo de dato | Límite | Obligatorio | Posibles valores | Observación | Disponibilidad |
|---|---|---|---|---|---|---|---|
| jurisdiccion | Jurisdicción | ver Provincias en Apendice en Argentina/ Consultar Provición Empresa → listar_municipiosICA | |||||
| nroCertificado | Nro de certificado retencioón | Alfanumerico | |||||
| importeRet | Importe de la retención | decimal |
retsufridasotras(Otras Retenciones)| Nombre | Descripción | Tipo de dato | Límite | Obligatorio | Posibles valores | Observación | Disponibilidad |
|---|---|---|---|---|---|---|---|
| tipoRetencion | Jurisdicción | ver Provincias en Apendice | Argentina: IVA/SUSS/Ganancias Colombia:Renta/IVA
| ||||
| nroCertificado | Nro de certificado retencioón | Alfanumerico | |||||
| importeRet | Importe de la retención | decimal |