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

# Sucursales

El servicio permite a los usuarios consultar el listado plano de sucursales (sin estructura jerárquica) en línea en formato JSON.

El método de solicitud es POST y se requiere un encabezado "Authorization" para la autenticación, que debe contener un token **JWT** obtenido previamente del servicio de [autenticación](https://tech.sedierp.com/quickstart.md).

## Prerequisitos

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

* Token solicitado mediante el API de [autenticación](https://tech.sedierp.com/quickstart.md)

## Consultar sucursales

**Request URL:** https\://\{\{Ambiente}}/API\_SIS/api/Sucursales/SucursalesConsultarPlano\
**Tipo:** POST \
**Content Type:** application/json

**Page** `int`

Página de consulta, por defecto (1).

**Rows** `int`

Cantidad de registros por página de consulta, por defecto (10).

**SucursalID** `int`

Filtro de búsqueda por código único de la sucursal (ID).

**Nombre** `string`

Filtro de búsqueda por nombre de la sucursal.

**DependeSucursalID** `int`

Filtro de búsqueda por código único de la sucursal de la cual depende (sucursal padre).

**PaisID** `int`

Filtro de búsqueda por código único del país de la sucursal.

**CiudadID** `int`

Filtro de búsqueda por código único de la ciudad de la sucursal.

**Activo** `bool`

Filtro por estado de la sucursal (true: activa, false: inactiva).

**RecepcionFE** `bool`

Filtro por sucursales habilitadas para la recepción de facturas electrónicas.

**SortColumn** `string`

Nombre de la columna por la cual se ordenan los resultados (ej. "Nombre").

**SortDirection** `string`

Dirección del ordenamiento de los resultados: "ASC" (ascendente) o "DESC" (descendente).

**FullSearch** `string`

Texto de búsqueda general aplicado sobre los campos de la consulta.

```bash theme={null}
curl --location 'https://nsx.sedierp.com/API_SIS/api/Sucursales/SucursalesConsultarPlano' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN_JWT>' \
--data '{
	"Page": 1,
	"Rows": 10,
	"SucursalID": null,
	"Nombre": null,
	"DependeSucursalID": null,
	"PaisID": null,
	"CiudadID": null,
	"Activo": true,
	"RecepcionFE": null,
	"SortColumn": "Nombre",
	"SortDirection": "ASC",
	"FullSearch": null
}'
```

```json Request theme={null}
{
  "Page": 1,
  "Rows": 10,
  "SucursalID": null,
  "Nombre": null,
  "DependeSucursalID": null,
  "PaisID": null,
  "CiudadID": null,
  "Activo": true,
  "RecepcionFE": null,
  "SortColumn": "Nombre",
  "SortDirection": "ASC",
  "FullSearch": null
}
```

```json Response theme={null}
{
    "total": 3,
    "rows": [
        {
            "SucursalID": 1,
            "Nombre": "PRINCIPAL BOGOTA",
            "DependeSucursalID": null,
            "PaisID": 1,
            "CiudadID": 1,
            "Activo": true,
            "RecepcionFE": true,
            "TotalRows": 3
        },
        {
            "SucursalID": 3,
            "Nombre": "SUCURSAL CALI",
            "DependeSucursalID": 1,
            "PaisID": 1,
            "CiudadID": 3,
            "Activo": true,
            "RecepcionFE": false,
            "TotalRows": 3
        },
        {
            "SucursalID": 2,
            "Nombre": "SUCURSAL MEDELLIN",
            "DependeSucursalID": 1,
            "PaisID": 1,
            "CiudadID": 2,
            "Activo": true,
            "RecepcionFE": false,
            "TotalRows": 3
        }
    ],
    "result": 1
}
```


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