Settlements
Query summary information for deposits and withdrawals initiated by Square to the Bank Account of a Merchant.
Table Specific Information
Select
Note: LocationId is needed to execute the query.
The adapter uses the Square API to process search criteria that refer to the Id column, while other filters are processed client side within the adapter.
Retrieve all Settlements for a given LocationId:
SELECT * FROM Settlements WHERE LocationId = '92BYHNBR6W77E'
Retrieve a specific Settlement by providing a given LocationId and a valid Id:
SELECT * FROM Settlements WHERE Id = 'abc123' AND LocationId = '92BYHNBR6W77E'
Columns
| Name | Type | Description |
| Id [KEY] | String | The Id of the settlement. |
| LocationId | String | The Id of the location. |
| Status | String | The status of the settlement.
The allowed values are SENT, FAILED. |
| BankAccountId | String | The Id of the bank account. |
| InitiatedAt | Datetime | The date and time a settlement was initiated. |
| Amount | Integer | The amount of money involved in the settlement. |
| CurrencyCode | String | The currency code of the money involved in the settlement. |
| EntriesAggregate | String | The entries included in this settlement. |