Contents
- Overview
- Prerequisites
- Configure Batch Processing
- How Batch Processing Works
- Supported Objects and Operations
- Monitor Batch Processing Jobs
- Batch Processing Behavior
- Best Practices
- Limitations
- Troubleshooting
- Frequently Asked Questions
Overview
QuickBooks Batch Processing improves synchronization performance by processing multiple integration events in a single batch instead of processing each event individually.
When enabled, Ordway groups eligible integration events and submits them together using QuickBooks batch APIs. This reduces the number of background jobs, minimizes API requests, and improves synchronization performance for organizations processing large transaction volumes.
Batch processing is particularly beneficial during high-volume periods, such as month-end processing, when many accounting synchronization events are generated.
Note |
Batch Processing changes how integration events are processed but does not change the synchronization results. |
Benefits
Batch Processing provides the following benefits:
- Reduces the number of background jobs.
- Improves synchronization performance.
- Reduces QuickBooks API requests.
- Optimizes database operations by processing multiple records together.
- Improves scalability for high-volume integrations.
- Improves overall integration throughput during high-volume synchronization.
Prerequisites
Before enabling Batch Processing, ensure that:
- QuickBooks Online integration is configured.
- The integration supports batch operations.
- You have permission to modify QuickBooks integration settings.
Configure Batch Processing
Procedure
- On the left navigation menu, click Setup → Integrations → Integration Settings. The Integration Settings page is displayed.
- Locate QuickBooks Online and click Settings. The QuickBooks Online - Integration Settings page is displayed.
- Click Default Settings. The Default QuickBooks Settings page is displayed.
- Enable the Enable Bulk API Calls toggle.
- Click Save.
Result
Batch Processing is enabled for the selected QuickBooks company. Ordway automatically processes eligible integration events in batches to improve synchronization performance.
Batch Processing Settings
Configure the following settings to control how integration events are processed.
| Setting | Description |
| Enable Bulk API Calls | Enables or disables QuickBooks Batch Processing for the selected QuickBooks integration. When enabled, eligible integration events are processed in batches using the QuickBooks Batch API. |
Batch Processing Behavior
When Enable Bulk API Calls is enabled
Ordway automatically:
- Marks eligible integration events as Pending.
- Groups pending events into batches.
- Processes the batches using the QuickBooks Batch API.
- Updates the processing status for each integration event individually.
Batch size and synchronization intervals are configured internally by Ordway and require no additional user configuration.
When Enable Bulk API Calls is disabled
Ordway:
- Processes each integration event individually.
- Sends a separate QuickBooks API request for each event.
- Uses the standard synchronization workflow.
How Batch Processing Works
When Batch Processing is enabled, Ordway performs the following steps:
- A user action or API request creates an integration event.
- Ordway determines whether the event is eligible for batch processing.
- Eligible integration events are marked as Pending.
- Ordway groups eligible pending integration events into batches and processes them using the QuickBooks Batch API. Batch size and processing intervals are managed internally by Ordway to optimize synchronization performance.
- A single QuickBooks batch request is submitted.
- Ordway processes the response for each record individually.
- Integration logs are updated with the processing result.
If Batch Processing is disabled, each integration event is processed immediately using the standard synchronization workflow.
Supported Objects and Operations
Batch Processing currently supports the following QuickBooks objects.
| Object | Supported Operations |
| Customer | Create, Update |
| Contact | Create, Update |
| Product | Create, Update |
| Invoice | Create, Update |
| Journal Entry | Create, Update |
Objects or operations that are not supported continue to use the standard synchronization process.
Monitor Batch Processing Jobs
Administrators can monitor batch processing jobs from the Jobs page.
Navigate to: Administration > Jobs
The Jobs page displays pending and completed batch jobs.
The following information is available:
| Field | Description |
| Created Date | Date and time the batch job was created. |
| Type | Type of background job. |
| Result | Processing result. |
| Start Time | Date and time processing started. |
| Duration | Total processing time. |
Use this page to verify that batch jobs have completed successfully and identify processing failures.
Best Practices
For optimal performance:
- Enable Batch Processing for high-volume QuickBooks integrations.
- Monitor completed jobs regularly.
- Review failed jobs to identify synchronization issues.
Limitations
- Batch Processing is available only when Enable Bulk API Calls are enabled for the QuickBooks integration.
- Batch processing supports only the QuickBooks objects and operations documented in this guide.
- Batch size and processing intervals are managed internally by Ordway and cannot be configured by administrators.
- Each QuickBooks Batch API request can process up to 10 records, in accordance with QuickBooks Online Batch API limitations.
Troubleshooting
| Issue | Possible Cause | Resolution |
| Jobs remain pending | Pending events are waiting to be processed | Allow the batch processing job to complete. If the issue persists, verify that Batch Processing is enabled and review the integration logs. |
| Records synchronize individually | Batch Processing is disabled | Enable Enable Bulk API Calls in the Default QuickBooks Settings page. |
| Synchronization takes longer than expected | High transaction volume or pending batch processing | Monitor the Jobs page and review integration logs for failures |
| Failed batch job | QuickBooks rejected one or more requests | Review the integration logs and retry the failed records if necessary. |
Frequently Asked Questions
| Questions | Answers |
| Does Batch Processing change synchronization results? | No. Batch Processing changes only how integration events are grouped and submitted. Synchronization results remain the same. |
| What happens when Batch Processing is disabled? | Ordway immediately processes each integration event using the standard synchronization workflow. |
| Are all QuickBooks objects processed in batches? | No. Only supported objects participate in Batch Processing. |
| Can failed records be identified? | Yes. Although records are processed in batches, Ordway tracks the processing result for each individual record. |
| Does Batch Processing reduce API requests? | Yes. Multiple integration events are grouped into a single QuickBooks batch request, reducing the total number of API calls. |
| Can I configure the batch size or processing interval? |
No. Administrators can enable or disable Enable Bulk API Calls from the Default QuickBooks Settings page. Batch sizing and processing intervals are managed internally by Ordway to optimize synchronization performance. |
Comments
0 comments
Please sign in to leave a comment.