API Documentos Contables/Impuestos

Descripción: Esta API permite la sincronizacion de impuestos 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 Tipo de Documento(GET)"> GET/users

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

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

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

Response

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "descripcion": "IVA COMPRA 5%",
            "valor": 5.00000,
            "aplica": 1,
            "_base": 0.00000,
            "cuenta_impuesto": 2659,
            "cuenta_impuesto_devolucion": 2659,
            "cuenta_impuesto_bonificado": null
        }  
]
}

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

Campo de resultados

Campo	Tipo	Descripción
id	int	Corresponde al identificador del impuesto
descripcion	string	Descripcion del impuesto
valor	string	Prefijo del tipo de documento
aplica	string	Descripcion del tipo de documento
_base	string	Descripcion del tipo de documento
cuenta_impuesto	string	Descripcion del tipo de documento
cuenta_impuesto_devolucion	string	Descripcion del tipo de documento
cuenta_impuesto_bonificado	string	Descripcion del tipo de documento

</Tab>

<Tab name = "API Crear(POST)"> POST/users EndPoint: https://www.apis.serpi.com.co/api/v1/AjusteInventario

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Body:

[
    {
        "categoriaDocumento": "AI",
        "prefijo": "AI",
        "fechaCorte": "2023-03-01",
        "idTipoAjuste": 2,
        "comentario": "Ajuste",
        "detalles": [
        {
            "idArticulo": 1,
            "idBodega": 1,
            "observaciones": "Ajuste Articulo",
            "saldo": 100.00
        },
        {
            "idArticulo": 2,
            "idBodega": 1,
            "observaciones": "Ajuste Articulo",
            "saldo": 50.00
        },
        {
            "idArticulo": 3,
            "idBodega": 1,
            "observaciones": "Ajuste Articulo",
            "saldo": 60.00
        }
        ]
    }
]

Campos

Campo	Tipo	Requerido	Descripción
categoriaDocumento	string	SI	Categoría del tipo de documento
prefijo	string	SI	Prefijo del tipo de documento
fechaCorte	string	SI	Fecha corte para creación del ajuste y para la consulta del saldo de unidades
idTipoAjuste	int	SI	Id del tipo de ajuste
comentario	string	SI	Comentarios
detalles	Array[ObjetoDetalle]*	SI	Array de objetos de los detalles del Ajuste

ObjetoDetalle*

Campo	Tipo	Requerido	Descripción
idArticulo	Int	SI	Id del artículo a ajustar
IdBodega	string	SI	Id de la bodega
observaciones	string	NO	Observaciones del ajuste
saldo	decimal	SI	Saldo real en bodega del artículo a ajustar

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

{
    "success": true,
    "code": 201,
    "errors": [],
    "message": "Se crearon 3 de 3 ajustes de inventario"
}

</Tab> <Tab name = "API Eliminar(DELETE)"> DELETE/users

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

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Body:

{
    "idTipoDocumento": 6,
    "numeroDesde": 1,
    "numeroHasta": 10000,
    "fechaDesde": "2023-03-01",
    "fechaHasta": "2023-03-31"
}

Campos

Campo	Tipo	Requerido	Descripción
idTipoDocumento	int	SI	Id del tipo de documento
numeroDesde	int	SI	Número inicial para filtrar por rango de números de documentos
numeroHasta	int	SI	Número 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:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Se eliminaron 10 de 10 ajustes de inventario"
}

</Tab> </Tabs>