> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Square Connector

## Intro

Square, Inc. is a financial services, merchant services aggregator, and mobile payments company. You can use Domo's Square connector to retrieve financial data such as settlements, payments, refunds, and so on. To learn more about the Square API, go to [https://developer.squareup.com/docs/](https://developer.squareup.com/docs/ "https://docs.connect.squareup.com/").

The Square connector is a "Cloud App" connector, meaning it retrieves data stored in the cloud. In the Data Center, you can access the connector page for this and other Cloud App connectors by clicking **Cloud App** in the toolbar at the top of the window.

This topic discusses the fields and menus that are specific to the Square connector user interface. For general information about adding DataSets, setting update schedules, and editing DataSet information, see [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

<table class="mt-responsive-table" data-aura-rendered-by="33:195;a"><tbody><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Use Cases </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> Use this connector to retrieve data about inventory, sales, payments, refunds, and bank deposits. </p></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Metrics </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><ul><li><p> Items in inventory </p></li><li><p> Payment and sales information </p></li><li><p> Refunded amounts </p></li><li><p> Cashflow going to bank account </p></li><li><p> Locations payments are being made </p></li><li><p> Amounts generated per location </p></li></ul></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Company Roles </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><ul><li><p> CFO </p></li><li><p> Accounting </p></li><li><p> Sales </p></li><li><p> Warehouse </p></li></ul></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Average Implementation Time </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> A few minutes </p></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Ease of Use (on a 1-to-10 scale with 1 being easiest) </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> 2 </p></td></tr></tbody></table>

## Prerequisites

To connect to your Square account and create a DataSet, you must have the following:

* The email address you use to log into your Square account
* The password for your Square account

## Connecting to Square

This section enumerates the options in the **Credentials** and **Details** panes in the Square connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Credentials Pane

The Square connector uses OAuth to connect. Click **Add account** to open the Square OAuth screen where you can enter the email address associated with your Square account and your password. An authenticated user session in Square in another browser tab should complete OAuth for the user with the active browser session. After you have entered valid credentials, you can use the same account in Domo any time you create a Square DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

## Details Pane

In this pane you choose your report type as well as any required parameters.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select a Square report. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><b> Report Name </b></td><td colspan="1" rowspan="1"><p><b> Description </b></p></td></tr><tr><td colspan="1" rowspan="1"><p> Catalog </p></td><td colspan="1" rowspan="1"> Returns information about product inventory & catalog. </td></tr><tr><td colspan="1" rowspan="1"><p> Customers </p></td><td colspan="1" rowspan="1"> Returns summary information for all of the merchant's customers. </td></tr><tr><td colspan="1" rowspan="1"><p> Labor Break Types </p></td><td colspan="1" rowspan="1"> Returns possible break types. </td></tr><tr><td colspan="1" rowspan="1"><p> Labor Shifts </p></td><td colspan="1" rowspan="1"> Returns shift data </td></tr><tr><td colspan="1" rowspan="1"><p> Labor Wages </p></td><td colspan="1" rowspan="1"> Returns wages for team. </td></tr><tr><td colspan="1" rowspan="1"><p> Locations </p></td><td colspan="1" rowspan="1"> Returns the merchant's locations information. </td></tr><tr><td colspan="1" rowspan="1"><p> Orders </p></td><td colspan="1" rowspan="1"> Returns the information about orders. </td></tr><tr><td colspan="1" rowspan="1"><p> Payments </p></td><td colspan="1" rowspan="1"> Returns payment information. </td></tr><tr><td colspan="1" rowspan="1"><p> Refunds </p></td><td colspan="1" rowspan="1"> Returns details for all refunds initiated by the merchant or any of the merchant's mobile staff. </td></tr><tr><td colspan="1" rowspan="1"><p> Team Members </p></td><td colspan="1" rowspan="1"> Returns summary information on about the Team. </td></tr><tr><td colspan="1" rowspan="1"><p> v1 - Cash Drawer Shifts - Deprecated </p></td><td colspan="1" rowspan="1"> Deprecation 2020-02-26 - use v2 Cash Drawer Shift. </td></tr><tr><td colspan="1" rowspan="1"><p> v1 - Merchant </p></td><td colspan="1" rowspan="1"> Returns the merchant's account information, such as business name and email address. </td></tr><tr><td colspan="1" rowspan="1"><p> v1 - Payments </p></td><td colspan="1" rowspan="1"> Returns information for all payments taken by the merchant or any of the merchant's mobile staff. </td></tr><tr><td colspan="1" rowspan="1"><p> v1 - Payment Itemization </p></td><td colspan="1" rowspan="1"> Returns information for all payments taken by the merchant or any of the merchant's mobile staff, broken down into itemized payment information, including discounts, modifiers and taxes. </td></tr><tr><td colspan="1" rowspan="1"><p> v1 - Refunds </p></td><td colspan="1" rowspan="1"> Returns details for all refunds initiated by the merchant or any of the merchant's mobile staff. </td></tr><tr><td colspan="1" rowspan="1"><p> v1 - Settlements Entries </p></td><td colspan="1" rowspan="1"> Returns information about all transactions in a settlement. </td></tr><tr><td colspan="1" rowspan="1"><p> v1 - Settlements </p></td><td colspan="1" rowspan="1"> Returns summary information for all deposits and withdrawals initiated by Square to the merchant's bank account. </td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"> Date From </td><td colspan="1" rowspan="1"><p> Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in <b> Date To </b>. </p></td></tr><tr><td colspan="1" rowspan="1"> Select Specific Date From </td><td colspan="1" rowspan="1"><p> Select the first date in your date range. </p> <Note> <div class="info-box-wrapper"><div class="info-box-icon-container" /><div class="info-box-content-container"><div class="info-box-content"><span><b> Note: </b> The connector will throw an error if a date range greater than 1 year is selected. </span></div></div></div> </Note> </td></tr><tr><td colspan="1" rowspan="1"> Date To </td><td colspan="1" rowspan="1"> Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in <b> Date From </b>. </td></tr><tr><td colspan="1" rowspan="1"> Select Specific Date To </td><td colspan="1" rowspan="1"><p> Select the last date in your date range. </p>  <Note> <div class="info-box-wrapper"><div class="info-box-icon-container" /><div class="info-box-content-container"><div class="info-box-content"><span><b> Note: </b> The connector will throw an error if a date range greater than 1 year is selected. </span></div></div></div>  </Note> </td></tr><tr><td colspan="1" rowspan="1"> Date From Offset </td><td colspan="1" rowspan="1"><p> Enter the number of the farthest day back that should be represented in the report. Combine with <b> Date To Offset </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Date From Offset </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Date To Offset </b>, the report would contain data for <span class="mt-font-courier-new"> 10 </span> days ago up until <span class="mt-font-courier-new"> 5 </span> days ago. </p></td></tr><tr><td colspan="1" rowspan="1"> Date To Offset </td><td colspan="1" rowspan="1"><p> Enter the number of the most recent day that should be represented in the report. Combine with <b> Date From Offset </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Date From Offset </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Date To Offset </b>, the report would contain data for <span class="mt-font-courier-new"> 10 </span> days ago up until <span class="mt-font-courier-new"> 5 </span> days ago. </p></td></tr></tbody></table>

## Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Troubleshooting

* Ensure your credentials are valid.
* Make sure you have reasonable date ranges. The connector will throw an error if a date range greater than 1 year is selected.

## FAQs

<AccordionGroup>
  <Accordion title="How do I know my credentials are secure?">
    The login process uses OAuth, so your login credentials are never seen or stored by Domo. You can revoke Domo's access to your Square account at any time.
  </Accordion>

  <Accordion title="How often can the data be updated?">
    DataSets can be updated as often as once an hour. Update frequency should be decreased if rate limit errors are encountered.
  </Accordion>

  <Accordion title="Are there any API limits I should be aware of?">
    Square does not document rate limits in its API.
  </Accordion>

  <Accordion title="What is the difference between the Square and Square V2 connectors?">
    The [Square V2 connector](/s/article/360042928474 "Square V2 Connector") supports Catalog, Customers, Locations, Refunds, and Transactions reports. The Square connector supports Items, Locations, Merchant, Payments, Payment Itemization, Refunds, and Settlements reports
  </Accordion>
</AccordionGroup>
