Consultar Establecimientos

Consultar Establecimientos

Pruebas

Dominio: https://test-api-factura.edw-dev.com

Producción

Dominio: https://api-financiero.e-dinky.com

Información General

• Endpoint: GET /api/v1/companies/accounts/establishments/:companyId/:accountId
• Método: GET
• Autenticación: Bearer Token requerido
• Descripción: Consulta los establecimientos asociados a una cuenta empresarial específica

Headers Requeridos

Authorization: Bearer {token}
Accept: application/json

Parámetros de URL

Parámetro	Tipo	Requerido	Descripción
companyId	string	Sí	ID de la empresa (RUC)
accountId	string	Sí	ID de la cuenta empresarial

Parámetros de Query (Opcionales)

Parámetro	Tipo	Descripción
page	integer	Número de página (por defecto: 1)
per_page	integer	Elementos por página (por defecto: 25)

Ejemplo de Request

GET /api/v1/companies/accounts/establishments/1359194914/509636719?page=1&per_page=25
Authorization: Bearer {token}
Accept: application/json

Respuesta Exitosa (200 OK)

{
    "message": "Lista de valores",
    "status": "OK",
    "payload": {
        "items": [
            {
                "establishment": "001",
                "name": "Matriz",
                "address": "Av. Principal 123",
                "phone": "02-2345678",
                "email": "[email protected]",
                "status": "active"
            },
            {
                "establishment": "002",
                "name": "Sucursal Norte",
                "address": "Calle Secundaria 456",
                "phone": "02-3456789",
                "email": "[email protected]",
                "status": "active"
            }
        ],
        "count_items": 2,
        "current_page": 1,
        "number_paginate": 25,
        "last_page": 1
    }
}

Respuesta de Error (404 Not Found)

{
    "message": "La cuenta no existe",
    "status": "ERROR",
    "payload": null,
    "error": "La cuenta no existe"
}

Ejemplos de Código

cURL

curl -X GET \
  {{apiFacEcDev}}/api/v1/companies/accounts/establishments/1359194914/509636719 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {{bearerToken}}'

Laravel PHP

use Illuminate\Support\Facades\Http;

$response = Http::withHeaders([
    'Authorization' => 'Bearer ' . $bearerToken,
    'Accept' => 'application/json',
])->get("{{apiFacEcDev}}/api/v1/companies/accounts/establishments/{$companyId}/{$accountId}");

$establishments = $response->json();

JavaScript

const getEstablishments = async (companyId, accountId) => {
    try {
        const response = await fetch(`{{apiFacEcDev}}/api/v1/companies/accounts/establishments/${companyId}/${accountId}`, {
            method: 'GET',
            headers: {
                'Authorization': `Bearer ${bearerToken}`,
                'Accept': 'application/json'
            }
        });

        const data = await response.json();
        return data;
    } catch (error) {
        console.error('Error:', error);
    }
};

Casos de Uso

📋 Listado de Establecimientos

• Obtener todos los establecimientos de una empresa
• Mostrar información básica de contacto
• Verificar estados de establecimientos

🏢 Gestión Empresarial

• Selección de establecimiento para emisión de documentos
• Configuración de puntos de emisión por establecimiento
• Administración de sucursales

Notas Importantes

• Paginación: Los resultados están paginados por defecto
• Estados: Solo se muestran establecimientos activos
• Permisos: Requiere acceso a la cuenta empresarial específica
• Formato: Los códigos de establecimiento siguen el formato SRI (001, 002, etc.)