Guides

🆕 Versioning

Here you’ll find all changes to our API, organized by date and version

Suggest Edits

🗓 30 Jun 2025 — Field Update to transactions-v3

We've updated the transactions-v3 data model to add the field hasExtractedDocuments, this field has two parts one is value that will have true or false and the other one is links that is redirect to the endpoint extracted-documents. This change enhances consistency across services and aligns with the broader data model strategy.

🔧 Affected Endpoints:

🗓 25 Jun 2025 — Audit API

We’ve introduced a new Audit API to provide enhanced visibility into API activity and improve observability across the platform.

🆕 New Endpoints

✨ Highlights:

  • Filtered logs only (by date: current month, a specific month and year, or a precise day) - no unfiltered access
  • Logs include metadata, such as request URI, method, token, status, chargeability
  • Improves monitoring, auditing, and billing visibility

This update is part of our commitment to building transparent and secure systems that empower teams to trace and audit platform activity with precision.

🗓 13 Jun 2025 — New Receipt Scanner Service

We’ve introduced a new Receipt Scanner service to enhance document processing and data extraction capabilities across the platform.

🆕 New Endpoint:

✨ Highlights:

  • Enables retrieval of documents automatically extracted from invoices, receipts, mexican_fiscal_invoices and other documents based on the associated transaction UUID.
  • Supports tighter integration between scanned receipt, invoices data and transaction records.
  • Lays the groundwork for future automation and smart reconciliation features.

This update is part of our ongoing efforts to streamline expense management and improve document intelligence throughout Clara’s ecosystem

🗓 26 May 2025 — Field Update to cards-v3

We've updated the cards-v3 data model to replace the deprecated claraStatus field with a new standardized status field. This change enhances consistency across services and aligns with the broader data model strategy.

🔧 Affected Endpoints:

✅ Update: Replace claraStatus with status in the API responses for the above endpoints.

⚠️ Action Required: Update your integrations accordingly

🗓 06 May 2024 — New Fields and Endpoints

🔧 Affected Endpoints:

  • Cards: Limit adjustment, lock/unlock card (PATCH)
  • Transactions: Added authorizationNumber → It refers to the approval number from MasterCard that is also on the Transactions report in the Clara Platform

🗓 15 Apr 2024 — Write Mode Launch

We're introducing WRITE MODE functionality for Cards, Labels, and Groups!

With the addition of Write Mode, you now have the ability to not only retrieve data but also create and manage cards, labels, and groups directly through our API. This expansion provides you with greater flexibility and control over your data, enabling you to tailor your applications to better suit your needs.

🔧 Affected Endpoints:

  • Cards: Create cards with custom rules
  • Groups: Create/manage groups
  • Labels: Create labels to classify transactions

🗓 26 Mar 2024 — User Field Update

🔧 Affected Endpoints:

  • Users: Changed userFullName format → We inverted the First Last Name and Second Last Name (Only MX and CO)

🗓 26 Feb 2024 — Filter Updates

🔧 Affected Endpoints:

  • Transactions: Added sort → Sort the results by specific fields and directions. (accountingDate | operationDate),(ASC | DESC)

🗓 21 Feb 2024 — More Field Updates

🔧 Affected Endpoints:

  • Transactions:
    • maskedPan: First 6 digits and last 4 digits of the card)
    • cardLastDigits: Masked Pan Last Digits of the card associated with the transactions)

🗓 19 Feb 2024 — Attachments and Filters

🔧 Affected Endpoints:

  • Transactions:
    • Attachments: Information about the files attached to the transaction
      • fileName
      • type: TRANSACTIONS_RECEIPT/TRANSACTIONS_INVOICE
      • hasReceipt: Boolean
      • hasInvoice: Boolean
  • userErpId: ERP id of the transaction user from the Team panel in Clara's Platform
  • username: Username of the transaction user

🗓 08 Feb 2024 — Field Modifications

🔧 Affected Endpoints:

  • Transactions:
    • statusCode → status
    • comments → comment
    • Removed: tax (because it didn't refer to the purchase taxes but rather to transaction values), expirationDate (Was a static value. We are creating a new field to bring this expiration value for each transaction)

🗓 15 Jun 2024 — New Fields

🔧 Affected Endpoints:

  • Transactions:
    • billingStatement: Billing statement dates - start, end, and dueDate
    • authorizationNumber: Number of authorization from a transaction

Updated about 10 hours ago