Supported entity types for sync
| Entity type | Description |
|---|---|
vendors | Sync Cleo Pay connections as QBO vendors. |
bankAccounts | Map Cleo Pay bank accounts to QBO bank accounts. |
invoices | Sync Cleo Pay payables as QBO bills or invoices. |
List accounting integrations
GET /api/businesses/{businessId}/integrations/accounting
Returns all accounting integrations connected to the business.
Path parameters
The ID of the business.
Connect to QuickBooks Online
POST /api/businesses/{businessId}/integrations/accounting/connect
Initiates the OAuth 2.0 flow to connect a QuickBooks Online account. Returns an authorization URL that you redirect the user to.
Path parameters
The ID of the business.
Request body
The URI Intuit should redirect to after the user authorizes access.
authorizationUrl. Redirect the user to this URL to complete the OAuth flow.
Get integration status
GET /api/businesses/{businessId}/integrations/accounting/status
Returns the current connection status of the accounting integration.
Path parameters
The ID of the business.
Disconnect QuickBooks Online
DELETE /api/businesses/{businessId}/integrations/accounting/disconnect
Disconnects the QuickBooks Online integration. Existing synced data is not deleted from QBO, but future sync operations stop.
Path parameters
The ID of the business.
Get sync status
GET /api/businesses/{businessId}/integrations/accounting/{accountingIntegrationId}/sync/status
Returns the status of the most recent sync operation.
Path parameters
The ID of the business.
The ID of the accounting integration.
Trigger a full sync
POST /api/businesses/{businessId}/integrations/accounting/{accountingIntegrationId}/sync
Triggers a full sync of all supported entity types between Cleo Pay and QuickBooks Online.
Path parameters
The ID of the business.
The ID of the accounting integration.
Sync a specific entity type
POST /api/businesses/{businessId}/integrations/accounting/{accountingIntegrationId}/sync/{entityType}
Triggers a sync for a single entity type.
Path parameters
The ID of the business.
The ID of the accounting integration.
The entity type to sync. Accepted values:
vendors, bankAccounts, invoices.Get mapped invoice fields
GET /api/businesses/{businessId}/integrations/accounting/{accountingIntegrationId}/invoice-fields
Returns the field mappings configured between Cleo Pay payable fields and QuickBooks Online bill fields.
Path parameters
The ID of the business.
The ID of the accounting integration.
Map a connection to a vendor
POST /api/businesses/{businessId}/integrations/accounting/{accountingIntegrationId}/vendors/mappings
Creates a mapping between a Cleo Pay connection and a QuickBooks Online vendor.
Path parameters
The ID of the business.
The ID of the accounting integration.
Request body
The Cleo Pay connection ID to map.
The QuickBooks Online vendor ID to map to.
Map a bank account
POST /api/businesses/{businessId}/integrations/accounting/{accountingIntegrationId}/bank-accounts/mappings
Creates a mapping between a Cleo Pay bank account (funding source) and a QuickBooks Online bank account.
Path parameters
The ID of the business.
The ID of the accounting integration.
Request body
The Cleo Pay funding source (bank account) ID.
The QuickBooks Online bank account ID.