Customer Bill Management API v0.

2
Tabla de contenido
1 Introducción ..................................................................................................................................... 3
1.1 Proposito .................................................................................................................................. 3
1.2 Objetivo .................................................................................................................................... 3
2 Modelo de Recursos -- Customer Bill / Bill ................................................................................ 4
2.1 CustomerBill/ Bill Resource .................................................................................................. 4
3 Mapping de Datos de Customer Bill ............................................................................................ 5
3.1 Mapping BillDocument .......................................................................................................... 5
3.2 Mapping Bill ............................................................................................................................. 6
3.3 Mapping BillDebt .................................................................................................................... 8
4 Operaciones de la API Template Customer Bill ......................................................................... 8
5 Operaciones de Customer Bill ....................................................................................................... 9
5.1 getcustomerbill......................................................................................................................... 9
5.1.1 Ejemplo JSON .................................................................................................................. 10
5.2 getcustomerbilldebt ............................................................................................................... 11
5.2.1 Ejemplo JSON .................................................................................................................. 12
1 Governance .................................................................................................................................... 13
1.1 Operaciones Microservicio .................................................................................................. 13
1.2 Integración con Paperless .................................................................................................... 14
6 Versiones del Documento ............................................................................................................ 16
1 INTRODUCCIÓN
Este documento contiene la especificación de la API REST para la administración
de la Customer Bill API. Incluye definiciones del modelo de recursos, operaciones
disponibles en la API.
1.1 Proposito
Esta API cubre las operaciones requeridas por los legados de WOM, para entregar
información sobre el billing del usuario que está haciendo uso de esta aplicación.
1.2 Objetivo
Se busca que esta API defina las operaciones que deben ser compatibles con
cualquier sistema para permitir el suministro de información relacionada con el
billing del usuario, como facturas, fechas de pagos, ciclos de facturación, etc, para
diferentes solicitudes que estén autorizadas a obtener dicha información.
2 MODELO DE RECURSOS -- CUSTOMER BILL / BILL
2.1 CustomerBill/ Bill Resource
Modelo de recursos que permite definir información relacionada con el billing del
individuo.
3 MAPPING DE DATOS DE CUSTOMER BILL
Descripción columna Origen
-Base de datos  BSCS
-Esquema.Tabla  sysadm.rateplan
-Campo  TMCODE
-Tipo de Dato  Number(22)

3.1 Mapping BillDocument

Origen Mandatorio Destino

BSCS Si AccountId
sysadm.orderhdr_all String. Identificador único de
la cuenta.
CUSTOMER_ID
Number(22)

Objeto Bill No Bill[]

String. Datos de la factura
del cliente.
3.2 Mapping Bill

Origen Mandatorio Destino

BSCS No BillId
sysadm.orderhdr_all String. Identificador único
para la factura.
OHXACT
Number(22)

BSCS No BillNro
sysadm.orderhdr_all String. Número que se puede
visualizar en la factura.
OHREFNUM
Varchar2(30)

BSCS No Category
sysadm. String. Categoría de la
document_type_sii_code factura generada, normal,
duplicada, nota de crédito,
DOCTYPE_OUTPUT_CODE etc.
Varchar2(5) 33=Factura
39=Boleta
34=Factura Exenta
….Otros

BSCS No BillDate
sysadm.orderhdr_all String. Fecha de la
generación de la factura.
OHREFDATE
Date

BSCS No AmountDue
sysadm.orderhdr_all String. Cantidad a pagar de la
actual factura.
OHINVAMT_GL
Float(22)

BSCS No PaymentDueDate
sysadm.orderhdr_all String. Fecha en que la
factura debe pagarse.
OHDUEDATE
Date

BSCS No RemainingAmount
sysadm.orderhdr_all String. Monto restante a
pagar de la factura.
OHOPNAMT_GL
Float(22)

BSCS No State
sysadm.orderhdr_all String. Indica el estado en el
que se encuentra la factura.
OHOPNAMT_GL
Float(22)
Si OHOPNAMT_GL=0
entonces
State=’Pagada’
Si no
State=’Pendiente’

Null No PdfUrl
String. URL para visualizar la
factura del cliente.
3.3 Mapping BillDebt

Campo Mandatorio Descripción

BSCS Si AccountId
sysadm.orderhdr_all String. Identificador único de
la cuenta.
CUSTOMER_ID
Number(22)

Respuesta en query Si ExpiredDebt

x.x
String. Deuda vencida del
cliente.

4 OPERACIONES DE LA API TEMPLATE CUSTOMER BILL

Operación Sobre API Operación Descripción

Entidades
GET, usado para obtener
Query Entities GET la representación de un
recurso.
Usado para actualizar la
Update Entities POST información de
facturación del cliente.
No requerido en esta API
Partial Update of an PATCH
Entity
Usado para crear la
Create Entities PUT información de
facturación del cliente.
No requerido en esta API
Remove an Entity DELETE

.
5 OPERACIONES DE CUSTOMER BILL
5.1 getcustomerbill

GET
/ocp/srv40135-1-0/rest/getcustomerbill
?bill.accountId={accountId}
Descripción
Esta operación retorna las facturas de un cliente, usando como parámetro el
identificador de la cuenta de un cliente y la cantidad facturas que se desea retornar
(máximo 6 meses).

Comportamiento

Status Code Description

200 La información fue entregada de forma exitosa.

401 No Autorizado. El solicitante no puede pedir información del

usuario.

400 Request Error.

500 Condición inesperada que impide cumplir con la solicitud.

Otro Mensajes con errores HTTP, a ser especificados.

5.1.1 Ejemplo JSON

Request

GET
/ocp/srv40135-1-
0/rest/getcustomerbill?bill.accountId={accountId}&?bill.quantity={quantity}
Accept:application/json

Response

200
Content-Type: application/json
{
"accountId": "string",
"bill": [
{
"billId": "string",
"billNro": "string",
"category": "string",
"billDate": "2019-01-15T14:31:24.792Z",
"amountDue": 0,
"paymentDueDate": "2019-01-15T14:31:24.792Z",
"state": "string",
"remainingAmount": 0,
"pdfUrl": "string"
}
]
}
5.2 getcustomerbilldebt

GET
/ocp/srv40135-1-
0/rest/getcustomerbilldebt?accountId={accountId}
Descripción
Esta operación retorna la deuda vencida de un cliente.

Comportamiento

Status Code Description

200 La información fue entregada de forma exitosa.

401 No Autorizado. El solicitante no puede pedir información del

usuario.

400 Request Error.

500 Condición inesperada que impide cumplir con la solicitud.

Otro Mensajes con errores HTTP, a ser especificados.

5.2.1 Ejemplo JSON

Request

GET
/ocp/srv40135-1-0/rest/getcustomerbilldebt?accountId={accountId}
Accept:application/json

Response

200
Content-Type: application/json
{
"expiredDebt": "string",
"accountId": "string"
}
 1 GOVERNANCE
1.1 Operaciones Microservicio

Dominio Funcional Correlativ Vers Artifact Id Nombre Servicio

o ión

CustomerBill srv40135- 1.0 SRV40135- getCustomerBill

1-0 customerBill

CustomerBill srv40135- 1.0 SRV40135- getCustomerBilldDe

1-0 customerBill bt
1.2 Integración con Paperless
MÉTODO: OnlineRecovery
Permite recuperar información del documento, los parámetros son:
param0:(int) Rut de la empresa sin el dígito verificador (Numérico)
param1:(string) Login del usuario. Puede venir vacío si se utiliza hash MD5 para la
validación
param2:(string) Password del usuario o string hash MD5 para validación
param3:(string) Tipo de documento Electrónicos según el SII
33 = Factura Afecta
34 = Factura Exenta
39 = Boleta
41 = Boleta Exenta
61 = Nota de Crédito
56 = Nota de Débito
param4:(long) Folio del documento consultado.
param5:(int) Tipo de devolución de respuesta, el que pueden ser:
0 = ID asignado
1 = Ruta del XML
2 = Ruta del PDF (este es el que se debe usar)
3 = El timbre del Documento
4 = Imagen JPG del Código de Barra
5 = Estado en SII
6 = Folio Asignado
Tipos de Datos:
Codigo: int
Mensaje: String
URL QA http://womegwqa.paperless.cl/axis2/services/Online?wsdl
Request
<SOAP-ENV:Envelope xmlns:SOAP-
ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAPENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
<m:OnlineRecovery
xmlns:m="http://webservices.online.webapp.paperless.cl">
<m:param0>78921690</m:param0>--rut de wom
<m:param1>online_wom</m:param1>--usuario
<m:param2>wom$2017</m:param2>--password
<m:param3>39</m:param3>--documento boleta
<m:param4>27827666</m:param4>--billNro OHREFNUM
<m:param5>2</m:param5>--url pdf
</m:OnlineRecovery>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:OnlineRecoveryResponse
xmlns:ns="http://webservices.online.webapp.paperless.cl">
<ns:return><?xml version="1.0" encoding="ISO-8859-1"?>
<Respuesta>
<Codigo>0</Codigo>
<Mensaje>
http://asp4qa.paperless.cl/Facturacion/PDFServlet?docId=mxxh4h65LN
M9(MaS)zBbr6u9yuLW3c4qbQ47
</Mensaje>
</Respuesta>
</ns:return>
</ns:OnlineRecoveryResponse>
</soapenv:Body>
</soapenv:Envelope>
6 VERSIONES DEL DOCUMENTO

Número de Versión Fecha Modificación Modificado por Desc. del Cambio

V 0.1 20-09-2018 Arquitectura IT Primera Versión

V 0.2 15-01-2018 Arquitectura IT Se agrega

operaciones de
búsqueda de
facturas y
consulta de deuda
vencida