> ## 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 personas

El servicio permite consultar los tipos de personas (natural, jurídica, etc.) configurados para la empresa, en línea en formato JSON.

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

## Prerequisitos

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

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

## Consultar tipos de personas

**Request URL:** [https://portal.sedierp.com/API/api/TipoPersonas/TipoPersonasConsultar](https://portal.sedierp.com/API/api/TipoPersonas/TipoPersonasConsultar)\
**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 persona.

**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 persona 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/TipoPersonas/TipoPersonasConsultar' \
--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 personas 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:

**TipoPersonaID** `int`

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

**Nombre** `string`

Nombre del tipo de persona.

**Activo** `bool`

Indica si el tipo de persona está activo.

**DefaultPersonas** `bool`

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

**Abreviatura** `string`

Abreviatura del tipo de persona (máx. 4 caracteres).

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

```json Exitosa theme={null}
{
    "total": 2,
    "rows": [
        {
            "TipoPersonaID": 1,
            "Nombre": "Persona natural",
            "Activo": true,
            "DefaultPersonas": true,
            "Abreviatura": "PN"
        },
        {
            "TipoPersonaID": 2,
            "Nombre": "Persona jurídica",
            "Activo": true,
            "DefaultPersonas": false,
            "Abreviatura": "PJ"
        }
    ],
    "result": 1
}
```

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


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