WikiSerpi - Contribuciones del usuario [es]

Facturacion Electronica Sector Salud

2024-01-02T20:35:25Z

Dvaldes: /* USUARIOS DE SERPI CON FACTUACION EN SECTOR SALUD */

== USUARIOS DE SERPI CON FACTUACION EN SECTOR SALUD ==
Con el fin de cumplir el proceso de Facturación electrónica cumpliendo con los lineamientos DIAN respecto a sector salud, en SERPI se ha habilitado la actualización respectiva para dar cumplimiento a este requerimiento.

Los pasos para facturar teniendo en cuenta sector salud son los siguientes:

* Es necesario en la configuración general de la empresa marcar el campo descrito como Sector salud:
[[Archivo:FE_SectorSalud11.jpg|centro]]

* En la sección de datos principales deberá ingresarse el código de servicio de salud:

[[Archivo:FE SectorSalud22.jpg|centro]]

* En los terceros involucrado en el proceso de facturación deberán actualizarse los campos:
** Tipo de usuario
** Modalidades de contratación y pago
** Cobertura o plan de beneficios

Actualizar en la pantalla:
[[Archivo:FE SectorSalud33.jpg|centro]]

* En el proceso de facturación aparecerán un conjunto de datos nuevos respecto a la facturación estándar, es necesario que todos están ingresados:

[[Archivo:FE SectorSalud4.jpg|centro]]

* La transmisión de la factura incluirá la información requerida,

Quedamos atentos a sus comentarios en la línea '''323 566 7757''' o a través de nuestra mesa de ayuda.

Facturacion Electronica Sector Salud

2024-01-02T20:35:15Z

Dvaldes: /* USUARIOS DE SERPI CON FACTUACION EN SECTOR SALUD */

Facturacion Electronica Sector Salud

2024-01-02T20:35:02Z

Dvaldes:

Archivo:FE SectorSalud4.jpg

2024-01-02T20:34:06Z

Dvaldes:

Archivo:FE SectorSalud33.jpg

2024-01-02T20:33:00Z

Dvaldes:

Archivo:FE SectorSalud22.jpg

2024-01-02T20:29:21Z

Dvaldes:

Facturacion Electronica Sector Salud

2024-01-02T20:24:05Z

Dvaldes: /* USUARIOS DE SERPI CON FACTUACION EN SECTOR SALUD */

Facturacion Electronica Sector Salud

2024-01-02T20:23:26Z

Dvaldes: /* ACTUALIZACION AL MODULO DE NOMINA DE SERPI */

Archivo:FE SectorSalud11.jpg

2024-01-02T20:22:15Z

Dvaldes:

Facturacion Electronica Sector Salud

2024-01-02T19:41:59Z

Dvaldes: /* ACTUALIZACION AL MODULO DE NOMINA DE SERPI */

== ACTUALIZACION AL MODULO DE NOMINA DE SERPI ==
Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera:

1. Ingresar al módulo de Parámetros anuales de Nomina:

[[Archivo:FE SectorSalud1.jpg|centro]]

2. En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
[[Archivo:FE_SectorSalud2.jpg|centro]]

3. En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
[[Archivo:FE_SectorSalud3.jpg|centro]]

4. Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

Este cambio afecta la base utilizada para la liquidación de horas extras.

Quedamos atentos a sus comentarios en la línea '''323 566 7757''' o a través de nuestra mesa de ayuda.

Facturacion Electronica Sector Salud

2024-01-02T19:41:34Z

Dvaldes: /* ACTUALIZACION AL MODULO DE NOMINA DE SERPI */

= ACTUALIZACION AL MODULO DE NOMINA DE SERPI =
Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera:

1. Ingresar al módulo de Parámetros anuales de Nomina:

[[Archivo:FE SectorSalud1.jpg|centro]]

2. En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
[[Archivo:FE_SectorSalud2.jpg|centro]]

3. En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
[[Archivo:FE_SectorSalud3.jpg|centro]]

4. Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

Este cambio afecta la base utilizada para la liquidación de horas extras.

Quedamos atentos a sus comentarios en la línea '''323 566 7757''' o a través de nuestra mesa de ayuda.

Facturacion Electronica Sector Salud

2024-01-02T19:41:05Z

Dvaldes:

=== ACTUALIZACION AL MODULO DE NOMINA DE SERPI ===

Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera:

1. Ingresar al módulo de Parámetros anuales de Nomina:

[[Archivo:FE SectorSalud1.jpg|centro]]

2. En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
[[Archivo:FE_SectorSalud2.jpg|centro]]

3. En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
[[Archivo:FE_SectorSalud3.jpg|centro]]

4. Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

Este cambio afecta la base utilizada para la liquidación de horas extras.

Quedamos atentos a sus comentarios en la línea '''323 566 7757''' o a través de nuestra mesa de ayuda.

Facturacion Electronica Sector Salud

2024-01-02T19:40:00Z

Dvaldes:

Facturacion Electronica Sector Salud

2024-01-02T19:39:34Z

Dvaldes: /* ACTUALIZACION AL MODULO DE NOMINA DE SERPI */

=== ACTUALIZACION AL MODULO DE NOMINA DE SERPI ===

Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera:

# Ingresar al módulo de Parámetros anuales de Nomina:

[[Archivo:FE SectorSalud1.jpg|centro]]

# En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:

[[Archivo:FE_SectorSalud2.jpg|centro]]

## En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
[[Archivo:FE_SectorSalud3.jpg|centro]]

# Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

Este cambio afecta la base utilizada para la liquidación de horas extras.

Quedamos atentos a sus comentarios en la línea 323 566 7757 o a través de nuestra mesa de ayuda.

Facturacion Electronica Sector Salud

2024-01-02T19:39:21Z

Dvaldes: /* ACTUALIZACION AL MODULO DE NOMINA DE SERPI */

Facturacion Electronica Sector Salud

2024-01-02T19:37:39Z

Dvaldes: /* ACTUALIZACION AL MODULO DE NOMINA DE SERPI */

Facturacion Electronica Sector Salud

2024-01-02T19:37:28Z

Dvaldes:

Facturacion Electronica Sector Salud

2024-01-02T19:36:48Z

Dvaldes:

=== ACTUALIZACION AL MODULO DE NOMINA DE SERPI ===

Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera:

# Ingresar al módulo de Parámetros anuales de Nomina:
# [[Archivo:FE SectorSalud1.jpg]]
# En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
# En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
# Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

# En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
[[Archivo:FE SectorSalud2.jpg]]

# En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
[[Archivo:FE SectorSalud3.jpg]]

# Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

Este cambio afecta la base utilizada para la liquidación de horas extras.

Quedamos atentos a sus comentarios en la línea 323 566 7757 o a través de nuestra mesa de ayuda.

Facturacion Electronica Sector Salud

2024-01-02T19:36:17Z

Dvaldes: /* ACTUALIZACION AL MODULO DE NOMINA DE SERPI */

=== ACTUALIZACION AL MODULO DE NOMINA DE SERPI ===

Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera:

# Ingresar al módulo de Parámetros anuales de Nomina:
# [[Archivo:FE SectorSalud1.jpg|miniaturadeimagen]]
# En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
# En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
# Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

# En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
[[Archivo:FE SectorSalud2.jpg|miniaturadeimagen]]

# En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
[[Archivo:FE SectorSalud3.jpg|miniaturadeimagen]]}

# Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

Este cambio afecta la base utilizada para la liquidación de horas extras.

Quedamos atentos a sus comentarios en la línea 323 566 7757 o a través de nuestra mesa de ayuda.

Facturacion Electronica Sector Salud

2024-01-02T19:34:45Z

Dvaldes:

=== ACTUALIZACION AL MODULO DE NOMINA DE SERPI ===

Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera:

# Ingresar al módulo de Parámetros anuales de Nomina:
[[Archivo:FE SectorSalud1.jpg|miniaturadeimagen]]

# En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
[[Archivo:FE SectorSalud2.jpg|miniaturadeimagen]]

# En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
[[Archivo:FE SectorSalud3.jpg|miniaturadeimagen]]}

# Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

Este cambio afecta la base utilizada para la liquidación de horas extras.

Quedamos atentos a sus comentarios en la línea 323 566 7757 o a través de nuestra mesa de ayuda.

Facturacion Electronica Sector Salud

2024-01-02T19:34:30Z

Dvaldes: /* ACTUALIZACION AL MODULO DE NOMINA DE SERPI */

=== ACTUALIZACION AL MODULO DE NOMINA DE SERPI ===

Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera:

# Ingresar al módulo de Parámetros anuales de Nomina:
[[Archivo:FE SectorSalud1.jpg|miniaturadeimagen]]

## En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
[[Archivo:FE SectorSalud2.jpg|miniaturadeimagen]]

### En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
[[Archivo:FE SectorSalud3.jpg|miniaturadeimagen]]}

#### Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

Este cambio afecta la base utilizada para la liquidación de horas extras.

Quedamos atentos a sus comentarios en la línea 323 566 7757 o a través de nuestra mesa de ayuda.

Facturacion Electronica Sector Salud

2024-01-02T19:33:43Z

Dvaldes: Página creada con «== ACTUALIZACION AL MODULO DE NOMINA DE SERPI == Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera: # Ingresar al módulo de Parámetros anuales de Nomina: Archivo:FE SectorSalud1.jpg|miniat…»

== ACTUALIZACION AL MODULO DE NOMINA DE SERPI ==

Teniendo en cuenta la ley 2101, expedida el 15 de julio de 2021 por medio del cual se reduce la jornada laboral semanal de manera gradual, sin disminuir el salario ni afectar los derechos adquiridos y garantías de los trabajadores, se implementó en SERPI la opción que permitirá su aplicación y uso de la siguiente manera:

# Ingresar al módulo de Parámetros anuales de Nomina:
[[Archivo:FE SectorSalud1.jpg|miniaturadeimagen]]

# En la lista, seleccionamos el año a configurar, haciendo clic en la opción de editar:
[[Archivo:FE SectorSalud2.jpg|miniaturadeimagen]]

# En la pantalla ubicamos el parámetro identificado como Cantidad de horas diarias, actualmente se almacena el valor 8 que son las horas laborales diarias:
[[Archivo:FE SectorSalud3.jpg|miniaturadeimagen]]}

# Este valor a partir de mañana deberá arrancar con: siete punto ochocientos treinta y tres ( 7.833 ) que corresponde a las horas laborales en una jornada de 47 horas semanales, una vez se actualice el valor , hacer clic en el botón guardar.

Este cambio afecta la base utilizada para la liquidación de horas extras.

Quedamos atentos a sus comentarios en la línea 323 566 7757 o a través de nuestra mesa de ayuda.

Archivo:FE SectorSalud3.jpg

2024-01-02T19:32:52Z

Dvaldes:

Archivo:FE SectorSalud2.jpg

2024-01-02T19:32:16Z

Dvaldes:

Archivo:FE SectorSalud1.jpg

2024-01-02T19:31:34Z

Dvaldes:

MediaWiki:Sidebar

2024-01-02T19:25:30Z

Dvaldes:

MediaWiki:Sidebar

2024-01-02T19:24:18Z

Dvaldes:

MediaWiki:Sidebar

2024-01-02T19:23:45Z

Dvaldes:

MediaWiki:Sidebar

2024-01-02T19:23:03Z

Dvaldes:

API BI

2023-12-05T16:02:36Z

Dvaldes:

Esta es la documentación sobre las APIs relacionadas al '''BI (Business Intelligence)'''

* [[API BI_Cartera| BI - API Cartera]]

API BI

2023-12-05T16:02:01Z

Dvaldes:

Esta es la documentación sobre las APIs relacionadas al '''BI (Business Intelligence)'''

* [[API BI-Cartera| API Cartera]]

API BI

2023-12-05T16:01:52Z

Dvaldes: Página creada con «Esta es la documentación sobre las APIs relacionadas al '''BI (Business Intelligence)''' * API Cartera»

Esta es la documentación sobre las APIs relacionadas al '''BI (Business Intelligence)'''

* [[API BI-Cartera|API Cartera]]

MediaWiki:Sidebar

2023-12-05T15:59:26Z

Dvaldes:

MediaWiki:Sidebar

2023-12-05T15:55:47Z

Dvaldes:

API Pedido Rastreo

2023-09-25T21:41:48Z

Dvaldes: /* Métodos */

'''Descripción:'''
Esta API permite la sincronizacion de sucursales entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta Tipo Documento (GET) ">
'''GET/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/PedidoVenta/GetTipoDocumento

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Parámetros'''
{| class="wikitable"
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "PDV",
"prefijo": "PDV",
"descripcion": "PEDIDO VENTA"
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al id del tipo de documento
|-
| categoriaDocumento || String || Categoria del tipo de documento
|-
| prefijo || String || Prefijo del tipo de documento
|-
| descripcion || String || Descripcion del tipo de documento
|}
</Tab>


<Tab name = "API Consulta Pedido Rastreo (GET) ">
'''POST /users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/PedidoVenta/RastreoPedido?idTipoDocumento=15&numero=55

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

''' Parametros '''
{| class="wikitable left"
! Campo !! Tipo !! Requerido !! Descripción
|-
| idTipoDocumento || Int || SI || Id del tipo de documento (Api consulta tipo de documento)
|-
| numero || Int || SI || Numero de pedido a consultar
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"prefijoPedido": "PDV",
"numeroPedido": 2,
"facturas": [
{
"prefijoFactura": “FV”,
"numeroFactura": 3,
"fechaFactura": "2023-04-18",
"estadoFactura": “En Alistamiento”,
"transportador": “Servientrega”,
"nroGuia": “G00002348232323”
},
{
"prefijoFactura": “FV”,
"numeroFactura": 4,
"fechaFactura": "2023-04-18",
"estadoFactura": “En Alistamiento”,
"transportador": “Servientrega”,
"nroGuia": “G00002348232323”
}
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_tercero || int || 50 || SI || Corresponde al identificador del tercero
|-
| nit_tercero || int || 50 || SI || Nit del tercero
|-
| codigo || string || 50 || SI || Codigo de la sucursal
|-
| referencia_sucursal || string || 50 || SI || Referencia de la sucursal
|-
| descripcion || string || 50 || SI || Descripcion de la sucursal
|-
| direccion || string || 50 || SI || Direccion de la sucursal
|-
| direccion2 || string || 50 || NO || Segunda direccion de la sucursal
|-
| telefono || int || 50 || SI || Telefono correspondiente a la sucursal
|-
| telefono2 || int || 50 || NO || Segundo telefono correspondiente a la sucursal
|-
| ext || int || 50 || NO || Extension de la sucursal
|-
| ext2 || int || 50 || NO || Extension de la sucursal
|-
| movil || int || 50 || NO || Celular de la sucursal
|-
| id_ciudad || int || 50 || SI || Identificador correspondiente a la ciudad de la sucursal
|-
| codigo_ciudad || string || 50 || SI || Codigo de la ciudad de la sucursal
|-
| id_departamento || int || 50 || SI || Identificador correspondiente al departamento de la sucursal
|-
| codigo_departamento || string || 50 || SI || Codigo del departamento de la sucursal
|-
| id_pais || int || 50 || SI || Identificador correspondiente al pais de la sucursal
|-
| codigo_pais || string || 50 || SI || Codigo del pais de la sucursal
|-
| id_vendedor || int || 50 || SI || Identificador correspondiente al vendedor de la sucursal
|-
| id_cobrador || int || 50 || NO || Identificador correspondiente al cobrador de la sucursal
|-
| es_direccionCobro || bool || X || SI || Valida si es direccion de cobro
|-
| es_direccionDespacho || bool || X || SI || Valida si es direccion de despacho
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>
</Tab>
</Tabs>

API Terceros/Lista Precios Detalle

2023-08-08T16:29:22Z

Dvaldes:

'''Descripción:'''
Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
Este reporte permite hacer una medición de la productividad individual de los agentes teniendo en cuenta el tiempo dedicado a la gestión de llamadas y sus logros (hits y RPC)

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*El consumo de esta API se realiza por método GET.
*Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta (GET) ">

'''EndPoint:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle</nowiki>

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle?limite=50&pagina=1</nowiki>

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight >
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| limite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| pagina || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|-
| idArticulo || int || No || Este parámetro indica el id del artículo que desea consultar
|-
| idListaPrecio || int || No || Este parámetro trae la consulta de los artículos relacionados al id de la lista precio que desee consultar
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id_listaprecio": 1,
"descripcion_id_listaprecio": "DESCRIPCION DE LA LISTA DE PRECIO",
"id_articulo": 1,
"descripcion_articulo": "ARTICULO DEMO",
"precio": 0,
"descuento": 0,
"observaciones": "OBSERVACIONES GENERALES"
}
]
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id_listaprecio || int || Identificador de la lista precio relacionada al detalle
|-
| descripcion_id_listaprecio || string || Descripción de la lista precio relacionada al detalle
|-
| id_articulo || int || Identificador del articulo relacionado al detalle
|-
| descripcion_articulo || string || Descripción del artículo
|-
| precio || double || Precio del artículo
|-
| descuento || double || Descuento del artículo
|-
| observaciones || string || Observaciones de la lista de precio detalle
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"id_listaprecio": 1,
"id_articulo": 1000,
"precio": 50000,
"descuento": 10,
"observaciones": "OBSERVACIÓN GENERAL"
},
.
.
.
{
"id_listaprecio": n,
"id_articulo": n,
"precio": 0,
"descuento": 0,
"observaciones": null
}
]
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_listaprecio || int || 11 || Si || Identificador de la lista precio relacionada al detalle. Debe existir la lista de precio para relacionar el id.
|-
| id_articulo || int || 11 || Si || Identificador del articulo relacionado al detalle. Debe existir el artículo para relacionar el id.
|-
| precio || double || (18,5) || Si || Precio del artículo
|-
| descuento || double || (18,5) || No || Porcentaje del descuento que aplica para el artículo relacionado. El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica
|-
| observaciones || string || 500 || No || Observaciones de la lista de precio detalle
|}

=== '''AVISO IMPORTANTE:''' ===
Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 1 de 1 lista precio detalle"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [
"El campo precio es obligatorio",
"El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica",
"No existe un articulo relacionado al id 0",
"No existe una lista de precio relacionada al id 0"
],
"message": "Se crearon 0 de 1 lista precio detalle"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ListaPrecioDetalle

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
[
{
"id_listaprecio": 1000,
"id_articulo": 10000,
"precio": 0,
"descuento": 0,
"observaciones": "OBSERVACIONES GENERALES"
},
.
.
.
{
"id_listaprecio": n,
"id_articulo": n,
"precio": 0,
"descuento": 0,
"observaciones": null
}
]

</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id_listaprecio || int || 11 || Si || Identificador de la lista precio relacionada al detalle. Debe existir la lista de precio para relacionar el id.
|-
| id_articulo || int || 11 || Si || Identificador del articulo relacionado al detalle. Debe existir el artículo para relacionar el id.
|-
| precio || double || (18,5) || Si || Precio del artículo
|-
| descuento || double || (18,5) || No || Porcentaje del descuento que aplica para el artículo relacionado. El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica
|-
| observaciones || string || 500 || No || Observaciones de la lista de precio detalle
|}

==== '''AVISO IMPORTANTE:''' ====
Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se modificaron 1 de 1 lista precios detalle"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [
"Lista Precio Detalle 1: El id no existe",
"El campo precio es obligatorio",
"El campo descuento no debe ser un valor nulo. Ponga 0 si no aplica",
"No existe un articulo relacionado al id 10000",
"No existe una lista de precio relacionada al id 1000"
],
"message": "Se modificaron 0 de 1 lista precios detalle"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! Código !! Descripción
|-
| 200 || La solicitud ha sido exitosa
|-
| 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso
|-
| 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
|-
| 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
|-
| 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
|-
| 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
|-
| 404 || El recurso solicitado no se ha encontrado en el servidor
|-
| 500 || Internal Server Error
|-
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/ListaPrecioDetalle")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/ListaPrecioDetalle");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/ListaPrecioDetalle');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Terceros/Notas Tercero

2023-07-28T16:41:47Z

Dvaldes: /* ¿Cómo consumir la API? */

'''Descripción:'''
PENDIENTE

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''
PENDIENTE

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
PENDIENTE

== Métodos ==
<Tabs>

<Tab name = "API Consulta (GET) ">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/NotaTercero

'''EndPoint con parámetros:'''
<nowiki>https://www.apis.serpi.com.co/api/v1/NotaTercero?nitTercero=1075229539</nowiki>

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight >
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

{| class="wikitable"
|+ Parámetros
|-
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|-
| '''nitTercero''' || int || No || Este parámetro indica el NIT del tercero. Se devolverán las notas relacionadas a ese tercero
|}

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"id_tercero": 1234,
"nit_tercero": "1234567",
"descripcion_tercero": "DESCRIPCIÓN DEL TERCERO",
"nota": "NOTA ASOCIADA",
"fecha_creacion": "2023-06-20 09:39:45",
"id_usuario": 1,
"usuario": "USUARIO ASOCIADO",
"prioridad": "alta",
"confidencial": true
}
]
}

{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador de la nota
|-
| id_tercero || int || Corresponde al identificador del tercero asociado a la nota
|-
| nit_tercero || string || Corresponde al NIT asociado a la nota y al id del tercero
|-
| descripcion_tercero || string || Descripción del tercero
|-
| nota || string || Cuerpo de la nota
|-
| fecha_creacion || Date || Fecha de creación de la nota
|-
| id_usuario || int || Corresponde al identificador del usuario asociado a la nota
|-
| usuario || string|| Nombre del usuario asociado al id del usuario
|-
| prioridad || string || Nivel de prioridad de la nota (baja, media, alta)
|-
| confidencial || bool || Define si es una nota confidencial
|}
</Tab>


<Tab name = "API Creación (POST) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/NotaTercero

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
{
"nit_tercero": "1234567",
"nota": "NOTA DE PRUEBA DESDE POSTMAN",
"prioridad": "media",
"confidencial": false
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| nit_tercero || string || 15 || Si || Corresponde al NIT asociado a la nota y al id del tercero
|-
| nota || string || 65535 || Si || Cuerpo de la nota
|-
| prioridad || string || 10 || Si || Nivel de prioridad de la nota (baja, media, alta)
|-
| confidencial || bool || 1 || Si || Definir si es una nota confidencial o no
|}

==== '''AVISO IMPORTANTE:''' ====
Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"No existe un tercero asociado al nit: 1234567",
"El campo nota es obligatorio",
"El campo prioridad con el valor X no coincide con alguna de las opciones válidas. Digite baja, media o alta"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT) ">
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/NotaTercero

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 1,
"nit_tercero": "1234567",
"nota": "NOTA DE PRUEBA DESDE POSTMAN",
"prioridad": "media",
"confidencial": false
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
|-
| id || int || 11 || Si || Corresponde al identificador de la nota
|-
| nit_tercero || string || 15 || Si || Corresponde al NIT asociado a la nota y al id del tercero
|-
| nota || string || 65535 || Si || Cuerpo de la nota
|-
| prioridad || string || 10 || Si || Nivel de prioridad de la nota (baja, media, alta)
|-
| confidencial || bool || 1 || Si || Definir si es una nota confidencial o no
|}

==== '''AVISO IMPORTANTE:''' ====
Donde los '''campos no sean obligatorios''' y no se desea asignar algún valor, pruebe digitando '''null''' o '''0''' en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite '''null'''.

'''Response'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"No existe un tercero asociado al nit: 1234567",
"El campo nota es obligatorio",
"El campo prioridad con el valor X no coincide con alguna de las opciones válidas. Digite baja, media o alta"
],
"message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! Código !! Descripción
|-
| 200 || La solicitud ha sido exitosa
|-
| 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso
|-
| 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
|-
| 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
|-
| 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
|-
| 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
|-
| 404 || El recurso solicitado no se ha encontrado en el servidor
|-
| 500 || Internal Server Error
|-
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://apis.serpi.com.co/api/v1/NotaTercero")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://apis.serpi.com.co/api/v1/NotaTercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://apis.serpi.com.co/api/v1/NotaTercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer {{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Articulos/Proveedores

2023-07-28T16:34:48Z

Dvaldes: /* ¿Cómo consumir la API? */

'''Descripción:'''
Esta API permite la sincronizacion de articulos de proveedores entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consultar(GET)">
'''GET/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ArticuloProveedor?limite=10&pagina=1&idArticulo=2

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Parámetros'''
{| class="wikitable"
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|-
| idArticulo || int || No || Identificador del articulo a filtrar
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"idArticulo": 2,
"descripcion": "ARTICULO1",
"nitProveedor": "1234567890",
"codigoProveedor": "101",
"descripcionProveedor": "ARTICULO UNO",
"proveedorPredeterminado": true,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}
</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo !! Descripción
|-
| id || int || Corresponde al id del registro ArticuloProveedor
|-
| idArticulo || int || Id del artículo al que pertenece el registro
|-
| descripcion || string || Descripción del artículo
|-
| nitProveedor || string || Número de identificación del proveedor
|-
| codigoProveedor || string || Código del artículo del proveedor
|-
| descripcionProveedor || string || Descripción del artículo del proveedor
|-
| proveedorPredeterminado|| bool || Indica si es el proveedor predeterminado del artículo
|-
| multiploCompra || decimal || Múltiplo de compra
|-
| pedidoMinimo || decimal || Pedido mínimo
|}

</Tab>


<Tab name = "API Crear(POST)">
'''POST /users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ArticuloProveedor

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"idArticulo": 2,
"nitProveedor": "1234567890",
"codigoProveedor": "101",
"descripcionProveedor": "ARTICULO UNO",
"proveedorPredeterminado": true,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000
}

]

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || int || SI || Id del artículo al que pertenece el registro
|-
| nitProveedor || string || SI || Número de identificación del proveedor
|-
| codigoProveedor || string || SI || Código del artículo del proveedor
|-
| descripcionProveedor || string || SI || Descripción del artículo del proveedor
|-
| proveedorPredeterminado|| bool || SI || Indica si es el proveedor predeterminado del artículo
|-
| multiploCompra || decimal || NO || Múltiplo de compra
|-
| pedidoMinimo || decimal || NO || Pedido mínimo
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 articulos proveedores"
}

</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT)">
'''PUT/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ArticuloProveedor

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"id": 1,
"idArticulo": 2,
"nitProveedor": "1234567890",
"codigoProveedor": "101",
"descripcionProveedor": "ARTICULO UNO",
"proveedorPredeterminado": true,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000
}
]
</syntaxhighlight>

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se modificaron 10 de 10 articulos proveedores"
}

</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! Código !! Descripción
|-
| 200 || La solicitud ha sido exitosa
|-
| 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso
|-
| 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
|-
| 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
|-
| 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
|-
| 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
|-
| 404 || El recurso solicitado no se ha encontrado en el servidor
|-
| 500 || Internal Server Error
|-
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://apis.serpi.com.co/api/v1/ArticuloProveedor")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://apis.serpi.com.co/api/v1/ArticuloProveedor");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://apis.serpi.com.co/api/v1/ArticuloProveedor');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer {{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Articulos/Proveedores

2023-07-28T16:34:16Z

Dvaldes: /* Códigos de estado HTTP */

'''Descripción:'''
Esta API permite la sincronizacion de articulos de proveedores entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consultar(GET)">
'''GET/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ArticuloProveedor?limite=10&pagina=1&idArticulo=2

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Parámetros'''
{| class="wikitable"
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|-
| idArticulo || int || No || Identificador del articulo a filtrar
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"idArticulo": 2,
"descripcion": "ARTICULO1",
"nitProveedor": "1234567890",
"codigoProveedor": "101",
"descripcionProveedor": "ARTICULO UNO",
"proveedorPredeterminado": true,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}
</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo !! Descripción
|-
| id || int || Corresponde al id del registro ArticuloProveedor
|-
| idArticulo || int || Id del artículo al que pertenece el registro
|-
| descripcion || string || Descripción del artículo
|-
| nitProveedor || string || Número de identificación del proveedor
|-
| codigoProveedor || string || Código del artículo del proveedor
|-
| descripcionProveedor || string || Descripción del artículo del proveedor
|-
| proveedorPredeterminado|| bool || Indica si es el proveedor predeterminado del artículo
|-
| multiploCompra || decimal || Múltiplo de compra
|-
| pedidoMinimo || decimal || Pedido mínimo
|}

</Tab>


<Tab name = "API Crear(POST)">
'''POST /users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ArticuloProveedor

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"idArticulo": 2,
"nitProveedor": "1234567890",
"codigoProveedor": "101",
"descripcionProveedor": "ARTICULO UNO",
"proveedorPredeterminado": true,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000
}

]

</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| idArticulo || int || SI || Id del artículo al que pertenece el registro
|-
| nitProveedor || string || SI || Número de identificación del proveedor
|-
| codigoProveedor || string || SI || Código del artículo del proveedor
|-
| descripcionProveedor || string || SI || Descripción del artículo del proveedor
|-
| proveedorPredeterminado|| bool || SI || Indica si es el proveedor predeterminado del artículo
|-
| multiploCompra || decimal || NO || Múltiplo de compra
|-
| pedidoMinimo || decimal || NO || Pedido mínimo
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 articulos proveedores"
}

</syntaxhighlight>
</Tab>


<Tab name = "API Modificar(PUT)">
'''PUT/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/ArticuloProveedor

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"id": 1,
"idArticulo": 2,
"nitProveedor": "1234567890",
"codigoProveedor": "101",
"descripcionProveedor": "ARTICULO UNO",
"proveedorPredeterminado": true,
"multiploCompra": 1.00,
"pedidoMinimo": 1.00000
}
]
</syntaxhighlight>

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se modificaron 10 de 10 articulos proveedores"
}

</syntaxhighlight>
</Tab>
</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! Código !! Descripción
|-
| 200 || La solicitud ha sido exitosa
|-
| 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso
|-
| 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
|-
| 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
|-
| 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
|-
| 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
|-
| 404 || El recurso solicitado no se ha encontrado en el servidor
|-
| 500 || Internal Server Error
|-
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://apis.serpi.com.co/api/v1/DocumentoContable")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://apis.serpi.com.co/api/v1/DocumentoContable");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://apis.serpi.com.co/api/v1/DocumentoContable');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer {{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Articulos/Proveedores

2023-07-28T16:32:41Z

Dvaldes: /* ¿Cómo consumir la API? */

API Documentos Inventario

2023-07-28T16:31:47Z

Dvaldes: /* ¿Cómo consumir la API? */

'''Descripción:'''
Esta API permite la sincronizacion de documentos contables entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta Tipos de Documento">
'''GET/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable/GetTipoDocumento

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Parámetros'''
{| class="wikitable"
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "NC",
"prefijo": "RCA",
"descripcion": "RECIBO DE CAJA"
},
{
"id": 2,
"categoriaDocumento": "NC",
"prefijo": "NCC",
"descripcion": "NOTA CONTABLE"
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador del tipo de documento
|-
| categoriaDocumento || string || Categoría del tipo de documento
|-
| prefijo || string || Prefijo del tipo de documento
|-
| descripcion || string || Descripción del tipo de documento
|}
</Tab>


<Tab name = "API Consultar Documentos Contables">
'''POST /users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable/ConsultarDocumentoContables?limite=10&pagina=1

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Body:'''
<syntaxhighlight lang="JSON">
{
"tiposDocumentos": [15,16],
"numeroDesde": null,
"numeroHasta": null,
"fechaDesde": "2023-01-01",
"fechaHasta": "2023-01-31"
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tiposDocumentos || Array [Int] || SI || Array de enteros. Son los Ids de los tipos de documentos (Api Consulta tipos documento)
|-
| numeroDesde || int || NO || Numero inicial para filtrar por rango de números de documentos
|-
| numeroHasta || int || NO || Numero final para filtrar por rango de números de documentos
|-
| fechaDesde || string || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
| fechaHasta || bool || SI || Fecha final para filtrar por rango de fecha del documento
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 111,
"categoriaDocumento": "CCO",
"prefijo": "COM",
"numeroDoc": 1,
"nitTerceroEnc": "1234567890",
"nombreTerceroEnc": "ALEJANDRA LOPEZ LOPEZ",
"fechaDocumento": "2023-03-01",
"detalles": [
{
"cuenta": 52954501,
"nitTerceroDet": "1234567890",
"nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
"naturaleza": "D",
"crucePrefijo": null,
"cruceNumero": null,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": 4,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
},
{
"cuenta": 23359501,
"nitTerceroDet": "1234567890",
"nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
"naturaleza": "C",
"crucePrefijo": "COM",
"cruceNumero": 3272,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": null,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
}
]
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}
</syntaxhighlight>

''' Campos del resultado'''
{| class="wikitable"
! Campo !! Tipo de Dato !! Descripción
|-
| id || int || Corresponde al id del registro contable
|-
| categoriaDocumento || string || Categoría del tipo de documento
|-
| prefijo || string || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero del documento contable
|-
| nitTerceroEnc || string || Numero de identificación del tercero del documento contable
|-
| nombreTerceroEnc || string || Nombre del tercero del documento contable
|-
| fechaDocumento || string || Fecha del documento contable
|-
| detalles || Array[ObjetoDetalle]* || Array de objetos de los detalles del documento contable
|}

''' ObjetoDetalle:'''
{| class="wikitable"
! Campo !! Tipo de Dato !! Descripción
|-
| cuenta || Int || Auxiliar o numero de cuenta contable del movimiento
|-
| nitTerceroDet || string || Numero de identificación del tercero del detalle
|-
| nombreTerceroDet || string || Nombre del tercero del detalle
|-
| naturaleza || string || Naturaleza del movimiento (C=Credito, D=Debito)
|-
| crucePrefijo || string || Prefijo del documento cruce
|-
| cruceNumero || Int || Numero del documento cruce
|-
| fechaVencimiento || string || Fecha de vencimiento del movimiento
|-
| valor || decimal || Valor del movimiento
|-
| baseImpuesto || decimal || Valor base de impuesto
|-
| cuota || Int || Numero de cuota, para documentos que manejan contabilización de cuotas
|-
| detalle || string || Comentarios del movimiento
|-
| idSubcentroCosto || Int || Id del subcentro de costo del movimiento
|-
| idCentroOperacion || Int || Id del centro de operacion del movimiento
|-
| idProyecto || Int || Id del proyecto del movimiento
|-
| idActividad || Int || Id de la actividad del movimiento
|-
| idSucursal || Int || Id de la sucursal del tercero del movimiento
|}
</Tab>


<Tab name = "API Crear">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable
''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"categoriaDocumento": "CCO",
"prefijo": "COM",
"numeroDoc": 2,
"nitTerceroEnc": "123456789",
"fechaDocumento": "2023-03-01",
"detalles": [
{
"cuenta": 52954501,
"nitTerceroDet": "123456789",
"naturaleza": "D",
"crucePrefijo": null,
"cruceNumero": null,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": 4,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
},
{
"cuenta": 23359501,
"nitTerceroDet": "123456789",
"naturaleza": "C",
"crucePrefijo": "COM",
"cruceNumero": 1,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": null,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
}
]
}
]

</syntaxhighlight>

''' Campos resultado'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| categoriaDocumento || string || SI || Categoría del tipo de documento
|-
| prefijo || string || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero del documento contable
|-
| nitTerceroEnc || string || SI || Numero de identificación del tercero del documento contable
|-
| fechaDocumento || string || SI || Fecha del documento contable
|-
| detalles || Array[ObjetoDetalle]* || SI || Array de objetos de los detalles del documento contable
|}

''' ObjetoDetalle:'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| cuenta || Int || SI || Auxiliar o numero de cuenta contable del movimiento
|-
| nitTerceroDet || string || SI || Numero de identificación del tercero del detalle
|-
| naturaleza || string || SI || Naturaleza del movimiento (C=Credito, D=Debito)
|-
| crucePrefijo || string || NO || Prefijo del documento cruce
|-
| cruceNumero || Int || NO || Numero del documento cruce
|-
| fechaVencimiento || string || NO || Fecha de vencimiento del movimiento
|-
| valor || decimal || SI || Valor del movimiento
|-
| baseImpuesto || decimal || NO || Valor base de impuesto
|-
| cuota || Int || NO || Numero de cuota, para documentos que manejan contabilización de cuotas
|-
| detalle || string || NO || Comentarios del movimiento
|-
| idSubcentroCosto || Int || NO || Id del subcentro de costo del movimiento
|-
| idCentroOperacion|| Int || NO || Id del centro de operacion del movimiento
|-
| idProyecto || Int || NO || Id del proyecto del movimiento
|-
| idActividad || Int || NO || Id de la actividad del movimiento
|-
| idSucursal || Int || NO || Id de la sucursal del tercero del movimiento
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 documentos contables"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Eliminar">
'''PUT/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable
''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Body:'''
<syntaxhighlight lang="JSON">
{
"idTipoDocumento": 6,
"numeroDesde": 1,
"numeroHasta": 10000,
"fechaDesde": "2023-03-01",
"fechaHasta": "2023-03-31"
}
</syntaxhighlight>

''' Campos Solicitados '''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| idTipoDocumento || int || SI || Id del tipo de documento
|-
| numeroDesde || int || SI || Numero inicial para filtrar por rango de números de documentos
|-
| numeroHasta || int || SI || Numero final para filtrar por rango de números de documentos
|-
| fechaDesde || string || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
| fechaHasta || bool || SI || Fecha final para filtrar por rango de fecha del documento
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se eliminaron 10 de 10 documentos contables "
}

</syntaxhighlight>
</Tab>

</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! Código !! Descripción
|-
| 200 || La solicitud ha sido exitosa
|-
| 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso
|-
| 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
|-
| 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
|-
| 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
|-
| 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
|-
| 404 || El recurso solicitado no se ha encontrado en el servidor
|-
| 500 || Internal Server Error
|-
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://apis.serpi.com.co/api/v1/DocumentoContable")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://apis.serpi.com.co/api/v1/DocumentoContable");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://apis.serpi.com.co/api/v1/DocumentoContable');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer {{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Documentos Inventario

2023-07-28T16:18:22Z

Dvaldes: /* Códigos de estado HTTP */

'''Descripción:'''
Esta API permite la sincronizacion de documentos contables entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

'''Autorización:'''
Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

'''Beneficio:'''

'''Tipos de peticiones:'''
GET, POST, PUT

'''¿Cómo funciona?'''
*Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
*En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

== Métodos ==
<Tabs>

<Tab name = "API Consulta Tipos de Documento">
'''GET/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable/GetTipoDocumento

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Parámetros'''
{| class="wikitable"
! Parámetro !! Tipo de dato !! Requerido !! Descripción
|-
| Límite || int || No || Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
|-
| Página || int || No || Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página
|}

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "2 registro(s) encontrados",
"result": [
{
"id": 1,
"categoriaDocumento": "NC",
"prefijo": "RCA",
"descripcion": "RECIBO DE CAJA"
},
{
"id": 2,
"categoriaDocumento": "NC",
"prefijo": "NCC",
"descripcion": "NOTA CONTABLE"
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}

</syntaxhighlight>

'''Campo de resultados'''
{| class="wikitable"
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador del tipo de documento
|-
| categoriaDocumento || string || Categoría del tipo de documento
|-
| prefijo || string || Prefijo del tipo de documento
|-
| descripcion || string || Descripción del tipo de documento
|}
</Tab>


<Tab name = "API Consultar Documentos Contables">
'''POST /users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable/ConsultarDocumentoContables?limite=10&pagina=1

''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Body:'''
<syntaxhighlight lang="JSON">
{
"tiposDocumentos": [15,16],
"numeroDesde": null,
"numeroHasta": null,
"fechaDesde": "2023-01-01",
"fechaHasta": "2023-01-31"
}
</syntaxhighlight>

''' Campos del request'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| tiposDocumentos || Array [Int] || SI || Array de enteros. Son los Ids de los tipos de documentos (Api Consulta tipos documento)
|-
| numeroDesde || int || NO || Numero inicial para filtrar por rango de números de documentos
|-
| numeroHasta || int || NO || Numero final para filtrar por rango de números de documentos
|-
| fechaDesde || string || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
| fechaHasta || bool || SI || Fecha final para filtrar por rango de fecha del documento
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 111,
"categoriaDocumento": "CCO",
"prefijo": "COM",
"numeroDoc": 1,
"nitTerceroEnc": "1234567890",
"nombreTerceroEnc": "ALEJANDRA LOPEZ LOPEZ",
"fechaDocumento": "2023-03-01",
"detalles": [
{
"cuenta": 52954501,
"nitTerceroDet": "1234567890",
"nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
"naturaleza": "D",
"crucePrefijo": null,
"cruceNumero": null,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": 4,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
},
{
"cuenta": 23359501,
"nitTerceroDet": "1234567890",
"nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
"naturaleza": "C",
"crucePrefijo": "COM",
"cruceNumero": 3272,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": null,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
}
]
}
]
}

{
"success": true,
"code": 204,
"message": "No se encontraron registros",
}
</syntaxhighlight>

''' Campos del resultado'''
{| class="wikitable"
! Campo !! Tipo de Dato !! Descripción
|-
| id || int || Corresponde al id del registro contable
|-
| categoriaDocumento || string || Categoría del tipo de documento
|-
| prefijo || string || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero del documento contable
|-
| nitTerceroEnc || string || Numero de identificación del tercero del documento contable
|-
| nombreTerceroEnc || string || Nombre del tercero del documento contable
|-
| fechaDocumento || string || Fecha del documento contable
|-
| detalles || Array[ObjetoDetalle]* || Array de objetos de los detalles del documento contable
|}

''' ObjetoDetalle:'''
{| class="wikitable"
! Campo !! Tipo de Dato !! Descripción
|-
| cuenta || Int || Auxiliar o numero de cuenta contable del movimiento
|-
| nitTerceroDet || string || Numero de identificación del tercero del detalle
|-
| nombreTerceroDet || string || Nombre del tercero del detalle
|-
| naturaleza || string || Naturaleza del movimiento (C=Credito, D=Debito)
|-
| crucePrefijo || string || Prefijo del documento cruce
|-
| cruceNumero || Int || Numero del documento cruce
|-
| fechaVencimiento || string || Fecha de vencimiento del movimiento
|-
| valor || decimal || Valor del movimiento
|-
| baseImpuesto || decimal || Valor base de impuesto
|-
| cuota || Int || Numero de cuota, para documentos que manejan contabilización de cuotas
|-
| detalle || string || Comentarios del movimiento
|-
| idSubcentroCosto || Int || Id del subcentro de costo del movimiento
|-
| idCentroOperacion || Int || Id del centro de operacion del movimiento
|-
| idProyecto || Int || Id del proyecto del movimiento
|-
| idActividad || Int || Id de la actividad del movimiento
|-
| idSucursal || Int || Id de la sucursal del tercero del movimiento
|}
</Tab>


<Tab name = "API Crear">

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable
''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Body:'''
<syntaxhighlight lang="JSON">
[
{
"categoriaDocumento": "CCO",
"prefijo": "COM",
"numeroDoc": 2,
"nitTerceroEnc": "123456789",
"fechaDocumento": "2023-03-01",
"detalles": [
{
"cuenta": 52954501,
"nitTerceroDet": "123456789",
"naturaleza": "D",
"crucePrefijo": null,
"cruceNumero": null,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": 4,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
},
{
"cuenta": 23359501,
"nitTerceroDet": "123456789",
"naturaleza": "C",
"crucePrefijo": "COM",
"cruceNumero": 1,
"fechaVencimiento": null,
"valor": 67900.00000,
"baseImpuesto": 0.00000,
"cuota": 0,
"detalle": "SERV DE TRANSP INFORMAL",
"idSubcentroCosto": null,
"idCentroOperacion": 1,
"idProyecto": null,
"idActividad": null,
"idSucursal": null
}
]
}
]

</syntaxhighlight>

''' Campos resultado'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| categoriaDocumento || string || SI || Categoría del tipo de documento
|-
| prefijo || string || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero del documento contable
|-
| nitTerceroEnc || string || SI || Numero de identificación del tercero del documento contable
|-
| fechaDocumento || string || SI || Fecha del documento contable
|-
| detalles || Array[ObjetoDetalle]* || SI || Array de objetos de los detalles del documento contable
|}

''' ObjetoDetalle:'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| cuenta || Int || SI || Auxiliar o numero de cuenta contable del movimiento
|-
| nitTerceroDet || string || SI || Numero de identificación del tercero del detalle
|-
| naturaleza || string || SI || Naturaleza del movimiento (C=Credito, D=Debito)
|-
| crucePrefijo || string || NO || Prefijo del documento cruce
|-
| cruceNumero || Int || NO || Numero del documento cruce
|-
| fechaVencimiento || string || NO || Fecha de vencimiento del movimiento
|-
| valor || decimal || SI || Valor del movimiento
|-
| baseImpuesto || decimal || NO || Valor base de impuesto
|-
| cuota || Int || NO || Numero de cuota, para documentos que manejan contabilización de cuotas
|-
| detalle || string || NO || Comentarios del movimiento
|-
| idSubcentroCosto || Int || NO || Id del subcentro de costo del movimiento
|-
| idCentroOperacion|| Int || NO || Id del centro de operacion del movimiento
|-
| idProyecto || Int || NO || Id del proyecto del movimiento
|-
| idActividad || Int || NO || Id de la actividad del movimiento
|-
| idSucursal || Int || NO || Id de la sucursal del tercero del movimiento
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 201,
"errors": [],
"message": "Se crearon 10 de 10 documentos contables"
}
</syntaxhighlight>
</Tab>


<Tab name = "API Eliminar">
'''PUT/users'''

'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable
''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Body:'''
<syntaxhighlight lang="JSON">
{
"idTipoDocumento": 6,
"numeroDesde": 1,
"numeroHasta": 10000,
"fechaDesde": "2023-03-01",
"fechaHasta": "2023-03-31"
}
</syntaxhighlight>

''' Campos Solicitados '''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| idTipoDocumento || int || SI || Id del tipo de documento
|-
| numeroDesde || int || SI || Numero inicial para filtrar por rango de números de documentos
|-
| numeroHasta || int || SI || Numero final para filtrar por rango de números de documentos
|-
| fechaDesde || string || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
| fechaHasta || bool || SI || Fecha final para filtrar por rango de fecha del documento
|}

'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
"success": true,
"code": 200,
"errors": [],
"message": "Se eliminaron 10 de 10 documentos contables "
}

</syntaxhighlight>
</Tab>

</Tabs>

== Códigos de estado HTTP ==
{| class="wikitable left"
! Código !! Descripción
|-
| 200 || La solicitud ha sido exitosa
|-
| 201 || La solicitud ha tenido éxito y ha llevado a la creación de un recurso
|-
| 204 || La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
|-
| 400 || El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
|-
| 401 || La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
|-
| 403 || El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
|-
| 404 || El recurso solicitado no se ha encontrado en el servidor
|-
| 500 || Internal Server Error
|-
| 503 || El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal
|}

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/NotaTercero")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/NotaTercero");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/NotaTercero');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer {{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]

API Documentos Inventario

2023-07-28T16:17:59Z

Dvaldes: /* ¿Cómo consumir la API? */

API Devoluciones de Compra

2023-07-28T16:13:06Z

Dvaldes:

API Devoluciones de Compra

2023-07-28T16:12:13Z

Dvaldes:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Devolucion de Compras'''
* '''[[API Devolucion Compras|API Devolucion Compra]]'''
* [[API Tipos Documentos Modulo|API Tipos de Documentos (Devoluciones de Compra)]]
* [[API Documentos_Contables/Sucursales |API Sucursales]]
* [[API Documentos_Contables/Centro_Operaciones |API Centro Operaciones]]
* [[API Documentos_Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Ventas/Bodegas|API Bodegas]]
* [[API Terceros/Lista_Precios|API Lista Precios]]
* [[API Articulos|API Articulos]]

API Devoluciones de Compra

2023-07-28T16:11:59Z

Dvaldes:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Devolucion de Compras'''
* '''[[API Devolucion Compras|API Devolucion Compra]]'''
* [[API Tipos Documentos Modulo|API Tipos de Documentos (Devoluciones de Compras)]]
* [[API Documentos_Contables/Sucursales |API Sucursales]]
* [[API Documentos_Contables/Centro_Operaciones |API Centro Operaciones]]
* [[API Documentos_Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Ventas/Bodegas|API Bodegas]]
* [[API Terceros/Lista_Precios|API Lista Precios]]
* [[API Articulos|API Articulos]]

API Devoluciones de Venta

2023-07-28T16:10:31Z

Dvaldes:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''
* '''[[API Devolucion Ventas|API Devolucion Venta]]'''
* [[API Tipos Documentos Modulo|API Tipos de Documentos (Devoluciones de Venta)]]
* [[API Documentos_Contables/Sucursales |API Sucursales]]
* [[API Documentos_Contables/Centro_Operaciones |API Centro Operaciones]]
* [[API Documentos_Contables/Proyectos |API Proyectos]]
* [[API Terceros/Categoria_Terceros|API Categoria Terceros]]
* [[API Ventas/Bodegas|API Bodegas]]
* [[API Terceros/Lista_Precios|API Lista Precios]]
* [[API Terceros/Lista_Precios_Detalle|API Lista Precios Detalle]]
* [[API Articulos|API Articulos]]

API Modulo Ventas

2023-07-28T16:08:36Z

Dvaldes:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Ventas''' (Facturas)

*'''[[API Pedidos]]'''
*'''[[API Facturas]]'''
* [[API Tipos Documentos Modulo|API Tipos de Documentos (Módulo de Ventas)]]
* [[API Ventas/Sucursales|API Sucursales]]
* [[API Ventas/Bodegas|API Bodegas]]
* [[API Terceros/Lista_Precios|API Lista Precios]]
* [[API Terceros/Lista_Precios_Detalle|API Lista Precios Detalle]]
* [[API Articulos|API Articulos]]
* [[API Ventas/Factura_Venta|API Factura Venta]]
* [[API Ventas/Centro_Operaciones|API Centro Operaciones]]
* [[API Documentos_Contables/Proyectos|API Proyectos]]
* [[API_Documentos_Contables/Actividades|API Categoria]]

API Modulo Inventarios

2023-07-28T16:03:21Z

Dvaldes:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''
* '''[[API Inventarios/Saldo_Inventarios |API Saldo Inventario]]'''
* [[API Inventarios/Ajuste_Inventario |API Ajuste Inventario]]
* [[API Documentos Inventario|API Documentos Inventario]]
* [[API Articulos]]
* [[API Ventas/Bodegas|API Bodegas]]
* [[API Terceros/Grupo_Ventas_Compras|API Grupos Ventas/Compras]]

API Modulo Inventarios

2023-07-28T16:02:47Z

Dvaldes:

Esta es la documentación sobre las APIs relacionadas al módulo de '''Inventarios'''
* '''[[API Inventarios/Saldo_Inventarios |API Saldo Inventario]]'''
* [[API Inventarios/Ajuste_Inventario |API Ajuste Inventario]]
* [[API Documentos Inventario|API Documentos Inventario]]
* [[API Terceros/Grupo_Ventas_Compras|API Grupos Ventas/Compras]]
* [[API Articulos]]
* [[API Ventas/Bodegas|API Bodegas]]