Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Petición para Cobro en Cuenta

...

...

Peticion alta_cobro en cuenta corriente

...

Code Block

...

language

...

json

...

{
	"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": "usuario@colppy.com",
			"claveSesion": "74cda059acc66cf0737657686fb0963a"
		},
		"cobros": [], //se usa para aplicar Facturas de no alicar el pago debe ir tal cual esta sin datos
		"mediospagos": [{
			"idMedioCobro": "Transferencia",
			"idPlanCuenta": "Santander",
			"Banco": "",
			"nroCheque": "",
			"fechaValidez": "",
			"importe": 888,
			"VAD": "S",
			"Conciliado": "",
			"idTabla": 0,
			"idElemento": 0,
			"idItem": 0
		}],
		"estesoreria": "0",
		"idUsuario": "dario.rebora@colppy.com",
		"idCobro": "",
		"idCliente": "2946676",
		"idEmpresa": "24928",
		"nroRecibo1": "8888",
		"nroRecibo2": "00009088",
		"fechaCobro": "05-11-2019",
		"idEstadoCobro": "Aprobado",
		"descripcion": "",
		"valorCambio": "0",
		"totalEsteCobro": 0,
		"saldoFacturas": 405,
		"anticipo": 0,
		"descuentos": 0,
		"intereses": 0,
		"retencionIIBB": 0,
		"totalACobrar": 0,
		"idMedioCobro": "Transferencia",
		"totalCobrado": 888,
		"retencionOtras": 0,
		"retsufridas": [],
		"retsufridasotras": [],
		"diferenciaTipoCambio": 0
	}
}


Petición para cobro con factura aplicada


Peticion alta_cobro con factura aplicada
Code Block
language

...

json
{
	"auth": {
		"usuario": "USUARIO_DESARROLLADOR",
		"password": "PASSWORD_DESARROLLADOR"
	},
	"service": {
		"provision": "Cliente",
		"operacion": "alta_cobro"
	},
	"parameters": {
		"sesion": {
			"usuario": "dario.rebora@colppy.com",
			"claveSesion": "163a316809a738ae2be9f12ed9a40c30"
		},
		"cobros": [
		{                                //Pago total de la factura
			"idFactura": "7049964", 
			"nroFactura": "0001-00000123",
			"tipoComprobante": "FAV",
			"fechaPago": "02-10-2019",
			"moneda": "",
			"descripcion": "Factura de Ventas",
			"currency": null,
			"tcCobroRate": "",
			"rate": null,
			"totalFactura": "53.24",
			"cobrado": 0,
			"saldoAnterior": 53.24,
			"esteCobro": 53.24,
			"esteCobroMe": "",
			"Saldo": 0,
			"pagar": true
		}, 
		{                                   ///Pago Parcial
			"idFactura": "7050083",
			"nroFactura": "0001-00000114",
			"tipoComprobante": "FAV",
			"fechaPago": "02-10-2019",
			"moneda": "",
			"descripcion": "Factura de Ventas",
			"currency": null,
			"tcCobroRate": "",
			"rate": null,
			"totalFactura": "551.76",
			"cobrado": 0,
			"saldoAnterior": 551.76,
			"esteCobro": 146.76,
			"esteCobroMe": "",
			"Saldo": 405
		}],
		"mediospagos": [{
			"idMedioCobro": "Transferencia",
			"idPlanCuenta": "Santander",
			"Banco": "",
			"nroCheque": "",
			"fechaValidez": "",
			"importe": 200,
			"VAD": "S",
			"Conciliado": "",
			"idTabla": 0,
			"idElemento": 0,
			"idItem": 0
		}],
		"estesoreria": "0",
		"idUsuario": "dario.rebora@colppy.com",
		"idCobro": "",
		"idCliente": "2946676",
		"idEmpresa": "24928",
		"nroRecibo1": "0222",
		"nroRecibo2": "00456456",
		"fechaCobro": "05-11-2019",
		"idEstadoCobro": "Aprobado",
		"descripcion": "",
		"valorCambio": "0",
		"totalEsteCobro": 200,
		"saldoFacturas": 551.76,
		"anticipo": 0,
		"descuentos": 0,
		"intereses": 0,
		"retencionIIBB": 0,
		"totalACobrar": 200,
		"idMedioCobro": "Transferencia",
		"totalCobrado": 200,
		"retencionOtras": 0,
		"retsufridas": [],
		"retsufridasotras": [],
		"diferenciaTipoCambio": 0
	}
}


Ejemplo de respuesta exitosa:

...

...

Respuesta alta_cobro exitosa

...

Code Block

...

language

...

js

...

{
    "service": {
        "provision": "Cliente",
        "operacion": "alta_cobro",
        "version": "1_0_0_0",
        "response_date": "2019-11-05 12:01:42"
    },
    "result": {
        "estado": 0,
        "mensaje": "La operación se realizó correctamente"
    },
    "response": {
        "success": true,
        "message": "Cobro validado con exito",
        "fechaFactura": "2019-11-05",
        "estesoreria": "0",
        "idCobro": "1238275"
    }
}

Ejemplo de respuesta Erronea:

...

Respuesta alta_cobro erronea

...

Code Block

...

language

...

js
{
    "service": {
        "provision": "Cliente",
        "operacion": "alta_cobro",
        "version": "1_0_0_0",
        "response_date": "2019-11-05 12:04:03"
    },
    "result": {
        "estado": 0,
        "mensaje": "La operación se realizó correctamente"
    },
    "response": {
        "success": false,
        "message": "Ya existe una recibo con el número de recibo 8888-00009088"
    }
}

Listado de parámetros disponibles:


Nombre

Descripción

Tipo de dato

Límite

Obligatorio

Posibles valores

Observación


Code Block
cobros


custom


NO


(ver detalle más adelante)

Todos los países

Code Block
mediospagos


custom


NO


(ver detalle más adelante)

Todos los países

Code Block
estesoreria


Integer


NO

0

Simpre 0

Todos los países

Code Block
idUsuario

Usuario de colppy

String


SI


es correo con el que accede a Colppy

Todos los países

Code Block
idCobro

Id del cobro

Integer


SI


Vacio si es un nuevo pago

Todos los países

Code Block
idCliente

Id del cliente para el cual se crea el recibo

integer


SI




Code Block
idEmpresa

Id de la empresa que crea el recibo

integer


SI

98



Code Block
nroRecibo1

Nro de talonario

Alfanumérico(4)


SI




Code Block
nroRecibo2

Nro de pago

Alfanumérico(8)


Si




Code Block
fechaCobro

Fecha de cobro

Fecha


SI


Formato 'dd-mm-aaaa'


Code Block
idEstadoCobro

Estado del cobro

custom


Si


Aprobado / Anulado


Code Block
valorCambio

Valor de tipo de cambio

integer


SI


Siempre valor 0


Code Block
totalEsteCobro

Sumatoria del total de Comprobantes aplicados

decimal


NO




Code Block
anticipo

anticipo

Monto en concepto de anticipo

decimal

SI




Code Block
descuentos

Monto de Descuentos

decimal


NO




Code Block
intereses

Monto de Intereses

decimal


NO




Code Block
retGanancias

Monto de

...

retsufridasotras

...

retención de ganancias indicado en idRetGanacias1

decimal


NO




Code Block
retIVA
Code Block
Retención de IVA
Code Block
decimal






Code Block
retSUSS

Retención de SUSS

decimal






Code Block
retencionIIBB

Monto de Retención IIBB

decimal


NO




Code Block
IIBBLocal








Code Block
totalACobrar

Total a cobrar

decimal


SI




Code Block
idMedioCobro

Medio de Cobro

Ver apéndice de Medios de Cobro


SI




Code Block
totalCobrado

Total cobrado

decimal


SI

...

retencionOtras

...

retsufridas

...




Code Block
retencionOtras

Sumatoria del total de otras retenciones

decimal


NO




Code Block
retsufridas

Retenciones IIBB

custom


NO


(ver detalle más adelante)


Code Block
retsufridasotras

Retenciones



NO




tcCobroRate

Tipo de cambio

decimal

NO

rate

Tipo de cambio

decimal

NO

replicar como tcCobroRate

totalFactura

toda la factura con iva con todo

decimal

Si

cobrado

si la factura tenia un cobro parcial

decimal

Si

sino tenía un cobro anterior parcial va 0

saldoAnterior

lo que le queda a la factura. Saldo pendiente.

decimal

No

esteCobro

lo que le esta cobrando a esa factura

decimal

Si

saldoFacturas

total del saldo que le queda de lo que debe, no de lo que esta en este cobro

decimal

Si

totalACobrar

suma de todas las facturas menos las retenciones

decimal

Si


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 de Tesorería tal como

...

figura en dicho módulo.

Alfanumérico


SI



Todos los países

Banco








nroCheque

Número de cheque

...

Numérico


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

...

vacío


Todos los países


Cobros  


Nombre

Descripción

Tipo de dato

Límite

Obligatorio

Posibles valores

Observación

Disponibilidad

idFactura

identificador de la Factura a aplicar

numérico


NO



Todos los países

nroFactura

Nombre de la Cuenta como figura en el Plan de Cuentas de la Empresa.

Alfanumérico


NO



Todos los países

tipoComprobante

FAV, NCV, REC (según apéndice)

Numérico


NO



Todos los países

fechaPago

Fecha de vencimiento del comprobante a aplicar

Fecha


NO


Formato 'dd-mm-aaaa'

Todos los países

moneda

moneda del comprobante a aplicar

numérico


NO

...

vacío o 1

...

vacío

Todos los países

totalFactura

Importe total de la factura a aplicar

decimal


NO

S

Siempre 'S'

Todos los países

cobrado

Importe ya aplicado anteriormente a esa factura

decimal


NO

N / C o

...

vacío


Todos los países

saldoAnterior

Saldo de la factura al momento de registrar el cobro

decimal


NO



Todos los países

esteCobro

Importe a aplicar a la Factura en este cobro que se está registrando

decimal


NO


Formato 'dd-mm-aaaa'

Todos los países

Saldo

Importe del Cobro

decimal


NO



Todos los países

pagar

Interno



NO

S

Siempre 'S'

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 →

Code Block
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

...

retención

Alfanumerico






importeRet

Importe de la retención

decimal