This is pre-release documentation for an API in public beta and is subject to change.
Square provides comprehensive systems for tasks such as taking and managing payments, hosting a product catalog, and managing customers. For businesses that already manage inventory, invoices, or customer information in an enterprise resource planning (ERP) system, Square offers direct integrations with a number of popular ERP systems.
Square Bridge is an integration application hosted by Square. It allows you to use your Square account or Square Point of Sale (POS) system to take payments and manage customers, inventory, orders, and bank transfers while syncing the relevant data with your existing ERP system. At this time, Square Bridge provides data synchronization with Oracle NetSuite, Microsoft Dynamics 365 Business Central, and SAP Business One.
Additionally, Square offers payments extension applications. This allows you to leverage the Square ecosystem to accept payments directly from invoices within your ERP system. At this time, Square offers a payments extension for Microsoft Dynamics 365 Business Central.
To use Square Bridge or a payments extension with your external system, you must complete an onboarding process with a Square account manager. Onboarding an integration involves:
Setting up sandbox testing environments in Square Bridge and your external system.
Testing the integration in the sandbox environments.
Setting up production environments in Square Bridge and your external system.
Testing the data or payments synchronization (or both) in production.
Launching the integration.
Monitoring the integration for errors using Square Bridge (ongoing).
Square Bridge is the integration platform that syncs (copies) data between your Square account and an external system, such as your ERP system. To sync and use this data successfully, you must provide the integration with the following:
Access to each software system (Square account and ERP system).
Information about data mapping: how records and fields in your ERP system map to objects and their properties in Square.
Synchronization timing (when account data should be transferred between Square and your ERP system).
While setting up Square Bridge, you should expect an additional 2 to 4 weeks of configuration testing and approvals. During testing, you work with the Square Bridge team to verify that all items and data are synchronizing correctly.
Each ERP integration offers slightly different data synchronization options. The features common to each integration are as follows:
Syncs customers bidirectionally between Square and the ERP system.
Customers are created and updated when syncing between systems, with the most recent change taking precedence in conflict scenarios.
For more information about the Square Customer Directory, see Manage Your Customer Directory Online.
Brings catalog categories, items, and taxes from the ERP system into Square.
An item has a one-to-one relationship with a Square item and item variation set.
Brings inventory counts from the ERP system into Square.
Sends inventory adjustments from Square into the ERP system, ensuring that your ERP system remains the source of truth for inventory levels.
Square does not support batch and serial managed items.
Syncs orders and transactions from Square into the ERP system.
Transactions have a one-to-one relationship with Square transactions and orders.
Non-completed orders (such as order-ahead orders or shipment orders) are not considered closed and are not synchronized with Square.
Optionally, creates daily category sales reports as invoices.
Square orders can be aggregated into a daily invoice and further aggregated by category.
Square integrations are under active development, with new features and capabilities continually added. Your Square account manager will provide you with relevant updates for your integration.
Adding a Square payments extension allows you to accept payments directly from invoices or customer records within your ERP system.
Add a card on file to a customer record and easily charge that card for new orders.
Accept in-person payments from a Square Terminal device.
Accept payments and prepayments on posted or unposted sales invoices.
At this time, the Square Payments Extension is available for Microsoft Dynamics 365 Business Central.
To determine whether Square Bridge or an ERP payments extension is right for your business, see Get Started with Square Bridge.
If you need more assistance, contact Developer Support or ask for help in the Developer Forums.