Para dar un seguimiento completo a las facturas, Factura Gorila permite a sus usuarios registrar los pagos a sus facturas.

Con estos registros se puede analizar datos y generar reportes y otra información útil para un usuario sobre las entradas de dinero a su empresa.

Idealmente una Factura debe ser pagada inmediatamente después de ser entregada, sin embargo, en la vida real esto es un poco distinto. Para dar un seguimiento más apegado a la realidad, Factura Gorila permite registrar uno o varios pagos por factura y una Factura no se considera como Pagada hasta que el total de los pagos cubre el total de la factura. Cada pago registrado incluye datos como la fecha, el método de pago o la cuenta bancaria donde se efectuó el pago, ya que estos datos pueden o no ser distintos por pago.

 

Análisis de datos

Existen 2 análisis de datos sobre los pagos:

  1. Facturación Reciente: Se puede acceder a estos datos a través la propiedad Usuario.FacturacionReciente del objeto Usuario. Factura Gorila presenta estos datos en forma de una gráfica, sin embargo, la aplicación cliente es libre de mostrar esta información como le convenga
  2. Reporte de Pagos: Existe un reporte de los pagos efectuado en cierto periodo. Para ver los detalles sobre cómo obtener el reporte véase la sección de Reportes.

 

Obtener una lista de pagos

La lista de pagos solo se puede obtener conociendo un identificador de factura (Factura.FacturaId)

Petición

Se accede en la siguiente url por método GET

https://app.facturagorila.com/v1/api/pagos?facturaid={id}

En este caso el parámetro “facturaid” es obligatorio y debe corresponder a un Factura.FacturaId válido, existente y que no esté en estado Borrador. Los datos de este punto no están paginados, siempre se entrega la lista completa.

Respuesta

Ejemplo (JSON)

{
   "TotalResultados":2,
   "CantidadPorPagina":2,
   "TotalDePaginas":1,
   "PaginaActual":0,
   "TipoDatoResultado":"Pago",
   "Resultados":[
      {
         "PagoId":99,
         "Cantidad":0.2000,
         "Notas":null,
         "Fecha":"2013-03-13T15:00:05",
         "FacturaId":1178,
         "CuentaBancariaId":35,
         "DescripcionCuentaBancaria":"0000",
         "MetodoDePagoId":1,
         "DescripcionMetodoPago":"Efectivo"
      },
      {
         "PagoId":100,
         "Cantidad":0.1000,
         "Notas":null,
         "Fecha":"2013-03-13T15:02:28",
         "FacturaId":1178,
         "CuentaBancariaId":35,
         "DescripcionCuentaBancaria":"0000",
         "MetodoDePagoId":1,
         "DescripcionMetodoPago":"Efectivo"
      }
   ]
}

 

Obtener un Pago

Petición

Conociendo el id de un pago, se puede acceder a la siguiente url por método GET

https://app.facturagorila.com/v1/api/pagos/{id}

Respuesta

Ejemplo (JSON)

{
   "PagoId":97,
   "Cantidad":0.8900,
   "Notas":null,
   "Fecha":"2013-03-13T13:55:55",
   "FacturaId":1179,
   "CuentaBancariaId":35,
   "DescripcionCuentaBancaria":"0000",
   "MetodoDePagoId":1,
   "DescripcionMetodoPago":"Efectivo"
}

 

Insertar un Pago

Petición

Se acceder a la siguiente url por método POST

https://app.facturagorila.com/v1/api/pagos/

Se recibe como parámetro un objeto Pago completo

Ejemplo:

{
   "MetodoDePagoId":1,
   "CuentaBancariaId":35,
   "Cantidad":"0.200000",
   "FacturaId":1178,
   "Fecha":"2013-03-13T15:46:25"
}

Respuesta

Se retorna el objeto recién insertado. Además se incluye en el HTTP header Location una url al elemento recién insertado.

Ejemplo (JSON)

{
   "Fecha":"2013-03-13T15:46:25",
   "DescripcionCuentaBancaria":"0000",
   "MetodoDePagoId":1,
   "DescripcionMetodoPago":"Efectivo",
   "CuentaBancariaId":35,
   "Cantidad":0.2,
   "PagoId":106,
   "FacturaId":1178,
   "Notas":null
}

 

Actualizar un Pago

No se permite actualizar los datos de un pago. Lo que se puede hacer es borrar un pago existente y crear uno nuevo.

 

Borrar un Pago

Petición

Se acceder a la siguiente url por método DELETE

https://app.facturagorila.com/v1/api/pagos/{id}

Respuesta

Un código HTTP 200 en caso de éxito