Connect Claude & ChatGPT to Square

29 tools for Square

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

• cancel_invoiceDeletesCancel a published, unpaid invoice by `invoice_id` and `version`. The customer can no longer pay it. Cannot be undone.
• create_customerChanges dataCreate a customer profile with `given_name`, `family_name`, `company_name`, `email_address`, `phone_number`, `address` or `note`. Search first to avoid duplicates.
• create_invoiceChanges dataCreate a draft invoice for an existing order: `invoice` with location_id, order_id, primary_recipient {customer_id}, payment_requests (request_type BALANCE, due_date) and delivery_method (EMAIL). Publish it with publish_invoice.
• create_orderChanges dataCreate an order: `order` with location_id, line_items (name or catalog_object_id, quantity, base_price_money) and optional customer_id. Needed before creating an invoice.
• create_payment_linkChanges dataCreate a checkout payment link. For a simple amount use `quick_pay` {name, price_money {amount, currency}, location_id}; or pass an `order`. Returns a URL to share.
• get_catalog_itemGet one catalog object (item, variation, category, tax) by `object_id`, with `include_related_objects` for variations and categories.
• get_customerGet one customer profile by `customer_id`, with contact details, note and groups.
• get_inventory_countGet current stock counts for an item variation by `catalog_object_id`, optionally for specific `location_ids`.
• get_invoiceGet one invoice by `invoice_id`, with status, payment requests, amounts and the public URL.
• get_merchantGet the connected Square business (merchant) details, such as name, country and currency.
• get_orderGet one order by `order_id`, with line items, taxes, discounts, fulfillments and totals.
• get_paymentGet one payment by `payment_id`, with amount, status, card details, order and refund info.
• get_payoutGet one payout by `payout_id`, with amount, status and destination. Read-only.
• get_subscriptionGet one subscription by `subscription_id`, with plan, status, start date and charged-through date.
• list_locationsList your business locations with their IDs, addresses and currencies. Many calls take a `location_id`.
• list_payment_linksList your checkout payment links with their URLs and order IDs.
• list_paymentsList card and other payments, filtered by `begin_time`/`end_time` (RFC 3339), `location_id`, `last_4` or `card_brand`, with `cursor` paging.
• list_payoutsList payouts from Square to your bank account, filtered by `begin_time`/`end_time`, `status` or `location_id`. Read-only.
• list_refundsList refunds, filtered by `begin_time`/`end_time`, `location_id` or `status`, with `cursor` paging.
• publish_invoiceVisible to othersPublish (send) a draft invoice by `invoice_id` and `version`; Square emails it to the customer or charges a card on file, depending on the invoice settings.
• refund_paymentMoves moneyRefund a payment: `payment_id`, `amount_money` {amount in smallest unit, e.g. 1000 = 10.00, currency}, optional `reason`, and a unique `idempotency_key` (any new string). Sends money back to the buyer.
• search_catalog_itemsChanges dataSearch products (catalog items) by `text_filter`, `category_ids`, `stock_levels` (LOW, OUT) or `product_types`.
• search_customersChanges dataSearch customers with a `query` filter (e.g. email_address {fuzzy}, phone_number, created_at) and sort; returns IDs for other calls.
• search_invoicesChanges dataSearch invoices with `query` {filter: {location_ids: [...], customer_ids: [...]}}; location_ids is required.
• search_ordersChanges dataSearch orders across `location_ids` (required by Square) with a `query` filter on state, dates or customer, and `cursor` paging.
• search_subscriptionsChanges dataSearch subscriptions with a `query` filter on customer_ids, location_ids or source names.
• update_customerChanges dataUpdate a customer by `customer_id`; only the fields you pass (name, email, phone, address, note) change.
• update_invoiceChanges dataUpdate an invoice by `invoice_id`; pass `invoice` with its current version and the fields to change.
• upsert_catalog_itemChanges dataCreate or update a catalog object such as an item with variations and prices: pass `object` (type ITEM, item_data) and a unique `idempotency_key`. For updates include the object's id and version.

Questions