Skip to main content

​
Overview

This changelog documents all notable changes to the Taxo API. We follow semantic versioning and maintain backward compatibility whenever possible.

​
Version 1.0.0

Released January 4, 2025 The initial release of Taxo API marks a complete implementation of enterprise-grade document extraction capabilities for Mexican tax documents.

​
🎉 Major Features

Introduced asynchronous job processing for all document extractions:
  • Each extraction request creates a unique job with publicId identifier
  • Background processing allows handling large document volumes efficiently
  • Real-time status tracking through dedicated endpoints
{
  "publicId": "JOB20250104123456789A",
  "status": "PROCESSING",
  "discoveryCount": 1500,
  "completedCount": 750
}
Complete support for all major Mexican tax document types:
  • INVOICE: CFDI invoices with both XML and PDF formats
  • TAX_STATUS: Constancia de Situación Fiscal documents
  • TAX_RETENTION: Tax retention certificates
Each type includes specific validation and processing rules.
Flexible filtering capabilities for precise document retrieval:
"filters": {
  "emitter": {
    "operator": "equals",
    "value": "TBO140305DH0"
  }
}
Supported operators: equals, contains, in
Real-time notifications system with semantic payload structure:
  • Event-driven notifications for job completion
  • Comprehensive payload with extraction context
  • HMAC-SHA256 signature verification for security
Example event types: invoice.ready, tax_status.ready, tax_retention.ready

​
🔧 API Endpoints

Three core endpoints provide complete extraction workflow:

Create Extraction

POST /v1/extractionsInitiates new document extraction job with credential validation and filter configuration.

Job Status

GET /v1/extractions/{publicId}Retrieves real-time job progress, document counts, and completion status.

Download Documents

GET /v1/extractions/{publicId}/documents/{documentId}/downloadSecure document retrieval with format selection (XML/PDF).

​
🏗️ Technical Architecture

Clean separation of concerns for different document types:
  • Dedicated processing strategies for each information type
  • Uniform API interface regardless of document complexity
  • Extensible architecture for future document types
Robust error handling and transaction management:
  • Compensating actions for failed operations
  • Consistent state management across distributed operations
  • Automatic retry mechanisms with exponential backoff
Enterprise-grade security implementations:
  • Encrypted credential storage and transmission
  • JWT-based authentication with API key management
  • Comprehensive audit logging for compliance

​
📊 Rate Limits & Performance

Production-ready policies for enterprise usage:
OperationLimitWindow
Extraction Creation10 requestsper hour
Status Checks100 requestsper minute
Document Downloads1,000 requestsper hour

​
🔐 Enhanced Security

  • Credential Management: Secure SAT credential handling with encrypted storage
  • API Authentication: Bearer token authentication with organization-level access control
  • Document Retention: 30-day secure storage with automatic cleanup
  • Webhook Security: HMAC signature verification and replay attack prevention

​
📚 Documentation & Developer Experience

Comprehensive documentation suite includes:
  • Interactive API reference with code examples
  • Integration best practices and security guidelines
  • Use case implementations for common scenarios
  • Troubleshooting guides and error handling patterns

​
🌟 Key Improvements

Performance: Parallel document processing reduces extraction time by up to 70% compared to sequential processing.
Reliability: Built-in retry mechanisms and circuit breaker patterns ensure 99.9% successful extraction rate.
Developer Experience: SDKs available for Node.js, Python, Java, and C# with consistent interfaces.

​
Breaking Changes

​
From Beta to 1.0.0

This section applies only to beta users. New integrations can ignore these changes.
  • Job Identifiers: Migrated from internal extractionId to public publicId format
  • Credential Structure: Updated to nested SAT object for enhanced security
  • Direction Values: Changed from RECEIVED/ISSUED to INBOUND/OUTBOUND for consistency
  • Filter Operators: Standardized operator naming conventions

​
Upcoming Features

These features are planned for future releases and subject to change.

​
Version 1.1.0 (Q2 2025)

  • Batch Processing: Multiple RFC processing in single request
  • Document Validation: Real-time CFDI validation against SAT schemas
  • Export Formats: JSON metadata extraction from XML documents

​
Version 1.2.0 (Q3 2025)

  • Advanced Analytics: Document processing insights and trends
  • Custom Webhooks: User-defined webhook payload customization
  • Bulk Downloads: Archive creation for multiple documents

​
Migration Guides

Beta to v1.0

Step-by-step migration guide for beta users upgrading to production API.

Integration Examples

Real-world implementation examples for common integration patterns.

​
Support & Feedback

Need Help with API Changes?
This changelog follows the Keep a Changelog format and adheres to Semantic Versioning.