Ir al contenido
AsterDocs
SitioCrear cuenta

Referencia

Referencia API

Todos los endpoints de Aster con ejemplos y una consola para probarlos con tu llave de prueba.

Referencia API

91 endpoints. Cada uno tiene ejemplos y una consola para probarlo con tu llave de prueba.

OpenAPI

Documentos

Emisión, consulta, descarga, envío por correo y anulación de comprobantes electrónicos.

  • POST/electronic-documentsEmitir un comprobante electrónico
  • GET/electronic-documents/{key}Ver un documento
  • GET/documentsListar documentos
  • GET/documents/exportExportar XML en ZIP
  • GET/documents/{key}/xmlDescargar el XML firmado
  • GET/documents/{key}/response-xmlDescargar el XML de respuesta de Hacienda
  • GET/documents/{key}/pdfDescargar el PDF
  • GET/documents/{key}/zipDescargar XML, respuesta y PDF en ZIP
  • POST/documents/{key}/emailEnviar el documento por correo
  • POST/documents/{key}/voidAnular un documento

Mensajes receptor

Aceptación, aceptación parcial o rechazo de comprobantes recibidos de proveedores.

  • POST/receptor-messagesAceptar, aceptar parcialmente o rechazar un comprobante recibido

Organizaciones

Contribuyentes de la cuenta, su perfil, certificado de firma, consecutivos y marca.

  • GET/organizationsListar organizaciones
  • POST/organizationsCrear una organización
  • GET/organizations/{org}Ver una organización
  • PATCH/organizations/{org}Actualizar una organización
  • DELETE/organizations/{org}Eliminar una organización
  • GET/organizations/meVer el perfil de la organización
  • PUT/organizations/meActualizar el perfil de la organización
  • GET/organizations/me/certificateEstado del certificado
  • POST/organizations/me/certificateSubir el certificado
  • DELETE/organizations/me/certificateEliminar el certificado
  • GET/organizations/me/consecutivesListar consecutivos
  • PUT/organizations/me/consecutivesAdelantar un consecutivo
  • GET/organizations/me/brandingVer la marca
  • PUT/organizations/me/brandingActualizar la marca
  • GET/companyVer el perfil (alias)
  • PUT/companyActualizar el perfil (alias)
  • GET/company/certificateEstado del certificado (alias)
  • POST/company/certificateSubir el certificado (alias)
  • DELETE/company/certificateEliminar el certificado (alias)

Claves API

Claves de cuenta y de organización.

  • GET/api-keysListar claves
  • POST/api-keysCrear una clave
  • DELETE/api-keys/{key}Revocar una clave
  • GET/auth/meClave actual

Cuenta y uso

Cuenta, plan, consumo del período y lista pública de precios.

  • GET/plansPlanes y paquetes
  • GET/accountVer la cuenta
  • GET/account/usageConsumo del período
  • POST/account/archiveActivar o desactivar Archeion

Webhooks

Notificaciones firmadas de cambios de estado de los documentos.

  • GET/webhooksListar webhooks
  • POST/webhooksCrear un webhook
  • GET/webhooks/{id}Ver un webhook
  • PUT/webhooks/{id}Actualizar un webhook
  • DELETE/webhooks/{id}Eliminar un webhook
  • POST/webhooks/{id}/testEnviar una prueba
  • POST/webhooks/{id}/regenerate-secretRegenerar el secreto
  • GET/webhooks/{id}/deliveriesRegistro de entregas
  • POST/webhooks/{id}/deliveries/{delivery}/redeliverReenviar una entrega

Receptores

Clientes guardados de la organización.

  • GET/recipientsListar receptores
  • POST/recipientsCrear un receptor
  • GET/recipients/lookupBuscar un receptor por identificación
  • GET/recipients/{id}Ver un receptor
  • PUT/recipients/{id}Reemplazar un receptor
  • DELETE/recipients/{id}Eliminar un receptor

Hacienda

Estado de Hacienda, consultas de comprobantes y registro de contribuyentes.

  • GET/hacienda/statusDisponibilidad de Hacienda y configuración
  • GET/hacienda/query/{clave}Consultar un comprobante en Hacienda
  • POST/hacienda/validateRevisión básica de un borrador
  • GET/hacienda/resolutionResolución registrada de un documento
  • GET/hacienda/taxpayersBuscar contribuyentes

Catálogos

Catálogos públicos de Hacienda (CABYS, partidas arancelarias, ubicaciones y tablas de códigos FE 4.4).

  • GET/reference/cabysBuscar códigos CABYS
  • GET/reference/cabys/categoriesCategorías CABYS de primer nivel
  • GET/reference/cabys/browseNavegar el catálogo CABYS
  • POST/reference/cabys/batchConsultar varios códigos CABYS
  • GET/reference/cabys/{code}Ver un código CABYS
  • GET/reference/tax-ratesTarifas de impuestos
  • GET/reference/provincesProvincias
  • GET/reference/cantons/{province}Cantones de una provincia
  • GET/reference/districts/{province}/{canton}Distritos de un cantón
  • GET/reference/neighborhoods/{province}/{canton}/{district}Barrios de un distrito
  • GET/reference/address-searchBuscar ubicaciones
  • GET/reference/document-typesTipos de comprobante
  • GET/reference/payment-methodsMedios de pago
  • GET/reference/sale-conditionsCondiciones de venta
  • GET/reference/reference-codesCódigos de referencia
  • GET/reference/reference-doc-typesTipos de documento de referencia
  • GET/reference/economic-activitiesActividades económicas comunes
  • GET/reference/tariff-codesBuscar partidas arancelarias
  • GET/reference/tariff-codes/chaptersCapítulos del arancel
  • GET/reference/tariff-codes/browseNavegar el arancel
  • POST/reference/tariff-codes/batchConsultar varias partidas
  • GET/reference/tariff-codes/{code}Ver una partida arancelaria

Tipo de cambio

Tipo de cambio de referencia, histórico y por entidad financiera.

  • GET/exchange-ratesTipo de cambio actual USD/CRC
  • GET/exchange-rates/historicalTipo de cambio histórico
  • GET/exchange-rates/pairTipo de cambio de un par de monedas
  • GET/exchange-rates/entitiesTipo de cambio por entidad financiera

Archivo

Archeion, el archivo fiscal de 5 años; exportaciones e importaciones.

  • GET/archiveRetención de la organización
  • GET/archive/exportsExportaciones recientes
  • POST/archive/exportsExportar un rango a ZIP
  • GET/archive/exports/{id}Estado de una exportación
  • GET/archive/exports/{id}/downloadDescargar el ZIP
  • POST/archive/importImportar comprobantes de otro proveedor

Estado

Salud del servicio.

  • GET/statusEstado del servicio