API AustroSoft

API de información financiera:

Producción Sudamericano: http://wrk_uesudamericano.academicloud.net
Producción Promoción Social: http://wrk_promsocial.academicloud.net
Pruebas:  http://wrk_stage.academicloud.net

Recuperar todos los estudiantes matriculas por período o año lectivo con sus datos de facturación:

EndPoint: api/financiero/buscar_estudiantes_por_periodo/{periodo_id}
Method: GET
Params:
  • {periodo_id}: código del año lectivo a consultar Ej. 2015, 2016, 2017. Este código siempre será el primer año en la denominación de un período, por ejemplo para el período 2017-2018 el código será 2017.
Request Ejemplo: GET /api/financiero/buscar_estudiantes_por_periodo/2017
Resultado: Estructura JSON:

  • grupo: grado o curso en el que está matriculado
  • estudiante_id: código único del estudiante, el mismo código se mantendrá durante toda su vida institucional.
  • identificacion: cédula o pasaporte del estudiante
  • apellidos: apellidos del estudiante
  • nombres: nombres del estudiante
  • facturacion_ci_ruc: número de identificación para facturación
  • facturacion_nombre: nombre para dato de facturación
  • facturacion_telefono: nombre para dato de facturación
  • facturacion_direccion: nombre para dato de facturación
  • facturacion_correo: nombre para dato de facturación
  • facturacion_tipo_identificacion: tipo de identificación según tabla del  SRI.
Ejem. Resultado: [{“grupo”:”INICIAL II A: 3 A\u00d1OS – EDUCACI\u00d3N INICIAL – DIURNA”,”estudiante_id”:29505,”identificacion”:”0151298130″,”apellidos”:”ABRIGO BERMEO”,”nombres”:” ARIANA ISABELLA”,”facturacion_ci_ruc”:”1104186471001″,”facturacion_nombre”:”JAIME ALEXANDER ABRIGO MALDONADO”,”facturacion_telefono”:”0980782896″,”facturacion_direccion”:”JOSE RUIZ 20-46″,”facturacion_correo”:”alecsander10@gmail.com”,”facturacion_tipo_identificacion”:”04″},{“grupo”:”INICIAL II A: 3 A\u00d1OS – EDUCACI\u00d3N INICIAL – DIURNA”,”estudiante_id”:29764,”identificacion”:”0151300753″,”apellidos”:”ALTAMIRANO CABRERA”,”nombres”:” KEYLOR IKER”,”facturacion_ci_ruc”:”0302085303″,”facturacion_nombre”:”CABRERA JARA NURI ELITA”,”facturacion_telefono”:”072899076″,”facturacion_direccion”:”LAS ORQU\u00edDEAS “,”facturacion_correo”:”nuri86cabrera@hotmail.com”,”facturacion_tipo_identificacion”:”05″}]

Buscar un estudiante por un criterio que puede ser nombres, apellidos, la combinación de los anteriores o el número de cédula o pasaporte:

EndPoint: api/financiero/buscar_estudiantes_por_criterio/{criterio}
Method: GET
Params:
  • {criterio}: criterio de búsqueda de estudiantes; puede ser una combinación de los nombres y apellidos. Por ejemplo si el estudiante buscado es Edisson René Mendieta el criterio de búsqueda puede ser “ed re men”
Request Ejemplo: GET /api/financiero/buscar_estudiantes_por_periodo/ed%20re%20men
Resultado: Estructura JSON:

  •  estudiante_id: código único del estudiante, el mismo código se mantendrá durante toda su vida institucional.
  • identificacion: cédula o pasaporte del estudiante
  • apellidos: apellidos del estudiante
  • nombres: nombres del estudiante
  • tiene_ultima_matricula: (true o false) indica si tiene alguna matrícula en la institución.
  • ultima_matricula_grupo: último grado o curso en el que está matriculado
  • ultima_matricula_periodo: último período o año lectivo en el que tuvo una matrícula
  • valores_pendientes: último período o año lectivo en el que tuvo una matrícula
Ejem. Resultado: [{“estudiante_id”:477,”apellidos”:”RODR\u00cdGUEZ D\u00cdAZ”,”nombres”:”JUANA ELIZABETH”,”tiene_ultima_matricula”:true,”ultima_matricula_grupo”:”SEGUNDO A\u00d1O A – BACHILLERATO – APLICACIONES INFORM\u00c1TICAS – DIURNA”,”ultima_matricula_periodo”:”2001-2002″,”valores_pendientes”:0}]

Buscar datos de facturación por estudiante:

EndPoint: api/financiero/buscar_datos_facturacion_por_estudiante/{estudiante_id}
Method: GET
Params:
  • {estudiante_id}: código del estudiante a buscar los datos de facturación
Request Ejemplo: GET /api/financiero/buscar_datos_facturacion_por_estudiante/29505
Resultado: Estructura JSON:

  •  estudiante_id: código único del estudiante, el mismo código se mantendrá durante toda su vida institucional.
  • estudiante: apellidos y nombres del estudiante
  • facturacion_ci_ruc: número de identificación para facturación
  • facturacion_nombre: nombre para dato de facturación
  • facturacion_telefono: nombre para dato de facturación
  • facturacion_direccion: nombre para dato de facturación
  • facturacion_correo: nombre para dato de facturación
  • facturacion_tipo_identificacion: tipo de identificación según tabla del  SRI.
  • ultima_matricula: {grupo, periodo} último grado o curso en el que está matriculado y período
Ejem. Resultado: {“estudiante_id”:”29505″,”estudiante”:”ABRIGO BERMEO ARIANA ISABELLA”,”facturacion_ci_ruc”:”1104186471001″,”facturacion_nombre”:”JAIME ALEXANDER ABRIGO MALDONADO”,”facturacion_telefono”:”0980782896″,”facturacion_direccion”:”JOSE RUIZ 20-46″,”facturacion_correo”:”alecsander10@gmail.com”,”facturacion_tipo_identificacion”:”04″,”ultima_matricula”:{“grupo”:”INICIAL II A: 3 A\u00d1OS – EDUCACI\u00d3N INICIAL – DIURNA”,”periodo”:”2017-2018″}

Actualizar datos de facturación por estudiante:

EndPoint: api/financiero/actualizar_datos_facturacion
Method: POST
Params:
  • {estudiante_id}: código único del estudiante a actualizar
  • {facturacion_ci_ruc}: número de identificación para facturación
  • {facturacion_nombre}: nombre para dato de facturación
  • {facturacion_telefono}: nombre para dato de facturación
  • {facturacion_direccion}: nombre para dato de facturación
  • {facturacion_correo}: nombre para dato de facturación
  • {facturacion_tipo_identificacion}: tipo de identificación según tabla del  SRI.
Request Ejemplo: POST /api/financiero/actualizar_datos_facturacion HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: wrk_uesudamericano.academicloud.net
User-Agent: Paw/3.1.4 (Macintosh; OS X/10.13.0) GCDHTTPRequest
{“estudiante_id”:”16073344″,”facturacion_ci_ruc”:”0155441703001″,”facturacion_nombre”:”MENDIETA SAQUINAULA EDISSON RENE”,”facturacion_telefono”:”0994518181″,”facturacion_direccion”:”P. CORDOVA Y BENIGNO MALO ESQ.”,”facturacion_correo”:”edisson@academi-cloud.com”,”facturacion_tipo_identificacion”:”04″}
Resultado: Estructura JSON:

  • resultado: (true, false) indicador de resultado de la acción
  • mensaje: mensaje de la acción realizada
Ejem. Resultado: {“resultado”:true,”mensaje”:”Registro actualizado correctamente”}

Recuperar rubros pendientes de pago por estudiante:

EndPoint: api/financiero/buscar_rubros_pendientes/{estudiante_id}
Method: GET
Params:
  • {estudiante_id}: código del estudiante a buscar rubros pendientes
Request Ejemplo: GET /api/financiero/buscar_rubros_pendientes/29505
Resultado: Estructura JSON:

  • rubro_id: identificador único del rubro
  • concepto: concepto textual del rubro
  • fecha_maximapago: fecha de vencimiento
  • vencido: {true, false} indicador si el rubro está vencido
  • graba_iva: {true, false} indicator si el rubro graba iva
  • valor_descuento: descuento pendiente de facturar
  • valor_unitario: valor unitario o base imponible
  • valor_iva: valor IVA
  • valor_pendiente: valor pendiente total
Ejem. Resultado: [{“rubro_id”:1053142,”concepto”:”PENSION SEPTIEMBRE 2017″,”fecha_maximapago”:”2017-09-01″,”vencido”:true,”graba_iva”:false,”valor_descuento”:0,”valor_unitario”:97.66,”valor_iva”:0,”valor_pendiente”:97.66},{“rubro_id”:1056302,”concepto”:”PENSION OCTUBRE 2017″,”fecha_maximapago”:”2017-10-10″,”vencido”:false,”graba_iva”:false,”valor_descuento”:0,”valor_unitario”:97.66,”valor_iva”:0,”valor_pendiente”:97.66}]

Registrar Pago en Rubro:

EndPoint: api/financiero/registrar_pago
Method: POST
Params:
  • {rubro_id}: código del rubro a registrar el pago
  • {valor}: número de identificación para facturación
  • {factura_id}: nombre para dato de facturación
  • {factura_numero}: nombre para dato de facturación
Request Ejemplo: POST /api/financiero/registrar_pago HTTP/1.1
Content-Type: application/json; charset=utf-8
{“rubro_id”:”4253888″,”valor”:”25″,”factura_id”:7001,”factura_numero”:”001-002-0029922″}
Resultado: Estructura JSON:

  • resultado: (true, false) indicador de resultado de la acción
  • mensaje: mensaje de la acción realizada
Ejem. Resultado: {“resultado”:true,”mensaje”:”Pago registrado correctamente”}

Anular Pago en Rubro:

EndPoint: api/financiero/reversar_pago
Method: POST
Params:
  • {rubro_id}: código del rubro a registrar el pago
  • {factura_id}: código de la factura en la que se realizó el pago.
Request Ejemplo: POST /api/financiero/reversar_pago HTTP/1.1
Content-Type: application/json; charset=utf-8
{“rubro_id”:”4253″,”factura_id”:7001}
Resultado: Estructura JSON:

  • resultado: (true, false) indicador de resultado de la acción
  • mensaje: mensaje de la acción realizada
Ejem. Resultado: {“resultado”:true,”mensaje”:”Pago reversado correctamente”}