ECF Connector API

Verifica que la API Key sea válida y devuelve la información del conector. Úsalo para confirmar la autenticación antes de realizar operaciones.

Encabezados

Respuesta exitosa

{
  "message": "Autenticación exitosa",
  "code": 200,
  "data": {
    "client_id":   42,
    "client_name": "Mi Empresa S.R.L.",
    "state":       "active"
  }
}

Devuelve todos los impuestos configurados en el sistema. Los IDs obtenidos se usan en el campo tax_ids al crear facturas.

Respuesta exitosa

{
  "code": 200,
  "data": [
    { "id": 1, "name": "ITBIS 18%",  "amount": 18.0, "type_tax_use": "sale" },
    { "id": 2, "name": "ITBIS 16%",  "amount": 16.0, "type_tax_use": "sale" },
    { "id": 5, "name": "Exento (0%)", "amount": 0.0,  "type_tax_use": "sale" }
  ]
}

Retorna todos los tipos de documentos fiscales disponibles en el sistema.

Respuesta exitosa

{
  "code": 200,
  "data": [
    { "id": 10, "name": "Factura de Crédito Fiscal Electrónica", "prefix": "E31" },
    { "id": 11, "name": "Factura de Consumo Electrónica",       "prefix": "E32" }
  ]
}

Busca un tipo de documento específico por su prefijo (ej. E31, E34).

Parámetros de ruta

GET /api/ecf/type/document/E31

Crea un nuevo cliente en el sistema. Devuelve el id para usarlo como partner_id en futuras facturas.

Body (JSON)

Ejemplo de solicitud

{
  "name":        "Comercial Los Girasoles S.R.L.",
  "type_client": "tax_payer",
  "rnc":         "101234567"
}

Respuesta exitosa

{
  "code": 200,
  "data": {
    "id":   89,
    "name": "Comercial Los Girasoles S.R.L.",
    "type": "tax_payer",
    "rnc":  "101234567"
  }
}

Endpoint principal. Crea la factura en el sistema, la firma digitalmente con el certificado P12 y la envía a la DGII de forma automática.

Campos comunes

Ítems de línea (items[])

E33 — Nota de Débito

E34 — Nota de Crédito

E43 — Régimen Especial (compra)

E31 / E32 / E45 / E46 / E47 — Ventas

Ejemplo — Factura de venta (E32)

POST /api/ecf/send
Authorization: ECF-5-abc123...

{
  "ncf":              "E320000000001",
  "invoice_date_due": "2026-07-30",
  "partner_id":       89,
  "income_type":      "01",
  "items": [
    {
      "name":       "Servicio de consultoría",
      "quantity":   1,
      "price_unit": 5000.00,
      "tax_ids":    [1],
      "discount":   0
    }
  ]
}

Ejemplo — Nota de crédito (E34)

POST /api/ecf/send
Authorization: ECF-5-abc123...

{
  "ncf":               "E340000000001",
  "invoice_date_due":  "2026-07-30",
  "partner_id":        89,
  "ncf_modificate":    "E320000000001",
  "modification_code": "1",
  "base_amount":       5000.00,
  "tax_ids":           [1]
}

Respuesta exitosa

{
  "message": "Factura creada exitosamente",
  "code":    200,
  "data": {
    "invoice_id":     145,
    "invoice_name":   "E320000000001",
    "partner_id":     89,
    "partner_name":   "Comercial Los Girasoles S.R.L.",
    "ncf":            "E320000000001",
    "origin_ncf":     null,
    "ecf_status":     "sent",
    "move_type":      "out_invoice",
    "amount_untaxed": 5000.00,
    "amount_tax":     900.00,
    "amount_total":   5900.00,
    "qr_link":        "{URL_proporcionada}"
  }
}

Consulta el estado actual de una factura en el sistema. Para forzar actualización desde la DGII usa /get/{id}/now.

Parámetros de ruta

{
  "code": 200,
  "data": {
    "invoice_id":   145,
    "ncf":          "E320000000001",
    "ecf_status":   "success",
    "amount_total": 5900.00,
    "message_dgii": "Aceptado"
  }
}

Lista las facturas creadas por el conector con paginación y filtro opcional por estado.

Query params

GET /api/ecf/invoices?ecf_status=sent&limit=50

Fuerza una consulta en tiempo real a la DGII para actualizar el estado de la factura.

Descarga el XML sin firma del comprobante. La respuesta tiene Content-Type: application/xml.

GET /api/ecf/get/145/xml
# Response Content-Type: application/xml
# Body: <?xml version="1.0" ...><ECF>...</ECF>