Establecimientos de un RUC GET
Devuelve los establecimientos de un RUC. La respuesta es plana.
GET /v1/consultas/establecimientos/{ruc}?filtro=...
Parametros#
| Parametro | Donde | Regla |
|---|---|---|
ruc |
ruta | RUC del contribuyente (13) |
filtro |
query, opcional | Todos (por defecto), SoloActivos (estado ABIERTO), SoloCerrados, SoloMatriz, SoloSucursales |
curl -s "https://staging-api.mynexusapi.com/v1/consultas/establecimientos/1760013210001?filtro=SoloActivos" \
-H "X-Api-Key: $ECUAFACT_API_KEY"
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-Api-Key", apiKey);
string url = "https://staging-api.mynexusapi.com/v1/consultas/establecimientos/1760013210001?filtro=SoloActivos";
string json = await http.GetStringAsync(url);
Console.WriteLine(json);
import os, requests
r = requests.get(
"https://staging-api.mynexusapi.com/v1/consultas/establecimientos/1760013210001",
headers={"X-Api-Key": os.environ["ECUAFACT_API_KEY"]},
params={"filtro": "SoloActivos"}, timeout=30)
print(r.status_code, r.text)
const url = new URL('https://staging-api.mynexusapi.com/v1/consultas/establecimientos/1760013210001');
url.search = new URLSearchParams({ filtro: 'SoloActivos' });
const res = await fetch(url, { headers: { 'X-Api-Key': process.env.ECUAFACT_API_KEY } });
console.log(res.status, await res.text());
<?php
$ch = curl_init('https://staging-api.mynexusapi.com/v1/consultas/establecimientos/1760013210001?filtro=SoloActivos');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('ECUAFACT_API_KEY')],
]);
$respuesta = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE) . ' ' . $respuesta;
curl_close($ch);
HttpClient cliente = HttpClient.newHttpClient();
HttpRequest peticion = HttpRequest.newBuilder()
.uri(URI.create("https://staging-api.mynexusapi.com/v1/consultas/establecimientos/1760013210001?filtro=SoloActivos"))
.header("X-Api-Key", System.getenv("ECUAFACT_API_KEY"))
.GET()
.build();
HttpResponse<String> respuesta = cliente.send(peticion, HttpResponse.BodyHandlers.ofString());
System.out.println(respuesta.statusCode() + " " + respuesta.body());
using Ecuafact.Sdk;
using Ecuafact.Sdk.Contracts;
// client: cliente EcuafactClient - ver SDK .NET
EstablecimientosContribuyente establecimientos =
await client.ListarEstablecimientosAsync("1760013210001", "SoloActivos");
Console.WriteLine(establecimientos.Cantidad);
from ecuafact import EcuafactClient
# client: cliente EcuafactClient - ver SDK Python
establecimientos = client.listar_establecimientos("1760013210001", "SoloActivos")
print(establecimientos.cantidad)
import { EcuafactClient } from "@ecuafact/sdk";
// client: cliente EcuafactClient - ver SDK Node.js
const establecimientos = await client.listarEstablecimientos("1760013210001", "SoloActivos");
console.log(establecimientos.cantidad);
<?php
use Ecuafact\Sdk\EcuafactClient;
// $client: cliente EcuafactClient - ver SDK PHP
$establecimientos = $client->listarEstablecimientos('1760013210001', 'SoloActivos');
echo $establecimientos->cantidad;
import com.ecuafact.sdk.EcuafactClient;
// client: cliente EcuafactClient - ver SDK Java
EstablecimientosContribuyente establecimientos = client.listarEstablecimientos("1760013210001", "SoloActivos");
System.out.println(establecimientos.cantidad());
{
"ruc": "1760013210001",
"filtro": "SoloActivos",
"cantidad": 1,
"establecimientos": [
{ "numero": "001", "nombreComercial": "SUCURSAL CENTRO", "tipo": "MATRIZ",
"direccionCompleta": "AV. PRINCIPAL 123", "estado": "ABIERTO", "esMatriz": true }
]
}
Respuesta#
| Campo | Significado |
|---|---|
ruc |
RUC consultado |
filtro |
Filtro aplicado |
cantidad |
Numero de establecimientos devueltos |
establecimientos[].numero |
Numero del establecimiento |
establecimientos[].nombreComercial |
Nombre comercial |
establecimientos[].tipo |
Matriz o sucursal |
establecimientos[].direccionCompleta |
Direccion |
establecimientos[].estado |
Estado (ABIERTO, CERRADO) |
establecimientos[].esMatriz |
true si es la matriz |
Estados de este endpoint#
| Codigo | HTTP | Cuando ocurre | Que hacer |
|---|---|---|---|
200 |
200 | Consulta exitosa | Lee los establecimientos |
303 |
400 | filtro invalido |
Ajusta el filtro |
502 |
404 | Sin resultado | Revisa el RUC |
104 |
429 | Limite de solicitudes | Espera y reintenta |
003 / 004 |
502 / 504 | Fuente caida o sin respuesta | Reintenta |
El catalogo completo esta en Errores.
Esta consulta no consume cupo de documentos.