Configuring API for Custom Accounting Software Integration
While Receipt Bot offers direct integrations with major accounting platforms, our open API provides the ultimate flexibility to connect with any custom-built software, proprietary systems, or powerful automation tools. By leveraging the API, you can create a completely customised workflow for uploading documents and receiving extracted data, tailored precisely to your needs.
This article provides an overview of the Receipt Bot API and how you can utilise it to build your integrations. For complete technical specifications, endpoint details, and code examples, please refer to our official Receipt Bot API Documentation.
Prerequisites
- A Receipt Bot account with an active subscription.
- Account Owner or Admin permissions to generate and view API keys.
- A basic understanding of REST APIs and JSON data format.
Generating Your API Keys
Before you can make any API calls, you need to generate your unique API keys. These keys authenticate your requests and link them to your account.
Step 1 – Navigate to the Business Configuration page from the side menu and select the Integrations tab.
Step 2 – Click the “File Upload API” tab.
Step 3 – Click the “Show Keys” text.
Your Organisation API Key and Business ID will be displayed. You will need these for all API requests. Keep them secure and do not expose them in client-side code.
Core API Capabilities
The integration process is built around three main components: uploading documents, polling for data, and receiving data automatically via webhooks.
1. Uploading Documents via API
You can programmatically send documents to Receipt Bot for processing. This is ideal for workflows where documents are generated or received in another system.
You make a POST request to our “/FileUpload” endpoint, sending the file content (base64 encoded) and other metadata. The API will immediately return a unique document ID for the uploaded file. This triggers the data extraction process in the background. The extracted data is not returned in this initial response.
2. Retrieving Extracted Data
Once a document is processed, you have two ways to get the extracted data:
Option A: Automated Push via Webhooks (Recommended)
This is the most efficient method for receiving data. You provide a URL, and Receipt Bot ‘push’ the extracted data to that URL as soon as it’s ready.
You can follow these steps to set up a webhook URL:
Step 1 – On the Integrations page, locate your API connection and click the Add Webhook button.
Step 2 – In the pop-up window, enter the Webhook URL provided by your custom software or automation tool (like Zapier or Make).
Step 3 – (Optional) For added security, check the Basic Authentication box and provide the Username and Password that your system requires to authorise incoming requests.
Step 4 – Click the Save button. (Your webhook is now active.)
Step 5 – To verify that your setup is working correctly, click the “Test Webhook” button at the top right.
Step 6 – Select a test event from the dropdown, such as “Send Bank Statement Data,” and click the Test button.
Step 7 – Check your server or application to confirm that you have successfully received the sample data payload from Receipt Bot.
Using a webhook creates a real-time, event-driven workflow that eliminates the need for you to check for updates constantly. As soon as a document is processed, Receipt Bot sends a complete JSON payload with all header and line-item details directly to your system.
For detailed information on the JSON structure of webhook payloads, please check the following link: Receipt Bot API Documentation.
Option B: On-Demand Pull via “Get Data” APIs
If you prefer to fetch data on your schedule, you can “poll” our Get Data APIs using the documentId ID you received during the upload.
For complete details about the API URL and the structure of the API response JSON, please visit the following link: Receipt Bot API Documentation.
Related Articles
Frequently Asked Questions
Q: Where can I find the full technical details for the API?
A: All technical specifications, including endpoints, required parameters, authentication methods, and example requests/responses, are available in our official Postman API Documentation.
Q: What is the difference between using a Webhook and the “Get Data” API?
A: A Webhook is a “push” method where Receipt Bot automatically sends you data when it’s ready. The “Get Data” API is a “pull” method, where you must periodically request Receipt Bot to check if the data is available. We recommend webhooks for efficiency.
Q: What happens if my webhook endpoint is down and an export fails?
A: Receipt Bot will attempt to resend the data three times at 10-minute intervals. If it continues to fail, the document will be marked with an export error in the app, and you can manually trigger the export.
Q: Can I retrieve extracted data for invoices and receipts via API?
A: Currently, the documented “Get Data” API is specifically designed for bank and card statements. The API for retrieving invoice and receipt data is in development and will be available soon. In the meantime, you can use webhooks to receive this data automatically.