Data Dictionary

Data Dictionary

The Square API creates a data object in response to each request, which Panoply unpacks and organizes into tables. Click here to view the data dictionary spreadsheet.

Terminal 

The Terminal API requests a checkout from a paired Square Terminal. Panoply collects the Checkouts endpoint of the Square Terminal API.

Checkouts

The Checkouts endpoint retrieves a filtered list of Terminal checkout requests created by the account making the request.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Payment 

The Payments API lets developers take and manage payments. Panoply collects the Payments endpoint of the Payments API.

Payments

The Payments endpoint retrieves a list of payments taken by the account making the request.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Refunds

The Square Refund API allows users to manage and issue refunds for payments made to Square merchants. Panoply collects the Payment Refunds endpoint from the Refund API.

Payment Refunds

The Payment Refunds endpoint retrieves a list of refunds for the account making the request.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Orders

The Square Orders API retrieves sales data for a Square merchant, itemizes payments, pushes orders to POS, and more. Panoply collects the Orders endpoint of the Orders API.

Orders

The orders endpoint of the Orders API retrieves all orders for one or more locations. Orders include all sales, returns, and exchanges regardless of how or when they entered the Square Ecosystem (e.g. Point of Sale, Invoices, Connect APIs, etc).

 To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Catalog

The Catalog API allows users to manage their item catalog in Point of Sale, including items, variations, categories, discounts, taxes, modifiers, and more. Panoply collects the Catalog Objects endpoint of the Catalog API.

Catalog Objects

The Catalog Objects endpoint retrieves CatalogObjects of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query expressions.

 To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Inventory

The Inventory API provides the ability to do a 2-way sync between your inventory system and Square using catalog items. Panoply collects the Inventory Counts and the Inventory Changes endpoints.

Inventory Counts

The Inventory Counts endpoint returns the current counts for the provided CatalogObjects at the requested Locations.

When updated_after is specified, only counts that have changed since that time (based on the server timestamp for the most recent change) are returned. This allows clients to perform a “sync” operation, for example in response to receiving a Webhook notification.

 To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Inventory Changes

The Inventory Changes endpoint returns historical physical counts and adjustments based on the provided filter criteria. BatchRetrieveInventoryChanges is a catch-all query endpoint for queries that cannot be handled by other, simpler endpoints.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Customers

The Customers API enables you to create and manage customer profiles, as well as search for customers based on various criteria (including customer group membership).  In addition, the API allows you to sync contacts between your CRM system and Square. Panoply collects the Customers endpoint of the Customers API.

Customers

The Customers endpoint retrieves the customer profiles associated with a Square account using a supported query filter.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Customer Segments

The Customer Segments API lets you retrieve information about segments available in the business account.  Panoply collects the Customer Segments endpoint of the Customer Segments API.

Customer Segments

 The Customer Segments retrieves the list of customer segments of a business.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Locations

The Locations API retrieves data about merchant locations, such as their addresses, names, and business hours. Panoply collects the Locations enpoint from the Locations API.

Locations

The List Locations endpoint hprovides information of all locations of a business.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Cash Drawers

Cash drawers track cash transactions so that total money in the cash drawers can be reconciled for a specific period of time (a cash drawer shift) for a particular device in a particular location. The Cash Drawers API enables you to list and retrieve cash drawers information. Panoply collects the Cash Drawer Shifts and the Cash Drawer Shift Events endpoints of the Cash Drawers API.

Cash Drawer Shifts

The Cash Drawer Shifts endpoint provides the details for all of the cash drawer shifts for a location in a date range. 

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Cash Drawer Shift Events

The Cash Drawer Shift Events endpoint provides a paginated list of events for a single cash drawer shift.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Team API

The Team API allows applications to retrieve a roster of team members registered in the Square Point of Sale system, which can be useful in payroll and account contexts. Panoply collects the Team Members and the Wage Settings end points of the Team API.

Team Members

The Team Members endpoint returns a paginated list of TeamMember objects for a business.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Wage Settings

The Wage Settings endpoint retrieves the WageSetting object for a team member specified by TeamMember.id.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Labor

The Labor API allows you to see when employees clocked in and out, how much they worked during different periods, and how many breaks they took. Panoply collects four endpoints of the Labor API.

Break Types

The Break Types endpoint returns a paginated list of BreakType instances for a business.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Team Member Wages

The Team Member Wages endpoint returns a list of Team Member Wage instances for a business.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Shifts

The Search Shifts endpoint returns a list of Shift records for a business.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Workweek Configs

The Workweek Configs endpoint returns a list of WorkweekConfig instances for a business.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Bank Account

The Bank Account API allows you to get basic details about a merchant’s bank account, such as the last few digits of the account number and the routing number. Panoply collects the Bank Accounts endpoint of the Bank Account API.

 Bank Accounts

The Bank Accounts enpoint returns a list of BankAccount objects linked to a Square account.

To view the attributes of this endpoint, see the Data Dictionary in Google Sheets.

Metadata

Panoply adds the following metadata fields to each table collected from Square.

  • __business_name: The name of the connected Square business - the selection of the business is happening during the oAuth authentication process.
  • __resource: The name of the selected resource
Getting started is easy! Get all your data in one place in minutes.
Try Free