Listar comprobantes de retención
Del más reciente al más antiguo, en el ambiente de tu clave.
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
Cuántos por página, de 1 a 100.
1 <= value <= 10020El next_cursor o el prev_cursor de una respuesta anterior. Sin cursor, la primera página.
length <= 200Solo en estos estados; repítelo para varios (status=returned&status=not_authorized).
Solo los que llegaron por estos canales; repítelo para varios.
Solo los de este negocio; sin él, los de todos los negocios de tu organización en este ambiente.
uuidLa identificación del comprador o proveedor del comprobante; en una guía de remisión, la del transportista o la de cualquiera de sus destinatarios.
Busca palabras en el número (001-001-000000123), la clave de acceso, el nombre de quien figura en el comprobante (sin distinguir mayúsculas ni tildes) o el inicio de su identificación. Cada palabra debe aparecer en alguna parte; se combina con los demás filtros.
1 <= length <= 100datedatedate-timedate-timeSolo los comprobantes cuya metadata tiene exactamente estos pares, por ejemplo metadata[shopify_order_id]=5812345678901. Hasta 20; todos deben coincidir.
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/withholdings"{ "object": "list", "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "country": "ec", "currency": "string", "environment": "sandbox", "status": "pending", "status_transitions": { "pending": "2019-08-24T14:15:22Z", "submitted": "2019-08-24T14:15:22Z", "authorized": "2019-08-24T14:15:22Z", "returned": "2019-08-24T14:15:22Z", "not_authorized": "2019-08-24T14:15:22Z", "annulled": "2019-08-24T14:15:22Z" }, "entity_id": "8161163a-f227-466f-bc01-090a01e80165", "number": "string", "access_key": "stringstringstringstringstringstringstringstrings", "authorization": { "number": "string", "authorized_at": "2019-08-24T14:15:22Z" }, "sri_messages": [ { "code": "string", "message": "string", "detail": "string", "type": "error" } ], "metadata": { "property1": "string", "property2": "string" }, "issued_at": "2019-08-24T14:15:22Z", "delivery_status": "sent", "emails": [ { "to": "string", "status": "sent", "sent_at": "2019-08-24T14:15:22Z", "delivered_at": "2019-08-24T14:15:22Z", "opened_at": "2019-08-24T14:15:22Z", "bounced_at": "2019-08-24T14:15:22Z", "complained_at": "2019-08-24T14:15:22Z", "bounce_type": "permanent" } ], "portal_views": 0, "portal_last_viewed_at": "2019-08-24T14:15:22Z", "channel": "api", "import_id": "13230382-dadc-41f2-963d-e123bd5c0585", "verification": "sri", "listing": { "import_id": "13230382-dadc-41f2-963d-e123bd5c0585", "file": "string", "entry": "string", "sha256": "stringstringstringstringstringstringstringstringstringstringstri", "line": 1, "authorized_at": "2019-08-24T14:15:22Z" }, "object": "withholding", "issue_date": "string", "fiscal_period": "string", "supplier": { "identification_type": "ruc", "identification": "string", "name": "string", "address": "string", "email": "string" }, "supplier_type": "persona_natural", "related_party": true, "support_documents": [ { "document_type": "factura", "number": "string", "issue_date": "string", "authorization_number": "string", "accounting_date": "string", "tax_support": "10", "foreign_payment": { "regime": "general", "country": "string", "double_taxation_treaty": true, "subject_to_withholding": true, "preferential_regime_payment": true }, "subtotal": "string", "total": "string", "taxes": [ { "type": "iva", "rate": "iva_15", "base": "string", "value": "string" } ], "withholdings": [ { "tax": "renta", "code": "string", "percent": "string", "base": "string", "value": "string", "dividends": { "payment_date": "string", "income_tax_paid": "string", "fiscal_year": "string" }, "banana_boxes": { "boxes": 0, "box_price": "string" } } ], "reimbursement": { "document_type": "factura", "total": "string", "base": "string", "tax": "string", "documents": [ { "supplier": { "identification_type": "ruc", "identification": "string" }, "supplier_type": "persona_natural", "payment_country": "string", "document_type": "factura", "number": "string", "issue_date": "string", "authorization_number": "string", "taxes": [ { "type": "iva", "rate": "iva_15", "base": "string", "value": "string" } ], "compensations": [ { "code": "string", "rate": "string", "value": "string" } ] } ] }, "payments": [ { "method": "sin_sistema_financiero", "amount": "string", "term": { "length": 0, "unit": "days" } } ] } ], "renta": "string", "iva": "string", "isd": "string", "total": "string", "fiscal_machine": { "brand": "string", "model": "string", "serial": "string" }, "additional_info": [ { "name": "string", "value": "string" } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "string", "prev_cursor": "string", "total_count": 0, "offset": 0}Emitir comprobante de retención POST
Numera el comprobante, lo guarda y lo encola para firmarlo y enviarlo al SRI. El estado avanza solo: consúltalo o recibe un webhook. Envía un `Idempotency-Key` para reintentar sin duplicar.
Consultar comprobante de retención GET
El comprobante con su estado actual y su clave de acceso, tal como Fiscalbase lo conoce. Solo lee: no pregunta al SRI en ese momento; para eso está `POST /v1/ec/documents/{id}/refresh-status`.