API Tipos Documentos Modulo

Descripción: Esta API permite obtener los tipos de documentos por módulos (ventas, compras, devoluciones o ensambles/desensambles) disponibles en SERPI con el fin de que sean utilizados por una plataforma externa conservando la integridad de las transacciones entre las dos plataformas.

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.

Tipo de petición: GET

¿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 Tipos de Documento por módulo (GET)"> EndPoint: https://www.apis.serpi.com.co/api/v1/TipoDocumentoModulo

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/TipoDocumentoModulo?modulo=DEVOLUCION VENTAS

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
modulo	string	Sí	En este parámetro se debe indicar el módulo para retornar los tipos de documentos del mismo. Las opciones son las siguientes: VENTAS, DEVOLUCION VENTAS, COMPRAS, DEVOLUCION COMPRAS, PRODUCCION, INVENTARIOS u OTROS

Response

{
    "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",
}

Campo de resultados

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> </Tabs>