ES | EN

Ejemplos por país

📄 Documento MIPYME

Nota: Esta funcionalidad es parte de nuestro "Plan factoring" y solo está disponible para empresas que usan o han usado el sistema MIPYME. Este endpoint no funciona para recuperar documentos emitidos en sistemas de mercado.

El endpoint /mipyme_get_document le permite recuperar documentos que fueron emitidos usando el sistema MIPYME. Esto es particularmente útil para empresas que necesitan acceder a documentos históricos o documentos creados en la plataforma MIPYME.

Consideraciones importantes

  • Este endpoint es solo para empresas que usan o han usado el sistema MIPYME
  • No funciona para recuperar documentos emitidos en sistemas de mercado
  • Esta funcionalidad es parte de nuestro "Plan factoring"
  • Necesitará el certificado PFX y la contraseña que se usaron en el sistema MIPYME
  • El certificado debe ser válido y coincidir con el RUT de la empresa

Obtener un documento MIPYME

Para recuperar un documento MIPYME, debe utilizar el endpoint /mipyme_get_document con los parámetros correspondientes. Necesitará:

  • El certificado PFX en formato base64

  • La contraseña del certificado

  • El RUT de la empresa (identificación tributaria)

  • El tipo de documento según el SII

  • El número de folio del documento

  • Endpoint: https://api-billing.koywe.com/V1/mipyme_get_document

  • Método: POST

  • Cabeceras requeridas:

    • Content-Type: application/json
    • Authorization: Bearer \<token>
    • Accept: /
{
  "certificate_pfx_base64": "MIIKpAIBAzCCCl4GCSqGSIb3DQEHAaCCCk8EggpLMIIKRzCCBXsGCSqGSIb3DQEHBqCCBWwwggVoAgEAMIIFYQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQI...",
  "certificate_password": "your_certificate_password",
  "tax_id_code": "12345678-9",
  "document_type_taxbureau": "33",
  "document_number": "12345"
}

Parámetros de la solicitud

Parámetro Tipo Requerido Descripción
certificate_pfx_base64 string Sí Certificado PFX codificado en base64 utilizado en el sistema MIPYME
certificate_password string Sí Contraseña del certificado PFX
tax_id_code string Sí RUT de la empresa en formato 12345678-9
document_type_taxbureau string Sí Tipo de documento según el SII (por ejemplo, "33" para Factura Electrónica)
document_number string Sí Número de folio del documento

Respuesta

La API devolverá una respuesta con la siguiente estructura:

{
  "status": 0,
  "message": "XML obtenido correctamente",
  "document_xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}

Códigos de estado de la respuesta

El campo status indica el resultado de la operación:

Estado Descripción
0 XML obtenido ok - Documento recuperado exitosamente
1 Parámetros con error - Parámetros inválidos
2 No fue posible abrir el certificado con la clave entregada - No se pudo abrir el certificado con la contraseña proporcionada
3 No fue posible iniciar sesión en el SII - No se pudo iniciar sesión en el SII
5 Documento no encontrado - Documento no encontrado

Ejemplos de respuestas

Respuesta exitosa (estado 0):

{
  "status": 0,
  "message": "XML obtenido correctamente",
  "document_xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}

Respuesta de error - Parámetros inválidos (estado 1):

{
  "status": 1,
  "message": "Parámetros con error",
  "document_xml": ""
}

Respuesta de error - Error de certificado (estado 2):

{
  "status": 2,
  "message": "No fue posible abrir el certificado con la clave entregada",
  "document_xml": ""
}

Respuesta de error - Error de inicio de sesión en SII (estado 3):

{
  "status": 3,
  "message": "No fue posible iniciar sesión en el SII",
  "document_xml": ""
}

Respuesta de error - Documento no encontrado (estado 5):

{
  "status": 5,
  "message": "Documento no encontrado",
  "document_xml": ""
}

Formato del certificado

El certificado debe proporcionarse como una cadena codificada en base64 del archivo PFX. Asegúrese de:

  • Usar el certificado exacto que se utilizó en el sistema MIPYME
  • Codificar todo el contenido del archivo PFX en base64
  • Verificar que el certificado siga siendo válido y no haya expirado
  • Usar la contraseña correcta asociada al certificado

Tipos de documentos

El parámetro document_type_taxbureau debe coincidir con los códigos de tipo de documento del SII:

Código Tipo de documento
30 Factura
33 Factura Electrónica
34 Factura Exenta
39 Boletas de Ventas y Servicios
46 Factura de Compra
52 Guía de Despacho
56 Nota de Débito
61 Nota de Crédito

Referencia de API POST /mipyme_get_document

Documentación detallada del endpoint: /english/billing/api-reference/billing-api/mipyme-documents/get-mipyme-document