Collection

Replacements

Deprecation

Retirement

|\n|:-------|:--------|:----------|:---------|\n|Square API Transactions|[Payments API](${SQUARE_TECH_REF}/payments-api)
[Migration guide](/payments-api/migrate-from-transactions-api)|2019-08-15|TBD|\n|Connect v1 Transactions.Payments|[Payments Migration Guide](migrate-from-v1/guides/v1-payments)|2021-05-13|2023-06-20|\n|Connect v1 Transactions.Refunds|[Refunds Migration Guide](migrate-from-v1/guides/v1-refunds)|2021-05-13|2023-06-20|\n|Connect v1 Transactions.Settlements|[Payouts API](/payouts-api/overview)
[Migration guide](/migrate-from-v1/guides/v1-settlements)|2022-04-20|2023-06-20|\n\n### Retired\nThe following Connect v1 and Square endpoints have been retired and are no longer supported by documentation. If you have not migrated your code to use Square API endpoints, refer to the migration guides in the table to learn about the needed migrations.\n|

Collection

Replacements

Deprecation

Retirement

|\n|:----|:---------|:-------|:------|\n|Square API Employees|[Team API](${SQUARE_TECH_REF}/team-api)
[Migration guide](/team/migrate-from-v2-employees)|2020-08-26 |2021-09-15|\n|Connect v1 Employees.Employees|[Team API](${SQUARE_TECH_REF}/team-api)|2020-08-26 |2021-09-15 |\n|Connect v1 Employees.EmployeeRoles|[Team API](${SQUARE_TECH_REF}/team-api)|2020-08-26 |2021-09-15 |\n|Connect v1 Employees.Timecards|[Labor API](${SQUARE_TECH_REF}/labor-api)|2020-02-26 |2021-02-26 |\n|Connect v1 Employees.CashDrawers|[Cash Drawers API](${SQUARE_TECH_REF}/cash-drawers-api)|2020-02-26|2021-02-26 |\n|Connect v1 Items|[Catalog API](${SQUARE_TECH_REF}/catalog-api)
[Inventory API](${SQUARE_TECH_REF}/inventory-api)|2019-11-20|2021-02-26|\n|Connect v1 Locations|[Locations API](${SQUARE_TECH_REF}/locations-api)|2019-11-20 |2020-11-18 | \n|Connect v1 Transactions.BankAccounts|[Bank Accounts API](${SQUARE_TECH_REF}/bank-accounts-api)|2020-02-26 |2021-02-26|\n|Square API Reporting|[Payments API](${SQUARE_TECH_REF}/payments-api)
[Migration guide](/payments-api/migrate-from-transactions-api)|2019-08-15 |2020-08-26|\n\n### Work in progress\nThe following Connect v1 endpoints will be deprecated when corresponding functionality is available in the Square API.\n\n|

Collection

Replacements

Deprecation

Retirement

|\n|:-----|:------|:----|:-|\n|Connect v1 Batching|Various
[Migration guide](/migrate-from-v1/general-guidance#batching)|2019-11-20 |TBD | \n"}},{"id":"LOYALTY_SANDBOX_PHONE","type":"constant","attributes":{"value":"You test the sample walkthrough in the Square Sandbox environment. After creating a loyalty program, you need a phone number to set up a loyalty account. In the Sandbox, you provide a Sandbox phone number, instead of a real phone number, using the following format:\n\n```\n+1555\n```\n\nFor example, +14255551111.\n"}},{"id":"MASTERPASS_LONG","type":"constant","attributes":{"value":"Masterpass (now Mastercard Click to Pay)"}},{"id":"MASTERPASS","type":"constant","attributes":{"value":"Secure Remote Commerce"}},{"id":"MASTERPASS_SRC","type":"constant","attributes":{"value":"!!!info\nThe names of `SqPaymentForm` ${MASTERPASS} (SRC) objects have not changed from the original Masterpass to minimize the amount of recoding that you must do to support SRC.\n!!!"}},{"id":"TERMINAL_CHECKOUT","type":"constant","attributes":{"value":"Terminal API"}},{"id":"TERMINAL_REFUND","type":"constant","attributes":{"value":"Terminal API"}},{"id":"SQUARE_ONLINE_EAP","type":"constant","attributes":{"value":"!!!\nSquare Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs.](/online-api#early-access-program-for-square-online-apis)\n!!!"}},{"id":"LOYALTY_WALKTHROUGH_SETUP_NOTE_AVAILABILITY","type":"constant","attributes":{"value":"Use the following steps to set up a loyalty program in the ${SANDBOX_DASHBOARD_NAME}:\n\n1. Open the ${SQUARE_DASHBOARD_NAME} in the Sandbox. \n a. Sign in to the [${DEVELOPER_DASHBOARD_NAME}](${APP_DASHBOARD}). \n b. In the **Sandbox Test Accounts** section, choose **Open** for **Default Test Account**. This opens the ${SANDBOX_DASHBOARD_NAME} where you create your loyalty program.\n2. In the left pane, choose **Customers**, and then choose **Loyalty**.\n3. On the **Build repeat business and reward your customers** page, choose **Get Started**. \n\n ![A screenshot of the Loyalty subscription page where you can start setting up a loyalty program.](https://images.ctfassets.net/1nw4q0oohfju/2Vt0rEjUbZMBmpaBHy2aqI/8c4bc276a13cdc31e7ed771737591bbb/loyalty-get-started.png)\n\n You now follow a series of steps to set up your loyalty program. \n\n !!!info\n These steps assume that you are setting up a loyalty program for the first time. To change an existing program, choose **Settings** on the **Loyalty** page, and then edit the **Earning Points** and **Redeeming Rewards** settings to match the settings described in this topic.\n\n The **Loyalty** page is available only if your Square account is activated in a [supported country,](loyalty-api/overview#loyalty-market-availability) or if you open the ${SANDBOX_DASHBOARD_NAME} with a [test account](testing/create-and-authorize-sandbox-account) configured for a supported country. Custom test accounts use an OAuth access token instead of the Sandbox access token, so you must grant the account the [required permissions](oauth-api/square-permissions) for the Square APIs used in this walkthrough. \n !!!"}},{"id":"CUSTOMER_ASSIGNMENTS_FOR_ORDERS_AND_PAYMENTS","type":"constant","attributes":{"value":"You should be aware of the following considerations regarding customer assignments:\n\n* In the ${SQUARE_DASHBOARD_NAME}, a transaction activity is based on the `customer_id` of the order and other related settings, but the `customer_id` of the payment is ignored. For example, if the order does not have a customer assignment, the transaction's **Paid by** field might not display the customer who is assigned to the payment. To reliably link transactions to customers in the ${SQUARE_DASHBOARD_NAME}, make sure to specify the `customer_id` field in your `CreateOrder` request.\n\n In addition, omitting the `customer_id` field on the `Order` object might result in the creation of new [instant profiles](customers-api/what-it-does#instant-profiles) that are linked to the payment.\n\n* If a customer ID is added to a payment in the ${SQUARE_DASHBOARD_NAME}, the ID is not available in the corresponding `Payment` or `Order` object retrieved using Square APIs.\n\n* Orders made from a Square Online store might not include a `customer_id` when retrieved from the Orders API, so you should not rely on this field for your integration.\n\n* Sellers can merge duplicate customer profiles that represent the same customer. The merge operation deletes the existing customer profiles and creates a new aggregated customer profile with a new ID. Currently, searching for orders using the new customer ID does not return any orders that were made using a previous customer ID. \n\n As a workaround, you should store all previous customer IDs and provide them in the `customer_ids` query filter in your `SearchOrders` request. To obtain these IDs, subscribe to `customer.created` webhook events and check whether the notifications contain the `event_context.merge` field. This field is included when the customer profile is created from a merge operation and contains the IDs of all affected customer profiles. For more information, see [Notifications for customer profile merge events.](customers-api/use-the-api/customer-webhooks#notifications-for-customer-profile-merge-events)"}},{"id":"GIFT_CARD_ACTIVATE_OR_LOAD_ORDER_REQ","type":"constant","attributes":{"value":"When your application uses the Orders API to process a gift card order, the order must be in the `COMPLETED` state before you activate or load the gift card. In addition, the line item for the gift card must specify `GIFT_CARD` as the `item_type`. Otherwise, the order is not processed as a gift card sale and the gift card cannot be activated or loaded using Orders API integration.\n\nIf the gift card order is refunded after the funds are added to the gift card, you must call `CreateGiftCardActivity` to deduct the funds from the gift card balance. You can create an `ADJUST_DECREMENT` activity with the `PURCHASE_WAS_REFUNDED` reason to deduct a specified amount. Using the Refunds API to refund a gift card order does not automatically update the gift card balance (unlike using the Refunds API to refund a gift card payment, which does update the gift card balance)."}},{"id":"WALKTHROUGH_GATHER_ACCOUNT_INFO","type":"constant","attributes":{"value":"Follow these steps to get the access token and location ID used in this walkthrough.\n\n1. Sign in to the [${DEVELOPER_DASHBOARD_NAME}](${APP_DASHBOARD}) and open your application. If you do not have a Square account, see [Get Started](get-started) to learn how to create an account and an application. \n2. Get your Sandbox access token: \n 1. At the top of the page, in the **Sandbox** and **Production** toggle, choose **Sandbox**. \n 2. On the **Credentials** page, under **Sandbox Access Token**, choose **Show** and then copy the token. All Square API requests require an access token for authorization. This [personal access token](build-basics/access-tokens) grants full access to the Sandbox resources in your account. \n\n ${SECURE_SANDBOX_ACCESS_TOKEN}\n\n3. Get your location ID: \n 1. In the left pane, choose **Locations**. \n 2. On the **Locations** page, keep **Default Test Account** selected and copy a location ID.\n\n![An animation showing how to get the Sandbox access token and location ID in the Developer Dashboard.](//images.ctfassets.net/1nw4q0oohfju/1qM4MIFJxxbESkevva9dXN/7ccff399610661d0a2f1fd92d6b1c66a/get-sandbox-access-token-and-location-id.gif)\n\n!!!info\nTo retrieve location IDs programmatically, call [ListLocations.](${SQUARE_TECH_REF}/locations-api/list-locations)\n!!!"}},{"id":"GIFT_CARD_PHYSICAL_CARD_IN_SANDBOX","type":"constant","attributes":{"value":"!!!info\nThis walkthrough creates a digital gift card in the Sandbox. Although testing physical gift cards is not supported in the Sandbox, you can [register and activate physical gift cards](gift-cards/using-gift-cards-api#selling-square-gift-cards) in the production environment using the process described in this walkthrough.\n!!!"}},{"id":"SECURE_SANDBOX_ACCESS_TOKEN","type":"constant","attributes":{"value":"!!!important\nThe Sandbox access token is a secure secret. Do not share it with anyone.\n!!!"}},{"id":"MAX_LOAD_AMOUNT","type":"constant","attributes":{"value":"Maximum load amount per gift card per day!!The maximum amount that can be loaded onto a gift card in a 24-hour period.!!"}},{"id":"MAX_BALANCE_AMOUNT","type":"constant","attributes":{"value":"Maximum balance amount per gift card!!The maximum amount for a gift card balance.!!"}},{"id":"MAX_PAYMENT_CARD_AMOUNT","type":"constant","attributes":{"value":"Maximum load amount per payment card per day!!The maximum amount that a single payment card can load onto gift cards in a 24-hour period.!!"}},{"id":"MAX_SELLER_BALANCE_AMOUNT","type":"constant","attributes":{"value":"Maximum outstanding balance amount per seller!!The maximum amount of total outstanding balance across all gift cards issued for a single seller.!!"}},{"id":"LOYALTY_API_VIDEO","type":"constant","attributes":{"value":"!!!tip\nCheck out the [Sandbox 101: Loyalty API](https://www.youtube.com/watch?v=LFwO9DiwxEs) video, which shows how to set up a loyalty program in the Sandbox, create a loyalty account, and then add and redeem loyalty points using steps that are similar to this walkthrough.\n!!!"}},{"id":"SQUARE_BRIDGE_SAPB1","type":"constant","attributes":{"value":"[//]: # (2dzls6rlhuUSZOyp6X5hUZ)\nSquare Bridge provides the following capabilities for the SAP Business One (SAP B1) integration.\n\n### Items and inventory\nThe items and inventory synchronization function in Square Bridge does the following: \n\n* Brings items from the ERP system into Square. \n * An item has a one-to-one relationship with a Square item and item variation set. Only one barcode is supported per SAP item. \n * Items can be configured with a measurement unit. \n * Square does not support batch and serial managed items.\n* Brings inventory counts into Square.\n * Inventory counts do not account for failed orders in SAP.\n\n### Orders\nThe orders synchronization function in Square Bridge does the following: \n\n* Syncs orders and transactions from Square into the ERP system.\n * Transactions have a one-to-one relationship with Square transactions and orders. \n * Non-completed orders (such as order-ahead orders or shipment orders) are not considered closed and are not synchronized with Square.\n * SAP-specific behaviors include:\n * Net positive Square transactions/orders create SAP invoices and incoming payments. \n * Net negative Square transactions/orders create SAP invoices and incoming payments. \n * Transactions that include an exchange apply negative line items to invoices and credit memos.\n * Gift card sales require a gift card item code.\n * Discounts are not itemized.\n* Optionally, creates daily category sales reports as invoices.\n\n### Customers\n\nThe customers synchronization function in Square Bridge does the following:\n\n* Syncs customers bidirectionally between Square and the ERP system. \n * Customers are created and updated when syncing between systems, with the most recent change taking precedence in conflict scenarios. \n * For more information about the Square Customer Directory, see [Manage Your Customer Directory Online.](https://squareup.com/help/us/en/article/5498-manage-your-customer-directory-online)"}},{"id":"SQUARE_BRIDGE_NETSUITE","type":"constant","attributes":{"value":"[//]: # (5fYjL8YQLLKPjgve3yQZzL)\n### Bank transfers\n\nThe bank transfers synchronization function in Square Bridge does the following:\n\n* Syncs bank transfers between your Square balance and your Square account's linked bank account as NetSuite Journal Entry records.\n * Square settlement types (such as transaction fees and chargebacks) are mapped to NetSuite accounts using G/L codes configured in the Square Bridge **Location Settings**.\n\n### Customers\n\nThe customers synchronization function in Square Bridge does the following:\n\n* Syncs customers bidirectionally between Square and NetSuite. \n * Customers are created and updated when syncing between systems, with the most recent change taking precedence in conflict scenarios.\n\n### Catalog\n\nThe catalog synchronization function in Square Bridge does the following:\n\n* Syncs item, class, and tax records from NetSuite to Square as catalog items, variations, categories, and sales taxes.\n* The synced items and inventory are based on whether they belong to configured NetSuite price levels with a price greater than or equal to $0.00 and are active.\n\n### Inventory changes\n\nThe inventory changes synchronization function in Square Bridge does the following:\n\n* Syncs adjustments to inventory (such as restocks and waste) from Square to NetSuite.\n* Syncs transfers of inventory items between two Square locations from Square to NetSuite.\n\n!!!info\nPhysical counts (that is, cycle counts) are not currently supported by Square Bridge. Any physical counts performed in Square do not transfer to NetSuite.\n!!!\n\n### Inventory levels\n\nThe inventory levels synchronization function in Square Bridge does the following:\n\n* Syncs inventory levels (that is, NetSuite's calculated on-hand quantity) from NetSuite, thereby overriding Square item inventory levels for each item synced from NetSuite.\n\n### Orders\n\nThe orders synchronization function in Square Bridge does the following:\n\n* Syncs Square sales, exchanges, and returned orders into NetSuite. \n * This sync represents these Square transactions with four records in NetSuite: invoices, customer payments, credit memos, and customer refunds.\n * Transactions have a one-to-one relationship with Square transactions and orders.\n * Square orders can be aggregated into a daily invoice and further aggregated by category."}},{"id":"SQUARE_BRIDGE_BUSINESS_CENTRAL","type":"constant","attributes":{"value":"[//]: # (2HOsuqkfOramXrzfoyH32z)\nSquare Bridge provides the following capabilities for the Business Central integration.\n\n### Items and inventory\nThe items and inventory synchronization function in Square Bridge does the following: \n\n* Brings catalog categories, items, and taxes from the ERP system into Square. \n * An item has a one-to-one relationship with a Square item and item variation set. \n * Items can be configured with a measurement unit. \n* Brings inventory counts from the ERP system into Square.\n* Sends inventory adjustments from Square into the ERP system.\n\n### Orders\nThe orders synchronization function in Square Bridge does the following: \n\n* Syncs orders and transactions from Square into the ERP system. \n * Transactions have a one-to-one relationship with Square transactions and orders. \n * Non-completed orders (such as order-ahead orders or shipment orders) are not considered closed and are not synchronized with Square.\n* Optionally, creates daily category sales reports as invoices.\n\n### Customers\nThe customers synchronization function in Square Bridge does the following: \n\n* Syncs customers bidirectionally between Square and the ERP system. \n * Customers are created and updated when syncing between systems, with the most recent change taking precedence in conflict scenarios. \n\n ![This and that](//images.ctfassets.net/1nw4q0oohfju/5OJG5LkMbiU9DPN6FtfpTK/99a84d3d5fce681b1f9e0e661a1ab7d9/businesscentral.dynamics.com_a0ee4a58-b2dd-4849-b551-9bbb088665f1_sandbox_page_22_company_CRONUS-20USA-2C-20Inc._dc_0_bookma.png)"}},{"id":"SQUARE_BRIDGE_GETSTARTED_AGNOSTIC_TOP","type":"constant","attributes":{"value":"[//]: # (61Kco0qgrVlCktKXLcsF5z)\nWhen you use Square Bridge to create an integration between your Square account and your external system, you need to perform an onboarding process with the Square Bridge team and your Square account manager. \n\nOnboarding to Square Bridge involves:\n* Creating an integration between Square and your external system.\n* Testing and accepting the integration results.\n\nA Square integration syncs data between your Square account and a separate software system. Synchronizing data is the process of copying data between systems so that the same information is present and in agreement across the two software systems. In this case, Square Bridge is the integration platform and Square and your external system are the external software systems. To successfully sync data, you need to provide the integration with the following:\n\n* Access to each software system\n* Data mapping for the synchronization\n* Synchronization timing\n\nWhen you complete the Square Bridge setup, you should expect an additional 2–4 weeks of configuration testing and approvals. During testing, you work with the Square Bridge team to verify that items and data are synchronizing correctly.\n\nTo see some of the Square Bridge features, watch the [10-minute demonstration video of Square Bridge](https://youtu.be/37bPHFHdKzg).\n\n## Integration steps\n1. Set up a sandbox environment with these accounts:\n * Square account\n * External system account\n * Square Bridge account\n2. Conduct acceptance testing.\n3. Set up a production environment with these accounts:\n * Square account\n * External system account\n * Square Bridge account\n4. Conduct sync validation testing.\n5. Go live.\n6. Monitor for errors using Square Bridge (ongoing).\n"}},{"id":"SQUARE_BRIDGE_GETSTARTED_AGNOSTIC_PREREQ","type":"constant","attributes":{"value":"[//]: # (7zqhjj0jOSWIYL9yteXlSR)\nBefore you start the Square Bridge sign up and configuration process, complete the ${SQUARE_SANDBOX} following steps:\n\n1. You must have two Square accounts, one for production, one for testing. \n\n !!!tip\n If you want to provide access to your Square account to other members of your organization, either use a set of credentials you’re comfortable sharing, or leverage [Square’s Full Access Team Member or Authorized Representative](https://squareup.com/help/us/en/article/6316-add-an-administrator-or-authorized-representative).\n !!!\n\n1. You should ensure you have two external system (e.g. ERP) accounts, one for production, one for testing. When the Square Bridge team requests it, provide access to the external system's testing account.\n1. You should ensure that a Google or Microsoft account is available.\n\n### Signup and configuration\n\n1. Go to [https://v2.squarebridge.com/signup](https://v2.squarebridge.com/signup). Please note, Square currently uses only Google and Microsoft as single-sign-on providers for Bridge Account creation/log-in.\n2. Sign up with a Google Account or with a Microsoft Account. **Note:** If you wish to use a Google account and do not have one, follow the steps in [this support article](https://support.google.com/accounts/answer/27441?hl=en) under “Use an Existing Email Address”.\n3. In Square Bridge, choose the “Create Integration” button and run the onboarding wizard to link a Square Account with your external system account. The wizard walks you through configuration and set-up. There are several external system-specific topics that have additional set up steps for user-defined/custom fields, stored procedures, and other configurations that you must complete. \n\n !!!important\n Do not create an integration between your live Square account and external system account until you have validated Square Bridge with test accounts/environments. \n !!!\n\n 1. Create a test integration using an alternative Square account (using a different email address from your live Square account) with a non-production version of your external system account/database.\n 1. Verify the integration works as desired. \n 1. Once you are satisfied validating your test integration, create a new integration using your live accounts/databases.\n\n4. Once you have created your Integration, perform any location-specific setup in the Location Settings page.\n\n### Navigation\n\nOnce you have created an integration and set up your Square locations, choose any of the following actions:\n\n* Choose **Sync data** to run sync jobs and monitor your data by (also accessible by choosing an **Overview** card)\n* Choose **Settings** to change your configuration settings. \n* Choose **Audit Log** to monitor the status of synchronization jobs. \n\n### Support \n\nShould you encounter issues with Square Bridge, please email [squarebridge@squareup.com](mailto:squarebridge@squareup.com). For other issues regarding Square (unrelated to Square Bridge), please contact support [here](https://squareup.com/help/us/en/)."}},{"id":"LIST_GIFT_CARD_ACTIVITIES","type":"constant","attributes":{"value":"To see the activity history for a gift card, call [ListGiftCardActivities](${SQUARE_TECH_REF}/gift-card-activities-api/list-gift-card-activities) using the `gift_card_id` query parameter. If needed, you can call [RetrieveGiftCardFromGAN](${SQUARE_TECH_REF}/gift-cards-api/retrieve-gift-card-from-gan), [RetrieveGiftCardFromNonce](${SQUARE_TECH_REF}/gift-cards-api/retrieve-gift-card-from-nonce), or [ListGiftCards](${SQUARE_TECH_REF}/gift-cards-api/list-gift-cards) to get the gift card ID.\n\nThe following example request lists all activities for the specified gift card. By default, the response returns a maximum [page size](build-basics/common-api-patterns/pagination) of 50 activities.\n\n```endpoint:GiftCardActivites-ListGiftCardActivities\n{\n \"authentication\": {\n \"accessToken\": \"{ACCESS_TOKEN}\"\n },\n \"queryParameters\" : {\n \"gift_card_id\": \"{{GIFT_CARD_ID}}\"\n },\n \"environment\": \"sandbox\"\n}\n```\n\nYou can optionally use other query parameters to sort the activities and filter by activity type, location, and reporting period.\n\n!!!info\nIf you encounter issues when running the cURL command from a terminal window, try wrapping the endpoint URL in quotation marks and resending the request.\n!!!"}},{"id":"SQUARE_BRIDGE_AGNOSTIC_GET_STARTED","type":"constant","attributes":{"value":"[//]: # (3dmu8is0s3FhdKoBBQdoV9)\nNot every seller can use Square Bridge. In some cases, the seller's external system is not yet supported by Square Bridge. Other sellers are hesitant to set up a sandbox environment in their external system, a necessity for Square Bridge. There may be other disqualifying factors which are discovered in your discussion with your Account Executive.\n\nYou will need to schedule a demo with your Account Executive. During the demo, you can see the features of Square Bridge, and get an opportunity to talk with Bridge onboarding experts. They will help determine what Square Bridge can do for you.\n\n!!!info\nYou will have someone assigned from Square who is your \"Account Executive\" or your \"Account Manager\". For these instructions, these roles are the same, so we use the title \"Account Executive\" to refer to the Square employee.\n!!!\n\n### Onboarding with Square Bridge\nThe Square Bridge Onboarding process takes place in three phases. When Onboarding is complete, \nyou have created a fully functioning **Sandbox** integration for testing and evaluation.\n\n1. The DSR (Deal Support Request) Process\n2. Account Creation and Management\n3. Sandbox Integration\n\n### The DSR (Deal Support Request) process\nThe DSR (Deal Support Request) is a collection of correspondence that describes the state of your Deal with your Account Executive. It is continually updated through the Requirements and Scoping phases.\n\n1. **Initiate a deal support request (DSR):** Contact your Square Sales Account Executive, and \n ask them to file a “Deal Support Request” (DSR) for Square Bridge.\n2. **Requirements Gathering and Scoping:** Your Account Executive will reach out to schedule a \n Requirements Gathering. This is a technical call, which will involve experts from your team and Square Bridge team evaluating your specific needs. Together the teams will determine what Square Bridge can do for you.\n\n This will be followed by additional Scoping calls as needed between your team and the Square Bridge team, to further refine the integration needs and assess how Bridge can help you.\n\n3. **Start the integration:** Integration begins after a successful scoping call. Your Account \n Executive and the Square Bridge team will provide you with your start date.\n\n### Account creation and management\nTo complete the entire Onboarding process, you will need up to five sets of credentials **(usernames and passwords)** for the accounts used with Square Bridge. You will need to provide:\n\n- Two [Square Accounts](https://squareup.com/login). One for sandbox testing, and one for production.\n- Two external system Environments. One for sandbox, and the other for production. Some external systems require an account for each environment.\n- One Google or Microsoft Account for signing into the [Square Bridge](https://v2.squarebridge.com/login) integration application.\n\nYou must verify and collect all of these accounts before starting the integration.\n\n### Confirm that you have access to two Square accounts\nEnsure you have credentials to access two Square accounts, one for production usage (**Production**), one for testing purposes (**Sandbox**).\n\nTo confirm access and verify that you have sufficient credentials in your Square accounts, do the following in each account:\n\n1. Sign in to the [Square Account](https://www.notion.so/Any-ERP-Get-Started-8e3a5e03d2804707b0c3fb7dc5b8249a).\n2. In the Square Dashboard, open the Team app.\n3. Select yourself in the list of team members.\n4. In the information panel that opens on the right side of the page, review your assigned permissions. If the permission set shows **Owner** or permissions show **Full access,** then you have sufficient credentials. Otherwise, review the following list of permissions that Square Bridge will ask your authorization for:\n\n![Square Bridge: Authorize Square Bridge to access a Square account](https://images.ctfassets.net/1nw4q0oohfju/568neo92jm2TRVXBXHnpda/d6a19cbb5de06d1809911c8aa99c5d9d/squareup.com_oauth2_authorize.png)\n"}},{"id":"SQUARE_BRIDGE_SETTLEMENT_RULES","type":"constant","attributes":{"value":"[//]: # (5TjyWXcKZ6fmMBFTNXLc6m)\n* **Adjustment.** A manual adjustment applied to your account by Square. This type is rarely encountered.\n * Credited if it is a positive adjustment.\n * Debited if it is a negative adjustment.\n\n* **Balance.** The outstanding balance in your Square account.\n * Credited if BALANCE to account.\n * Debited if BALANCE from account.\n\n* **Bank.** The financial institution where Square transfers the Square account funds to for a given Square Location.\n * This journal entry line is created based on the settlement total.\n * Credited if the settlement total is less than zero.\n * Debited if the settlement total is greater than zero.\n\n* **Chargeback.** Charges returned to payment cards after a buyer wins a dispute.\n * Credited if the amount is greater than zero.\n * Debited if the amount is less than zero.\n\n* **Hold adjustment.** An adjustment made by Square related to holding/releasing a payment, usually when fraud is suspected.\n * Credited if the amount is greater than zero.\n * Debited if the amount is less than zero.\n\n* **Transaction fee.** The Square fee associated with card transactions.\n * Credited if the amount is greater than zero.\n * Debited if the amount is less than zero.\n"}},{"id":"SQUARE_BRIDGE_NETSUITE_SYNCMAP_INVENTORY_CHANGE","type":"constant","attributes":{"value":"[//]: # (4p8yJ0QJcFkqvN7KJVyZm7)\n* The sync direction is unidirectional between Square to NetSuite. The sync pushes positive and negative adjustments (such as restocks and waste) between Square and NetSuite.\n* The sync is location-specific.\n\nIn Square, inventory adjustments are made in the **Items** application in the ${SQUARE_DASHBOARD_NAME} under **Edit variation**, on the **Manage stock** tab. In NetSuite, choose **Lists**, **Accounting**, and **Items**.\n\nThe following table describes the mapping between Square inventory adjustment objects and properties and between NetSuite objects and properties:\n\n|

Square

NetSuite

|\n|:-----|:------|\n|[InventoryAdjustment](${SQUARE_TECH_REF}/objects/InventoryAdjustment)|[InventoryAdjustment](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2021_2/script/record/inventoryadjustment.html)|\n|The internal ID of the NetSuite item mapped to the Square catalog item within Square Bridge associated with the inventory adjustment.|`inventoryList.inventory[].item.internalID`|\n|`quantity` |`inventoryList.inventory[].adjustQtyBy`|\n|The internal ID of the NetSuite unit mapped to the Square unit within Bridge associated with the catalog item in the inventory adjustment. |`inventoryList.inventory[].units.internalID` |\n|Per Square location, the NetSuite location internal ID in Square Bridge associated with the inventory adjustment. |`inventoryList.inventory[].location.internalID` |\n|Square Bridge **Location Settings**, subsidiary ID |`subsidiary.internalID` |\n|`occurred_at` |`tranDate` |\n|The Square location ID associated with the inventory adjustment.|`adjLocation.internalID` |"}},{"id":"VIEW_GIFT_CARD_ACTIVITIES_SELLER_DASHBOARD","type":"constant","attributes":{"value":"**Viewing gift card activities in the ${SQUARE_DASHBOARD_NAME}**\n\nSquare sellers can view gift card activities in the ${SQUARE_DASHBOARD_NAME}. Because you are testing this walkthrough in the Sandbox, you can review gift card activities in the ${SANDBOX_DASHBOARD_NAME}.\n\n1. Open the [${DEVELOPER_DASHBOARD_NAME}](${APP_DASHBOARD}).\n2. In the **Sandbox Test Accounts** section, choose **Open** next to **Default Test Account**. This opens the ${SANDBOX_DASHBOARD_NAME} associated with the default test account.\n3. In the left pane, choose **Gift Cards**.\n4. On the **Overview** page, select the gift card from the list. A pane opens to display the gift card details and list of activities. \n\n You can search for a particular gift card by entering the full GAN in the **Search by Gift Card Number** box."}},{"id":"GC_WALKTHROUGH_GET_GIFT_CARDS_ON_FILE","type":"constant","attributes":{"value":"1. If needed, call [SearchCustomers](${SQUARE_TECH_REF}/customers-api/search-customers) to find the customer profile for the buyer. You can search by phone number, email address, and other supported query filters. For example, if the buyer signs in to your application using an email address, you can use the following request: \n\n ``` endpoint:Customers-SearchCustomers\n {\n \"authentication\": {\n \"accessToken\": \"{ACCESS_TOKEN}\"\n },\n \"bodyParameters\": {\n \"query\": {\n \"filter\": {\n \"email_address\": {\n \"exact\": \"{EMAIL_ADDRESS}\"\n }\n }\n }\n }\n }\n ```\n\n1. Copy the `id` of the customer profile from the response. You use this ID to list the gift cards on file for the buyer in the next step. \n\n1. Call [ListGiftCards](${SQUARE_TECH_REF}/gift-cards-api/list-gift-cards) and specify the ID of the customer profile for the `customer_id` query parameter:\n\n ```endpoint:GiftCards-ListGiftCards\n {\n \"authentication\": {\n \"accessToken\": \"{ACCESS_TOKEN}\"\n },\n \"queryParameters\" : {\n \"customer_id\": \"{{customer_id}}\"\n },\n \"environment\": \"sandbox\"\n }\n ```\n\n The following example response contains one gift card, which means that the buyer has only one gift card on file:\n\n ```json copy_code\n {\n \"gift_cards\": [\n {\n \"id\": \"gftc:012440e514754c42990f3de4527498dc\",\n \"type\": \"DIGITAL\",\n \"gan_source\": \"SQUARE\",\n \"state\": \"ACTIVE\",\n \"balance_money\": {\n \"amount\": 2500,\n \"currency\": \"USD\"\n },\n \"gan\": \"7783320002382646\",\n \"created_at\": \"2021-04-11T18:49:34Z\",\n \"customer_ids\": [\n \"62Y0FBFDQ0ZHDCGKBYP7FZK474\"\n ]\n }\n ]\n }\n ```\n\n1. Allow the buyer to confirm or select the gift card they want to use for payment. For example, for each linked gift card in the `ACTIVE` state, display the last four digits of the GAN along with the gift card balance."}},{"id":"GC_WALKTHROUGH_CREATE_ORDER","type":"constant","attributes":{"value":"1. Call [CreateOrder](${SQUARE_TECH_REF}/orders-api/create-order) to create an order.\n\n ```endpoint:Orders-CreateOrder\n {\n \"authentication\": {\n \"accessToken\": \"{ACCESS_TOKEN}\"\n },\n \"bodyParameters\": {\n \"idempotency_key\": \"{UNIQUE_KEY}\",\n \"order\": {\n \"location_id\": \"{LOCATION_ID}\",\n \"line_items\": [\n {\n \"name\": \"Stadium backpack\",\n \"quantity\": \"1\",\n \"base_price_money\": {\n \"amount\": 1599,\n \"currency\": \"USD\"\n }\n }\n ]\n }\n },\n \"environment\": \"sandbox\"\n }\n ``` \n\n1. Copy the `id` of the order from the response. You use this ID when you create the payment."}},{"id":"GC_WALKTHROUGH_GIFT_CARD_PAYMENT_COMPLETED","type":"constant","attributes":{"value":" The response should show that the payment status is `COMPLETED` and the `card_details` status is `CAPTURED`. Note that Square also supports [taking partial payments with Square gift cards.](payments-api/take-payments/card-payments/partial-payments-with-gift-cards)\n\n When you use the Payments API to process the payment, Square automatically creates a `REDEEM` activity that updates the gift card balance after the payment is successfully completed. "}},{"id":"GC_WALKTHROUGH_GET_ID_FROM_GAN","type":"constant","attributes":{"value":"!!!info\nLinking a customer profile to a gift card is only required to follow the steps in this walkthrough, which takes a payment from a gift card on file. \n\nAlternatively, to get the gift card ID to provide as the `source_id` in the `CreatePayment` request, your application can collect the gift card account number (GAN) from the buyer and call [RetrieveGiftCardFromGAN.](${SQUARE_TECH_REF}/gift-cards-api/retrieve-gift-card-from-gan) \n!!!"}},{"id":"INVOICES_AFTER_PUBLISH","type":"constant","attributes":{"value":"After an invoice is published and the `scheduled_at` date (if specified) is reached, Square does the following:\n - Generates the invoice payment page where customers can make a payment.\n - Adds the `public_url` field with the payment page URL to the invoice.\n - Adds the `next_payment_amount_money` field with the next payment amount due to the invoice, unless an automatic payment for the balance is completed immediately.\n - Processes the invoice based on the invoice settings and handles the remaining workflow. \n\n For example, Square can email the invoice, charge a card on file, or take no action if you or the seller wants to follow up with the customer directly. Square manages automatic payments and payments that customers make from the invoice payment page. Square also updates the invoice payment status and sends reminders and receipts as scheduled. "}},{"id":"SQUARE_BRIDGE_INTEGRATION_NEXT_STEPS","type":"constant","attributes":{"value":"[//]: # (7IEINzNDo6NMS2k61WiaFj)\nCongratulations! Now that you have fully configured your Square Bridge integration, you can sync data. In Square Bridge, choose **Sync Data**, choose the record type you want to sync (for example, Customers), and then choose **Run Sync** to run a manual sync. Use the page to monitor the sync status of mapped ERP and Square records. \n\n!!!tip\nYou can use the manual sync to audit sync results if you are creating an integration with Square Bridge for your business for the first time.\n!!!\n\nWhen you are satisfied that manual synchronization is providing correct results, you can choose **Settings** and then choose **Sync Schedules** within Square Bridge to enable automatic syncs. "}},{"id":"SQUARE_BRIDGE_GET_STARTED_SUGGESTION","type":"constant","attributes":{"value":"[//]: # (3Z68PtZ1hSV0DWHUWrmxlg)\nIf you have not scheduled a consultation with your Square Bridge account executive yet, see [Get Started with Square Integrations](squarebridge/get-started) for information about getting started with a new Square integration with your ERP system."}},{"id":"SQUARE_BRIDGE_BC_NAME","type":"constant","attributes":{"value":"[//]: # (pqmrz1vLHqBvTBD1M3iG2)\nDynamics 365 Business Central"}},{"id":"INVOICES_STORE_PAYMENT_METHOD_ENABLED","type":"constant","attributes":{"value":"Indicates whether to allow customers to save credit card, debit card, or bank transfer payment information when paying an invoice. The default value is `false`. When set to `true`, Square displays a **Save my card on file** or **Save my bank on file** checkbox on the invoice payment page. If the checkbox is selected, Square creates a card on file or a bank account on file for the customer using the information provided in the payment form. Stored payment information can be used for future automatic payments. Allowing customers to save gift cards on file is not supported."}},{"id":"SQUARE_DASHBOARD_NAME","type":"constant","attributes":{"value":"Seller Dashboard"}},{"id":"DEVELOPER_DASHBOARD_NAME","type":"constant","attributes":{"value":"Developer Dashboard "}},{"id":"SANDBOX_DASHBOARD_NAME","type":"constant","attributes":{"value":"Sandbox Seller Dashboard"}},{"id":"CHECKOUT_NO_GIFT_CARD_PAYMENTS","type":"constant","attributes":{"value":"The Checkout API does not support Square gift card payments."}},{"id":"SANDBOX_TEST_VALUE_CASH_APP","type":"constant","attributes":{"value":"|source_id value |Error mapping |Expected behavior |\n|:-------------------------------------:|:--------------------|:-----------------|\n|`wnon:cash-app-ok` | |The request is successful.|\n|`wnon:cash-app-declined`|GENERIC_DECLINE|The request failed.|\n"}},{"id":"SANDBOX_TEST_VALUE_AFTERPAY","type":"constant","attributes":{"value":"Use the following test payment tokens as `source_id` in `CreatePayment` requests for testing Afterpay payments in the Sandbox.\n\n|source_id value |Error mapping |Expected behavior |\n|:-------------------------------------:|:--------------------|:-----------------|\n|`wnon:afterpay-or-clearpay-ok` | |The request is successful.|\n|`wnon:afterpay-or-clearpay-declined`|GENERIC_DECLINE|The request failed.|\n"}},{"id":"PAYMENT_MINIMUMS","type":"constant","attributes":{"value":"|Country|Minimum payment|\n|--- |--- |\n|Australia|$0.01|\n|Canada|$0.01|\n|France|0.01 EUR|\n|Ireland|0.01 EUR|\n|Japan|¥1|\n|United Kingdom|£0.01|\n|United States|$0.01|\n\n### ACH payment minimums\n|Country|Minimum payment|\n|--- |--- |\n|United States|$0.01|\n\n### Cash payment and external payment minimums\n|Country|Minimum payment for cash/external payments|\n|--- |--- |\n|Australia|**Cash:** $0 (amount can only be specified in increments of $0.05.) **External:** $0||\n|Canada|**Cash:** $0 (amount can only be specified in increments of $0.05). **External:** $0|\n|France|0 EUR|\n|Ireland|0 EUR|\n|Japan|¥0|\n|United Kingdom|£0|\n|United States|$0|\n\n### Afterpay minimums and maximums\n| Country | Minimum payment |Maximum payment |\n|----------------|-----------------|----------------|\n| Australia | $1.00 |$2,000 |\n| Canada | $1.00 |$2,000 |\n| United Kingdom | £1.00 | £1,000 |\n| United States | $1.00 |$2,000 |"}},{"id":"API_LOGGER_NAME","type":"constant","attributes":{"value":"API Logs"}},{"id":"MD_BLOCKS","type":"constant-set","relationships":{"constants":{"data":[{"id":"REUSE_BLOCK_FIND_LOCATION_INTRO","type":"constant"},{"id":"INFO_YOU_NEED","type":"constant"},{"id":"INFO_LOCATION_ID","type":"constant"},{"id":"INFO_APP_ID","type":"constant"},{"id":"INFO_APP_SECRET","type":"constant"},{"id":"INFO_ACCESS_TOKEN","type":"constant"},{"id":"PREREQ_ACTIVE_ACCOUNT","type":"constant"},{"id":"PREREQ_SQUARE_ACCOUNT","type":"constant"},{"id":"PREREQ_HTTPS","type":"constant"},{"id":"LIMIT_NO_SANDBOX","type":"constant"},{"id":"ASSUME_IOS","type":"constant"},{"id":"ASSUME_ANDROID","type":"constant"},{"id":"ASSUME_LOCALHOST","type":"constant"},{"id":"ASSUME_WEB_DEV","type":"constant"},{"id":"ASSUME_BACKEND","type":"constant"},{"id":"ASSUME_PRODUCT","type":"constant"},{"id":"BUY_SQUARE_READER_TIP","type":"constant"},{"id":"COF_ASK_PERMISSION","type":"constant"},{"id":"CONFIG_FILE_TIP","type":"constant"},{"id":"INFO_READER_SDK_REPO_PASSWORD","type":"constant"},{"id":"EXPAND_WITH_RECIPES","type":"constant"},{"id":"ASSUME_CONFIG_FILE","type":"constant"},{"id":"GET_APPID_LOCATIONID_WITH_ANIMATION","type":"constant"},{"id":"ASSUME_PAYMENTFORM_INTEGRATION","type":"constant"},{"id":"IAP_DIGITAL_WARNING","type":"constant"},{"id":"INFO_SANDBOX_APP_ID","type":"constant"},{"id":"SQUARE_SANDBOX","type":"constant"},{"id":"LOG_IN_AND_VIEW_SANDBOX_DASHBOARD","type":"constant"},{"id":"LOG_IN_AND_RETURN_TO_DOCPAGE","type":"constant"},{"id":"GET_HELP","type":"constant"},{"id":"PREREQ_SANDBOX_SDK","type":"constant"},{"id":"PREREQ_SANDBOX_CURL","type":"constant"},{"id":"GRN_CHK","type":"constant"},{"id":"V2_WEBHOOK","type":"constant"},{"id":"API_EXPLORER","type":"constant"},{"id":"DISPUTES_TEST_VALUES","type":"constant"},{"id":"DEPRECATION_TABLE","type":"constant"},{"id":"LOYALTY_SANDBOX_PHONE","type":"constant"},{"id":"MASTERPASS_LONG","type":"constant"},{"id":"MASTERPASS","type":"constant"},{"id":"MASTERPASS_SRC","type":"constant"},{"id":"TERMINAL_CHECKOUT","type":"constant"},{"id":"TERMINAL_REFUND","type":"constant"},{"id":"SQUARE_ONLINE_EAP","type":"constant"},{"id":"LOYALTY_WALKTHROUGH_SETUP_NOTE_AVAILABILITY","type":"constant"},{"id":"CUSTOMER_ASSIGNMENTS_FOR_ORDERS_AND_PAYMENTS","type":"constant"},{"id":"GIFT_CARD_ACTIVATE_OR_LOAD_ORDER_REQ","type":"constant"},{"id":"WALKTHROUGH_GATHER_ACCOUNT_INFO","type":"constant"},{"id":"GIFT_CARD_PHYSICAL_CARD_IN_SANDBOX","type":"constant"},{"id":"SECURE_SANDBOX_ACCESS_TOKEN","type":"constant"},{"id":"MAX_LOAD_AMOUNT","type":"constant"},{"id":"MAX_BALANCE_AMOUNT","type":"constant"},{"id":"MAX_PAYMENT_CARD_AMOUNT","type":"constant"},{"id":"MAX_SELLER_BALANCE_AMOUNT","type":"constant"},{"id":"LOYALTY_API_VIDEO","type":"constant"},{"id":"SQUARE_BRIDGE_SAPB1","type":"constant"},{"id":"SQUARE_BRIDGE_NETSUITE","type":"constant"},{"id":"SQUARE_BRIDGE_BUSINESS_CENTRAL","type":"constant"},{"id":"SQUARE_BRIDGE_GETSTARTED_AGNOSTIC_TOP","type":"constant"},{"id":"SQUARE_BRIDGE_GETSTARTED_AGNOSTIC_PREREQ","type":"constant"},{"id":"LIST_GIFT_CARD_ACTIVITIES","type":"constant"},{"id":"SQUARE_BRIDGE_AGNOSTIC_GET_STARTED","type":"constant"},{"id":"EXAMPLE_ACCESS_TOKEN","type":"constant"},{"id":"SQUARE_BRIDGE_SETTLEMENT_RULES","type":"constant"},{"id":"SQUARE_BRIDGE_NETSUITE_SYNCMAP_INVENTORY_CHANGE","type":"constant"},{"id":"VIEW_GIFT_CARD_ACTIVITIES_SELLER_DASHBOARD","type":"constant"},{"id":"GC_WALKTHROUGH_GET_GIFT_CARDS_ON_FILE","type":"constant"},{"id":"GC_WALKTHROUGH_CREATE_ORDER","type":"constant"},{"id":"GC_WALKTHROUGH_GIFT_CARD_PAYMENT_COMPLETED","type":"constant"},{"id":"GC_WALKTHROUGH_GET_ID_FROM_GAN","type":"constant"},{"id":"INVOICES_AFTER_PUBLISH","type":"constant"},{"id":"SQUARE_BRIDGE_INTEGRATION_NEXT_STEPS","type":"constant"},{"id":"SQUARE_BRIDGE_GET_STARTED_SUGGESTION","type":"constant"},{"id":"SQUARE_BRIDGE_BC_NAME","type":"constant"},{"id":"INVOICES_STORE_PAYMENT_METHOD_ENABLED","type":"constant"},{"id":"SQUARE_DASHBOARD_NAME","type":"constant"},{"id":"DEVELOPER_DASHBOARD_NAME","type":"constant"},{"id":"SANDBOX_DASHBOARD_NAME","type":"constant"},{"id":"CHECKOUT_NO_GIFT_CARD_PAYMENTS","type":"constant"},{"id":"SANDBOX_TEST_VALUE_CASH_APP","type":"constant"},{"id":"SANDBOX_TEST_VALUE_AFTERPAY","type":"constant"},{"id":"PAYMENT_MINIMUMS","type":"constant"},{"id":"API_LOGGER_NAME","type":"constant"}]}}},{"id":"5yCY36DCA9ZUNegMYCbpFg","type":"doc-page","attributes":{"slug":"build-basics/general-considerations","heading":{"id":"2Pz8yG1LfhGlGSFT1Ba93d","title":"General Development Considerations","eyebrow":"Build Basics","summary":null,"browser_title":"General Development Considerations","release_status":"PUBLIC"},"related-pages":null,"search-summary":"Explains some of the introductory common considerations when you begin integrating the Square API in your application.","languages-supported":["All"],"platforms":["All"],"left-nav-id":null},"relationships":{"content":{"data":[{"id":"1bXZNaNwoZeQctAaSwRbCQ","type":"markdown-block"}]},"constant-sets":{"data":[{"id":"MD_BLOCKS","type":"constant-set"},{"id":"DEVELOPERS_URLS","type":"constant-set"}]}}}]}