Versions Compared

Version Old Version 7 New Version Current
Changes made by

Tania Romo

Christian Romo

Saved on

Key

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

...

Situación actual

Referencia
DescripciónLlamado para configurar las cuotas ó abonos

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

para
colombia UNOi/COMP

.

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 tomando en cuenta nivel, grado, articulo, periodo_ciclo, tipo_venta, canal_venta y plazo_id, de no existir no es posible agregar cuotas para el artículo. .

.

Entidad BDC

colegio_articulo_abono
Tipo PeticiónPOST
Parámetros o campos


countryId
Campos en llamadaDescripciónReglas de negocio
  • Id del país.
  • Valores: ver maestro de paises.
  • Obligatorio
Si no se especifica el parámetro, como es obligatorio devuelve:

  • <code>400</code>
    <message>Debe especificar un país para consultar.</message>

businessId
  • La empresa a la que pertenecen los colegios.
  • Obligatorio
  • Ver maestro de empresa
Si no se especifica el parámetro , como es obligatorio devuelveel servicio devolverá:

  • <code>400</code>
    <message>Debe especificar una empresa para consultar.</message>

schoolId
  • Id del Colegio correspondiente
  • Obligatorio
  • Si no ese se especifica el parámetro , como es obligatorio devuelveel 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 , como es obligatorio devuelveel servicio devolverá:
  •  <code>400</code>
    <message>Debe especificar un ciclo para consultar.</message>

El schoolYearId y schoolYear debe coincidir para identificar el ciclo escolar a configurar, en caso de no ser válido devuelve:

  • <code>404</code>
    <message>No se encontraron datos con los parámetros especificados.</message>

schoolYear
  • Año escolar en el que se configuran las cuotas
  • Obligatorio
Si no se especifica el parámetro, como es obligatorio devuelve:
  •  <code>400</code>
    <message>Debe especificar un ciclo para consultar.</message>

El colegio debe existir en el ciclo escolar, en caso de no ser válido devuelve:

  • <code>404</code>
    <message>No se encontraron datos con los parámetros especificados.</message>

Campos en XML playloadDescripciónReglas de negocio



Parámetros en XML payload


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

<code>409</code>
<message>No existe una configuración de precios para el artículo indicado.</message>

gradeRefId
  • Obligatorio
  • Ver maestro de grado


termRefId


salesTypeRefId


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

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

discountPercent
  • Opcional

taxPercent
  • Opcional

startDate
  • Obligatorio
  • Formato: aaaa-mm-dd

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

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

endDate
  • Obligatorio
  • Formato: aaaa-mm-dd

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

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


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

Code Block
languagexml
titlepaymentDue
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>
                <discountPercent>5.00</discountPercent>
                <taxPercent>0</taxPercent>
                <startDate>2017-02-14</startDate>
                <endDate>2017-03-11</endDate>
            </payment>
            <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>
        <articleRefId>3245</articleRefId>
        <gradeRefId>41</gradeRefId>
        <termRefId>905</termRefId>
        <salesTypeRefId>45</salesTypeRefId>
        <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>
                <discountPercent>5.00</discountPercent>
                <taxPercent>0</taxPercent>
                <startDate>2017-02-14</startDate>
                <endDate>2017-03-11</endDate>
            </payment>
            <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>
                <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"?>
<paymentDue>
<colegio_id>6498</colegio_id>
<ciclo_escolar_clave>2017-2018</ciclo_escolar_clave>
<articulos_congigurados></articulos_congigurados>
</paymentDue><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


...