Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Import Link Fixer

...

Descripción

Servicio de configuración de cuotas para los artículos por nivel ó grado.

Inserta entidades paymentDue (colegio_articulo_abono), para un Colegio en un Ciclo en específico. Antes de insertar la entidad, se verifica que exista configuración de precios colegio_articulo_precio para los artículos enviados.

Entidad BDC

colegio_articulo_abono
Tipo PeticiónPOST
Parámetros o campos


Campos en llamadaDescripciónReglas de negocio
businessId
  • La empresa a la que pertenecen los colegios.
  • Obligatorio
  • Ver maestro de empresa
Si no se especifica el parámetro el servicio devolverá:
  • <code>400</code>
    <message>Debe especificar una empresa para consultar.</message>

schoolId
  • Id del Colegio correspondiente
  • Obligatorio
  • Si no se especifica el parámetro el servicio devolverá: 
    • <code>400</code>
      <message>Debe especificar el identificador del colegio.</message>

  • El identificador del colegio debe pertenecer a la empresa y ciclo escolar, en caso de no ser válido devuelve: 
    • <code>404</code>
      <message>No se encontraron datos con los parámetros especificados.</message> 

schoolYearId
  • Id del Año escolar en el que se configuran las cuotas
  • Obligatorio
Si no se especifica el parámetro el servicio devolverá:
  •  <code>400</code>
    <message>Debe especificar un ciclo para consultar.</message>



Parámetros en XML payload


Valida payload. En caso de no ser correcto manda mensaje de error.

<code>400</code>
<message>El xml del payload no se encuentra bien formado.</message>

CampoDescripciónReglas de negocio
articleRefId
  • Obligatorio
En caso de no encontrar el articulo a configurar
Si no existe una configuración del articulo en el grado, periodo y el tipo de venta el servicio mandará el siguiente mensaje:

<creates>
<create id="" statusCode="409" >

<error id="00000000-0000-1000-0000-001965167148" >

<code>409</code>
<message>No existe una configuración de

colegio_articulo_precio para los parámetros especificados

precios para el artículo indicado.</message>


</error>
</create>
</creates><creates>
<create id="" statusCode="409" >

gradeRefId
  • Obligatorio
  • Ver maestro de grado

En caso de no encontrar el articulo a configurar mandará el siguiente mensaje:

<error id="00000000-0000-1000-0000-001965167148" >
<code>409</code>
<message>No existe configuración de colegio_articulo_precio para los parámetros especificados.</message>
</error>
</create>
</creates>


termRefId
En caso de no encontrar el articulo a configurar mandará el siguiente mensaje:
<creates>
<create id="" statusCode="409" >
<error id="00000000-0000-1000-0000-001965167148" >
<code>409</code>
<message>No existe configuración de colegio_articulo_precio para los parámetros especificados.</message>
</error>
</create>
</creates>


salesTypeRefId
En caso de no encontrar el articulo a configurar mandará el siguiente mensaje:

<creates>
<create id="" statusCode="409" >
<error id="00000000-0000-1000-0000-001965167148" >
<code>409</code>
<message>No existe configuración de colegio_articulo_precio para los parámetros especificados.</message>
</error>
</create>
</creates>


price
  • Obligatorio
En caso de que la suma de las cuotas difiera del precio del artículo mandará el siguiente mensaje:

<creates>

<create id="" statusCode="409" >
<error id="00000000-0000-1000-0000-001965167148" >

<code>409</code>
<message>El monto total de abonos no coincide con el precio total del artículo..</message>

</error>
</create>
</creates>
discountPercent
Obligatorio
  • Opcional

taxPercent
Obligatorio
  • Opcional

startDate
  • Obligatorio
  • Formato: aaaa-mm-dd

En caso de no
cumplr
cumplir con el formato mandara el siguiente mensaje:

<creates>
<create id="" statusCode="400" >
<error id="00000000-0000-1000-0000-001965167148" >

<code>400</code>
<message>El formato de la fecha es incorrecto.</message>

</error>
</create>
</creates>
endDate
  • Obligatorio
  • Formato: aaaa-mm-dd

En caso de no
cumplr
cumplir con el formato mandara el siguiente mensaje:

<creates>

<create id="" statusCode="400" >
<error id="00000000-0000-1000-0000-001965167148" >

<code>400</code>
<message>El formato de la fecha es incorrecto.</message>

</error>
</create>
</creates>


Ejemplo de la llamadahttps://homol.sistemaunouno-internacional.com/wssb/admin/paymentDue;contextId= {"businessId";10,"schoolId":6498,"schoolYearId":64}Ejemplo XML Payload

Code Block
languagexml
titlepaymentDue
<paymentDue>
<due>
<articleRefId>3259</articleRefId>
<gradeRefId>41</gradeRefId>
<termRefId>905</termRefId>
<salesTypeRefId>45</salesTypeRefId>
<payments>
<payment>
<price>84000</price>
<discountPercent>5.00</discountPercent>
<taxPercent>0</taxPercent>
collapsetrue
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<paymentDue>
    <due>
        <articleRefId>3259</articleRefId>
        <gradeRefId>41</gradeRefId>
        <termRefId>905</termRefId>
        <salesTypeRefId>45</salesTypeRefId>
        <payments>
            <payment>
                <price>84000</price>
                <discountPercent>5.00</discountPercent>
                <taxPercent>0</taxPercent>
                <startDate>2017-01-10</startDate>


                <endDate>2017-02-13</endDate>


            </payment>

<payment>
<price>84000</price>

            <payment>
                <price>84000</price>
                <discountPercent>5.00</discountPercent>


                <taxPercent>0</taxPercent>


                <startDate>2017-02-14</startDate>


                <endDate>2017-03-11</endDate>


            </payment>

<payment>
<price>82000</price>

            <payment>
                <price>82000</price>
                <discountPercent>5.00</discountPercent>


                <taxPercent>0</taxPercent>


                <startDate>2017-03-12</startDate>


                <endDate>2017-04-12</endDate>


            </payment>


        </payments>


    </due>

<due>

    <due>
        <articleRefId>3245</articleRefId>


        <gradeRefId>41</gradeRefId>


        <termRefId>905</termRefId>


        <salesTypeRefId>45</salesTypeRefId>

<payments>
<payment>
<price>30000</price>

        <payments>
            <payment>
                <price>30000</price>
                <discountPercent>5.00</discountPercent>


                <taxPercent>0</taxPercent>


                <startDate>2017-01-10</startDate>


                <endDate>2017-02-13</endDate>


            </payment>

<payment>
<price>70000</price>

            <payment>
                <price>70000</price>
                <discountPercent>5.00</discountPercent>


                <taxPercent>0</taxPercent>


                <startDate>2017-02-14</startDate>


                <endDate>2017-03-11</endDate>


            </payment>

<payment>
<price>75000</price>

            <payment>
                <price>75000</price>
                <discountPercent>5.00</discountPercent>


                <taxPercent>0</taxPercent>


                <startDate>2017-03-12</startDate>


                <endDate>2017-04-12</endDate>


            </payment>

<payment>
<price>25000</price>

            <payment>
                <price>25000</price>
                <discountPercent>5.00</discountPercent>


                <taxPercent>0</taxPercent>


                <startDate>2017-04-13</startDate>


                <endDate>2017-05-13</endDate>


            </payment>

            
        </payments>


    </due>


</paymentDue>


Respuesta

<?xml version="1.0"?>
<createResponse>
<creates>
<create id="00000000-0000-1000-0000-000005786419" statusCode="200" />
<create id="00000000-0000-1000-0000-000005786420" statusCode="200" />
</creates>
</createResponse>

Error

<error refId="00000000-0000-1000-0000-000729142045">
<code>40402</code>
<message>No existe la entidad con el id especificado.</message>
</error>

¿Quién lo utiliza y comó?


 CO/UNOI Y CO/COMP

Documentación


Archivo para pruebas de carga


...