Receptores

Buscar los receptores de un negocio

GET
/v1/ec/recipients

Las personas y empresas a quienes un negocio ha emitido comprobantes en el ambiente de tu clave, la más reciente primero: se agregan solas al emitir o importar. q busca por nombre o por identificación; counts cuenta sus receptores sin filtrar.

Autorización

AutorizaciónBearer <tu clave API>

Tu clave API: fb_sandbox_… emite en Sandbox, fb_test_… en test, el servicio de pruebas de la autoridad tributaria, y fb_live_… en live, su producción.

En: header

Parámetros de consulta

limit?integer

Cuántos por página, de 1 a 100.

Rango1 <= value <= 100
Por defecto20
cursor?string

El next_cursor o el prev_cursor de una respuesta anterior. Sin cursor, la primera página.

Longitudlength <= 200
entity_id?string

El negocio cuyos receptores quieres. Sin él, el único negocio de la organización para el ambiente de tu clave; 422 si hay varios.

Formatouuid
q?string

Palabras del nombre (sin importar mayúsculas ni tildes), o el comienzo de un RUC o una cédula.

Longitud1 <= length <= 100
portal_request?"pending"

pending: solo quienes pidieron cambiar su correo desde el portal y esperan tu decisión.

Valores posibles

  • "pending"
email_bounced?"true"

true: solo quienes tienen el correo rebotado (email_bounced), para avisarles por otro medio.

Valores posibles

  • "true"

Cuerpo de la respuesta

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/ec/recipients"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "recipient",      "identification": "string",      "name": "string",      "email": "string",      "currency": "string",      "year_count": 0,      "year_total": "string",      "sales_total": "string",      "phone": "string",      "email_bounced": true,      "last_issue_date": "2019-08-24",      "sri_status": "active",      "portal_request": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "entity_id": "8161163a-f227-466f-bc01-090a01e80165",        "email": "user@example.com",        "created_at": "2019-08-24T14:15:22Z"      },      "created_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "prev_cursor": "string",  "counts": {    "all": 0,    "portal_request": 0,    "email_bounced": 0  }}