> ## Documentation Index
> Fetch the complete documentation index at: https://tech.sedierp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tipos de documentos

El servicio permite consultar los tipos de documentos de identificación configurados para la empresa, en línea en formato JSON.

Se utiliza para obtener el `TipoDocumentoID` que solicitan los servicios de [inicio de sesión](https://tech.sedierp.com/inicio-de-sesion.md), [correo de recuperación](https://tech.sedierp.com/enviar-correo-recuperacion.md) y registro de terceros.

El método de solicitud es POST y no requiere autenticación.

## Prerequisitos

Antes de realizar la consulta de tipos de documentos, se debe contar con los siguientes datos:

* Identificador único de la empresa (UUID) asignado por SEDI-ERP

## Consultar tipos de documentos

**Request URL:** [https://portal.sedierp.com/API/api/TiposDocumentos/TiposDocumentosConsultar](https://portal.sedierp.com/API/api/TiposDocumentos/TiposDocumentosConsultar)\
**Tipo:** POST \
**Content Type:** application/json

**UUID** `GUID` *required*

Identificador único de la empresa.

**Nombre** `string`

Filtro de búsqueda por cualquier parte del nombre del tipo de documento.

**Activo** `bool`

Filtro de búsqueda por estado: `true` para obtener los activos, `false` para obtener los inactivos y `null` para obtener todos.

**DefaultPersonas** `bool`

Filtro de búsqueda por tipos de documento por defecto: `true` para obtener los que están marcados por defecto, `false` para obtener los que no lo están y `null` para obtener todos.

```bash theme={null}
curl --location 'https://portal.sedierp.com/API/api/TiposDocumentos/TiposDocumentosConsultar' \
--header 'Content-Type: application/json' \
--data '{
	"UUID": "2be0e514-4eb7-4677-b4b0-4a08936bfbee",
	"Nombre": null,
	"Activo": true,
	"DefaultPersonas": null
}'
```

### Respuesta

El servicio retorna el listado de tipos de documentos de la empresa que cumplen con los filtros. Si el `UUID` no corresponde a ninguna empresa, retorna `rows` vacío; si no se envía, responde HTTP 400 con el error de la base de datos en el campo `Message`. Cada registro de `rows` contiene los siguientes campos:

**TipoDocumentoID** `int`

Código único del tipo de documento (ID).

**Nombre** `string`

Nombre del tipo de documento.

**Activo** `bool`

Indica si el tipo de documento está activo.

**DefaultPersonas** `bool`

Indica si el tipo de documento está marcado por defecto.

**CodigoExterno** `string`

Código DIAN del tipo de documento (ej. "13" para cédula de ciudadanía, "31" para NIT).

**Abreviatura** `string`

Abreviatura del tipo de documento.

```json Request theme={null}
{
  "UUID": "2be0e514-4eb7-4677-b4b0-4a08936bfbee",
  "Nombre": null,
  "Activo": true,
  "DefaultPersonas": null
}
```

```json Exitosa theme={null}
{
    "total": 4,
    "rows": [
        {
            "TipoDocumentoID": 1,
            "Nombre": "Cédula de ciudadanía",
            "Activo": true,
            "DefaultPersonas": true,
            "CodigoExterno": "13",
            "Abreviatura": "C.C"
        },
        {
            "TipoDocumentoID": 2,
            "Nombre": "NIT",
            "Activo": true,
            "DefaultPersonas": false,
            "CodigoExterno": "31",
            "Abreviatura": "NIT"
        },
        {
            "TipoDocumentoID": 3,
            "Nombre": "Cédula de extranjería",
            "Activo": true,
            "DefaultPersonas": false,
            "CodigoExterno": "22",
            "Abreviatura": "C.E"
        },
        {
            "TipoDocumentoID": 4,
            "Nombre": "Pasaporte",
            "Activo": true,
            "DefaultPersonas": false,
            "CodigoExterno": "41",
            "Abreviatura": "PA"
        }
    ],
    "result": 1
}
```

```json Error theme={null}
{
    "Message": "Procedure or function 'CRUDS_TiposDocumentos' expects parameter '@UUID', which was not supplied., "
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.