Skip to main content
This guide is for partners who used the Receipt API to retrieve receipts outside an export, for example to sync receipts to another system or to show them in a dashboard. If you fetch receipts while booking expenses in an Accounting System, see Migrate to the Export API (v3) instead.

New to the Accounting Entries API?

API Overview

What an Accounting Entry is and how the API is structured.

API Scopes

Required scope: accounting-entries:read.

Generate API Keys

How to generate standalone API keys for authenticating your integration.

Standalone API Key Guide

End-to-end guide for authenticating with standalone API keys.

Standalone API Keys with Postman

How to make API calls using standalone API keys in Postman.

Getting Started

You need API credentials with at least the accounting-entries:read scope. Once authenticated, you can use these endpoints.

Key Differences

  • Pass the legacy expenseId as the accountingEntryId, because both identify the same record.
  • The search endpoint is new. It returns receipts across Accounting Entries, so you no longer list the receipts of each Accounting Entry one by one.
  • The request body must include includeDeleted (set it to true to include deleted receipts). You can also filter by accountingEntryIds, employeeIds, fileType, mimeType and source.
  • The search endpoint needs one of the company_id, partner_id or organization_id query parameters.
  • The receipt endpoints return the ORIGINAL file by default. To get THUMBNAIL or PREVIEW, set the file_type query parameter on the GET endpoint, or fileType in the body of the search.
  • The list and search endpoints use cursor-based pagination. Use limit to set the page size. To read the next page, send the endCursor from the response as after, until hasNextPage is false. Use sorting_keys and sorting_order to sort the results.
  • The url of a receipt expires after 24 hours. Request the receipt again to get a new url.

Field Mapping

The table below maps fields from the legacy Receipt model to their equivalents in the receipt object that the Accounting Entries API returns.
  • — : field is not available in the Accounting Entries API receipt
  • * : data is the same but represented differently

New Fields in the Accounting Entries API Receipt

The following fields are available on the Accounting Entries API receipt with no equivalent in the legacy Receipt API.

FAQs

Which API replaces the legacy Receipt API?

It depends on whether you run an export.
  • If you book expenses in an Accounting System, use the Export API (v3). It provides receipts as attachments on Export Items.
  • To get receipts outside an Export Job, use the Accounting Entries API.
The Export API (v3) is not a standalone receipt lookup. To choose, see the Legacy Receipt API Overview.

How do I get receipts outside an Export Job?

  • Use GET /v1/accounting-entries/{accountingEntryId}/receipts. Pass the legacy expenseId as the accountingEntryId, because both identify the same record.
  • To search the receipts of many Accounting Entries in one request, use POST /v1/accounting-entries/receipts:search.
  • The endpoints return the ORIGINAL file by default. For THUMBNAIL or PREVIEW, set the file_type query parameter on the GET endpoint, or fileType in the body of the search.
  • The receipt url expires after 24 hours.