/v2/apple-pay/domains

RegisterDomain

/v2/customers/groups/{group_id}

UpdateCustomerGroup

• group_id (path, required) — The ID of the customer group to update.

/mobile/authorization-code

CreateMobileAuthorizationCode

/oauth2/clients/{client_id}/access-token/renew

RenewToken

• client_id (path, required) — Your application ID, available from the [developer dashboard](https://developer.squareup.com/apps).

/oauth2/revoke

RevokeToken

/oauth2/token

ObtainToken

/v1/me/employees

ListEmployees

• order (query) — The order in which employees are listed in the response, based on their created_at field. Default value: ASC
• begin_updated_at (query) — If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
• end_updated_at (query) — If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
• begin_created_at (query) — If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
• end_created_at (query) — If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.
• status (query) — If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
• external_id (query) — If provided, the endpoint returns only employee entities with the specified external_id.
• limit (query, limit) — The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
• batch_token (query) — A pagination cursor to retrieve the next set of results for your original query to the endpoint.

/v1/me/employees

CreateEmployee

/v1/me/employees/{employee_id}

RetrieveEmployee

• employee_id (path, required) — The employee's ID.

/v1/me/employees/{employee_id}

UpdateEmployee

• employee_id (path, required) — The ID of the role to modify.

/v1/me/roles

ListEmployeeRoles

• order (query) — The order in which employees are listed in the response, based on their created_at field.Default value: ASC
• limit (query, limit) — The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
• batch_token (query) — A pagination cursor to retrieve the next set of results for your original query to the endpoint.

/v1/me/roles

CreateEmployeeRole

/v1/me/roles/{role_id}

RetrieveEmployeeRole

• role_id (path, required) — The role's ID.

/v1/me/roles/{role_id}

UpdateEmployeeRole

• role_id (path, required) — The ID of the role to modify.

/v1/{location_id}/orders

ListOrders

• location_id (path, required) — The ID of the location to list online store orders for.
• order (query) — The order in which payments are listed in the response.
• limit (query, limit) — The maximum number of payments to return in a single response. This value cannot exceed 200.
• batch_token (query) — A pagination cursor to retrieve the next set of results for your original query to the endpoint.

/v1/{location_id}/orders/{order_id}

RetrieveOrder

• location_id (path, required) — The ID of the order's associated location.
• order_id (path, required) — The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

/v1/{location_id}/orders/{order_id}

UpdateOrder

• location_id (path, required) — The ID of the order's associated location.
• order_id (path, required) — The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

/v1/{location_id}/payments

ListPayments

• location_id (path, required) — The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.
• order (query) — The order in which payments are listed in the response.
• begin_time (query) — The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
• end_time (query) — The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
• limit (query, limit) — The maximum number of payments to return in a single response. This value cannot exceed 200.
• batch_token (query) — A pagination cursor to retrieve the next set of results for your original query to the endpoint.
• include_partial (query) — Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

/v1/{location_id}/payments/{payment_id}

RetrievePayment

• location_id (path, required) — The ID of the payment's associated location.
• payment_id (path, required) — The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.

/v1/{location_id}/refunds

ListRefunds

• location_id (path, required) — The ID of the location to list refunds for.
• order (query) — The order in which payments are listed in the response.
• begin_time (query) — The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
• end_time (query) — The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
• limit (query, limit) — The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.
• batch_token (query) — A pagination cursor to retrieve the next set of results for your original query to the endpoint.

/v1/{location_id}/refunds

CreateRefund

• location_id (path, required) — The ID of the original payment's associated location.

/v1/{location_id}/settlements

ListSettlements

• location_id (path, required) — The ID of the location to list settlements for. If you specify me, this endpoint returns settlements aggregated from all of the business's locations.
• order (query) — The order in which settlements are listed in the response.
• begin_time (query) — The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
• end_time (query) — The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
• limit (query, limit) — The maximum number of settlements to return in a single response. This value cannot exceed 200.
• status (query) — Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).
• batch_token (query) — A pagination cursor to retrieve the next set of results for your original query to the endpoint.

/v1/{location_id}/settlements/{settlement_id}

RetrieveSettlement

• location_id (path, required) — The ID of the settlements's associated location.
• settlement_id (path, required) — The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.

/v2/bank-accounts

ListBankAccounts

• cursor (query) — The pagination cursor returned by a previous call to this endpoint. Use it in the next `ListBankAccounts` request to retrieve the next set of results. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.
• limit (query, limit) — Upper limit on the number of bank accounts to return in the response. Currently, 1000 is the largest supported limit. You can specify a limit of up to 1000 bank accounts. This is also the default limit.
• location_id (query) — Location ID. You can specify this optional filter to retrieve only the linked bank accounts belonging to a specific location.

/v2/bank-accounts/by-v1-id/{v1_bank_account_id}

GetBankAccountByV1Id

• v1_bank_account_id (path, required) — Connect V1 ID of the desired `BankAccount`. For more information, see [Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).

/v2/bank-accounts/{bank_account_id}

GetBankAccount

• bank_account_id (path, required) — Square-issued ID of the desired `BankAccount`.

/v2/bookings

CreateBooking

/v2/bookings/availability/search

SearchAvailability

/v2/bookings/business-booking-profile

RetrieveBusinessBookingProfile

/v2/bookings/team-member-booking-profiles

ListTeamMemberBookingProfiles

• bookable_only (query) — Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).
• limit (query, limit) — The maximum number of results to return.
• cursor (query) — The cursor for paginating through the results.
• location_id (query) — Indicates whether to include only team members enabled at the given location in the returned result.

/v2/bookings/team-member-booking-profiles/{team_member_id}

RetrieveTeamMemberBookingProfile

• team_member_id (path, required) — The ID of the team member to retrieve.

/v2/bookings/{booking_id}

RetrieveBooking

• booking_id (path, required) — The ID of the [Booking](https://developer.squareup.com/reference/square_2021-08-18/objects/Booking) object representing the to-be-retrieved booking.

/v2/bookings/{booking_id}

UpdateBooking

• booking_id (path, required) — The ID of the [Booking](https://developer.squareup.com/reference/square_2021-08-18/objects/Booking) object representing the to-be-updated booking.

/v2/bookings/{booking_id}/cancel

CancelBooking

• booking_id (path, required) — The ID of the [Booking](https://developer.squareup.com/reference/square_2021-08-18/objects/Booking) object representing the to-be-cancelled booking.

/v2/cards

ListCards

• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
• customer_id (query) — Limit results to cards associated with the customer supplied. By default, all cards owned by the merchant are returned.
• include_disabled (query) — Includes disabled cards. By default, all enabled cards owned by the merchant are returned.
• reference_id (query) — Limit results to cards associated with the reference_id supplied.
• sort_order (query) — Sorts the returned list by when the card was created with the specified order. This field defaults to ASC.

/v2/cards

CreateCard

/v2/cards/{card_id}

RetrieveCard

• card_id (path, required) — Unique ID for the desired Card.

/v2/cards/{card_id}/disable

DisableCard

• card_id (path, required) — Unique ID for the desired Card.

/v2/cash-drawers/shifts

ListCashDrawerShifts

• location_id (query, required) — The ID of the location to query for a list of cash drawer shifts.
• sort_order (query) — The order in which cash drawer shifts are listed in the response, based on their opened_at field. Default value: ASC
• begin_time (query) — The inclusive start time of the query on opened_at, in ISO 8601 format.
• end_time (query) — The exclusive end date of the query on opened_at, in ISO 8601 format.
• limit (query, limit) — Number of cash drawer shift events in a page of results (200 by default, 1000 max).
• cursor (query) — Opaque cursor for fetching the next page of results.

/v2/cash-drawers/shifts/{shift_id}

RetrieveCashDrawerShift

• location_id (query, required) — The ID of the location to retrieve cash drawer shifts from.
• shift_id (path, required) — The shift ID.

/v2/cash-drawers/shifts/{shift_id}/events

ListCashDrawerShiftEvents

• location_id (query, required) — The ID of the location to list cash drawer shifts for.
• shift_id (path, required) — The shift ID.
• limit (query, limit) — Number of resources to be returned in a page of results (200 by default, 1000 max).
• cursor (query) — Opaque cursor for fetching the next page of results.

/v2/catalog/batch-delete

BatchDeleteCatalogObjects

/v2/catalog/batch-retrieve

BatchRetrieveCatalogObjects

/v2/catalog/batch-upsert

BatchUpsertCatalogObjects

/v2/catalog/info

CatalogInfo

/v2/catalog/list

ListCatalog

• cursor (query) — The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
• types (query) — An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the [CatalogObjectType](https://developer.squareup.com/reference/square_2021-08-18/enums/CatalogObjectType) enum, including `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. If this is unspecified, the operation returns objects of all the types at the version of the Square API used to make the request.
• catalog_version (query) — The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject)s' `version` attribute.

/v2/catalog/object

UpsertCatalogObject

/v2/catalog/object/{object_id}

DeleteCatalogObject

• object_id (path, required) — The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations).

/v2/catalog/object/{object_id}

RetrieveCatalogObject

• object_id (path, required) — The object ID of any type of catalog objects to be retrieved.
• include_related_objects (query) — If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a `CatalogItem`, its associated `CatalogCategory`, `CatalogTax`, `CatalogImage` and `CatalogModifierList` objects will be returned in the `related_objects` field of the response. If the `object` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. Default value: `false`
• catalog_version (query) — Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject)s.

/v2/catalog/search

SearchCatalogObjects

/v2/customers/{customer_id}/cards/{card_id}

DeleteCustomerCard

• customer_id (path, required) — The ID of the customer that the card on file belongs to.
• card_id (path, required) — The ID of the card on file to delete.

/v2/catalog/search-catalog-items

SearchCatalogItems

/v2/catalog/update-item-modifier-lists

UpdateItemModifierLists

/v2/catalog/update-item-taxes

UpdateItemTaxes

/v2/customers

ListCustomers

• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
• limit (query, limit) — The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. The limit is ignored if it is less than 1 or greater than 100. The default value is 100. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
• sort_field (query) — Indicates how customers should be sorted. The default value is `DEFAULT`.
• sort_order (query) — Indicates whether customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. The default value is `ASC`.

/v2/customers

CreateCustomer

/v2/customers/groups

ListCustomerGroups

• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
• limit (query, limit) — The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. The limit is ignored if it is less than 1 or greater than 50. The default value is 50. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).

/v2/customers/groups

CreateCustomerGroup

/v2/customers/groups/{group_id}

DeleteCustomerGroup

• group_id (path, required) — The ID of the customer group to delete.

/v2/customers/groups/{group_id}

RetrieveCustomerGroup

• group_id (path, required) — The ID of the customer group to retrieve.

/v2/customers/search

SearchCustomers

/v2/customers/segments

ListCustomerSegments

• cursor (query) — A pagination cursor returned by previous calls to `ListCustomerSegments`. This cursor is used to retrieve the next set of query results. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
• limit (query, limit) — The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. The limit is ignored if it is less than 1 or greater than 50. The default value is 50. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).

/v2/customers/segments/{segment_id}

RetrieveCustomerSegment

• segment_id (path, required) — The Square-issued ID of the customer segment.

/v2/customers/{customer_id}

DeleteCustomer

• customer_id (path, required) — The ID of the customer to delete.
• version (query) — The current version of the customer profile. As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile).

/v2/customers/{customer_id}

RetrieveCustomer

• customer_id (path, required) — The ID of the customer to retrieve.

/v2/customers/{customer_id}

UpdateCustomer

• customer_id (path, required) — The ID of the customer to update.

/v2/customers/{customer_id}/cards

CreateCustomerCard

• customer_id (path, required) — The Square ID of the customer profile the card is linked to.

/v2/customers/{customer_id}/groups/{group_id}

RemoveGroupFromCustomer

• customer_id (path, required) — The ID of the customer to remove from the group.
• group_id (path, required) — The ID of the customer group to remove the customer from.

/v2/customers/{customer_id}/groups/{group_id}

AddGroupToCustomer

• customer_id (path, required) — The ID of the customer to add to a group.
• group_id (path, required) — The ID of the customer group to add the customer to.

/v2/devices/codes

ListDeviceCodes

• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
• location_id (query) — If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty.
• product_type (query) — If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.
• status (query) — If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.

/v2/devices/codes

CreateDeviceCode

/v2/devices/codes/{id}

GetDeviceCode

• id (path, required) — The unique identifier for the device code.

/v2/disputes

ListDisputes

• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
• states (query) — The dispute states to filter the result. If not specified, the endpoint returns all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`).
• location_id (query) — The ID of the location for which to return a list of disputes. If not specified, the endpoint returns all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`) associated with all locations.

/v2/disputes/{dispute_id}

RetrieveDispute

• dispute_id (path, required) — The ID of the dispute you want more details about.

/v2/disputes/{dispute_id}/accept

AcceptDispute

• dispute_id (path, required) — The ID of the dispute you want to accept.

/v2/disputes/{dispute_id}/evidence

ListDisputeEvidence

• dispute_id (path, required) — The ID of the dispute.
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).

/v2/disputes/{dispute_id}/evidence-text

CreateDisputeEvidenceText

• dispute_id (path, required) — The ID of the dispute you want to upload evidence for.

/v2/disputes/{dispute_id}/evidence/{evidence_id}

DeleteDisputeEvidence

• dispute_id (path, required) — The ID of the dispute you want to remove evidence from.
• evidence_id (path, required) — The ID of the evidence you want to remove.

/v2/disputes/{dispute_id}/evidence/{evidence_id}

RetrieveDisputeEvidence

• dispute_id (path, required) — The ID of the dispute that you want to retrieve evidence from.
• evidence_id (path, required) — The ID of the evidence to retrieve.

/v2/disputes/{dispute_id}/submit-evidence

SubmitEvidence

• dispute_id (path, required) — The ID of the dispute that you want to submit evidence for.

/v2/employees

ListEmployees

• location_id (query)
• status (query) — Specifies the EmployeeStatus to filter the employee by.
• limit (query, limit) — The number of employees to be returned on each page.
• cursor (query) — The token required to retrieve the specified page of results.

/v2/employees/{id}

RetrieveEmployee

• id (path, required) — UUID for the employee that was requested.

/v2/gift-cards

ListGiftCards

• type (query) — If a type is provided, gift cards of this type are returned (see [GiftCardType](https://developer.squareup.com/reference/square_2021-08-18/enums/GiftCardType)). If no type is provided, it returns gift cards of all types.
• state (query) — If the state is provided, it returns the gift cards in the specified state (see [GiftCardStatus](https://developer.squareup.com/reference/square_2021-08-18/enums/GiftCardStatus)). Otherwise, it returns the gift cards of all states.
• limit (query, limit) — If a value is provided, it returns only that number of results per page. The maximum number of results allowed per page is 50. The default value is 30.
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, it returns the first page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination).
• customer_id (query) — If a value is provided, returns only the gift cards linked to the specified customer

/v2/gift-cards

CreateGiftCard

/v2/gift-cards/activities

ListGiftCardActivities

• gift_card_id (query) — If you provide a gift card ID, the endpoint returns activities that belong to the specified gift card. Otherwise, the endpoint returns all gift card activities for the seller.
• type (query) — If you provide a type, the endpoint returns gift card activities of this type. Otherwise, the endpoint returns all types of gift card activities.
• location_id (query) — If you provide a location ID, the endpoint returns gift card activities for that location. Otherwise, the endpoint returns gift card activities for all locations.
• begin_time (query) — The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year.
• end_time (query) — The timestamp for the end of the reporting period, in RFC 3339 format. Inclusive. Default: The current time.
• limit (query, limit) — If you provide a limit value, the endpoint returns the specified number of results (or less) per page. A maximum value is 100. The default value is 50.
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If you do not provide the cursor, the call returns the first page of the results.
• sort_order (query) — The order in which the endpoint returns the activities, based on `created_at`. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

/v2/inventory/changes/batch-create

BatchChangeInventory

/v2/gift-cards/activities

CreateGiftCardActivity

/v2/gift-cards/from-gan

RetrieveGiftCardFromGAN

/v2/gift-cards/from-nonce

RetrieveGiftCardFromNonce

/v2/gift-cards/{gift_card_id}/link-customer

LinkCustomerToGiftCard

• gift_card_id (path, required) — The ID of the gift card to link.

/v2/gift-cards/{gift_card_id}/unlink-customer

UnlinkCustomerFromGiftCard

• gift_card_id (path, required)

/v2/gift-cards/{id}

RetrieveGiftCard

• id (path, required) — The ID of the gift card to retrieve.

/v2/inventory/adjustment/{adjustment_id}

DeprecatedRetrieveInventoryAdjustment

• adjustment_id (path, required) — ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2021-08-18/objects/InventoryAdjustment) to retrieve.

/v2/inventory/adjustments/{adjustment_id}

RetrieveInventoryAdjustment

• adjustment_id (path, required) — ID of the [InventoryAdjustment](https://developer.squareup.com/reference/square_2021-08-18/objects/InventoryAdjustment) to retrieve.

/v2/inventory/batch-change

DeprecatedBatchChangeInventory

/v2/inventory/batch-retrieve-changes

DeprecatedBatchRetrieveInventoryChanges

/v2/inventory/batch-retrieve-counts

DeprecatedBatchRetrieveInventoryCounts

/v2/inventory/changes/batch-retrieve

BatchRetrieveInventoryChanges

/v2/inventory/counts/batch-retrieve

BatchRetrieveInventoryCounts

/v2/inventory/physical-count/{physical_count_id}

DeprecatedRetrieveInventoryPhysicalCount

• physical_count_id (path, required) — ID of the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2021-08-18/objects/InventoryPhysicalCount) to retrieve.

/v2/inventory/physical-counts/{physical_count_id}

RetrieveInventoryPhysicalCount

• physical_count_id (path, required) — ID of the [InventoryPhysicalCount](https://developer.squareup.com/reference/square_2021-08-18/objects/InventoryPhysicalCount) to retrieve.

/v2/inventory/transfers/{transfer_id}

RetrieveInventoryTransfer

• transfer_id (path, required) — ID of the [InventoryTransfer](https://developer.squareup.com/reference/square_2021-08-18/objects/InventoryTransfer) to retrieve.

/v2/inventory/{catalog_object_id}

RetrieveInventoryCount

• catalog_object_id (path, required) — ID of the [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) to retrieve.
• location_ids (query) — The [Location](https://developer.squareup.com/reference/square_2021-08-18/objects/Location) IDs to look up as a comma-separated list. An empty list queries all locations.
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

/v2/inventory/{catalog_object_id}/changes

RetrieveInventoryChanges

• catalog_object_id (path, required) — ID of the [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject) to retrieve.
• location_ids (query) — The [Location](https://developer.squareup.com/reference/square_2021-08-18/objects/Location) IDs to look up as a comma-separated list. An empty list queries all locations.
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

/v2/invoices

ListInvoices

• location_id (query, required) — The ID of the location for which to list invoices.
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
• limit (query, limit) — The maximum number of invoices to return (200 is the maximum `limit`). If not provided, the server uses a default limit of 100 invoices.

/v2/invoices

CreateInvoice

/v2/invoices/search

SearchInvoices

/v2/invoices/{invoice_id}

DeleteInvoice

• invoice_id (path, required) — The ID of the invoice to delete.
• version (query) — The version of the [invoice](https://developer.squareup.com/reference/square_2021-08-18/objects/Invoice) to delete. If you do not know the version, you can call [GetInvoice](https://developer.squareup.com/reference/square_2021-08-18/invoices-api/get-invoice) or [ListInvoices](https://developer.squareup.com/reference/square_2021-08-18/invoices-api/list-invoices).

/v2/invoices/{invoice_id}

GetInvoice

• invoice_id (path, required) — The ID of the invoice to retrieve.

/v2/invoices/{invoice_id}

UpdateInvoice

• invoice_id (path, required) — The ID of the invoice to update.

/v2/invoices/{invoice_id}/cancel

CancelInvoice

• invoice_id (path, required) — The ID of the [invoice](https://developer.squareup.com/reference/square_2021-08-18/objects/Invoice) to cancel.

/v2/invoices/{invoice_id}/publish

PublishInvoice

• invoice_id (path, required) — The ID of the invoice to publish.

/v2/labor/break-types

ListBreakTypes

• location_id (query) — Filter the returned `BreakType` results to only those that are associated with the specified location.
• limit (query, limit) — The maximum number of `BreakType` results to return per page. The number can range between 1 and 200. The default is 200.
• cursor (query) — A pointer to the next page of `BreakType` results to fetch.

/v2/labor/break-types

CreateBreakType

/v2/labor/break-types/{id}

DeleteBreakType

• id (path, required) — The UUID for the `BreakType` being deleted.

/v2/labor/break-types/{id}

GetBreakType

• id (path, required) — The UUID for the `BreakType` being retrieved.

/v2/labor/break-types/{id}

UpdateBreakType

• id (path, required) — The UUID for the `BreakType` being updated.

/v2/labor/employee-wages

ListEmployeeWages

• employee_id (query) — Filter the returned wages to only those that are associated with the specified employee.
• limit (query, limit) — The maximum number of `EmployeeWage` results to return per page. The number can range between 1 and 200. The default is 200.
• cursor (query) — A pointer to the next page of `EmployeeWage` results to fetch.

/v2/labor/employee-wages/{id}

GetEmployeeWage

• id (path, required) — The UUID for the `EmployeeWage` being retrieved.

/v2/labor/workweek-configs

ListWorkweekConfigs

• limit (query, limit) — The maximum number of `WorkweekConfigs` results to return per page.
• cursor (query) — A pointer to the next page of `WorkweekConfig` results to fetch.

/v2/labor/shifts

CreateShift

/v2/labor/shifts/search

SearchShifts

/v2/labor/shifts/{id}

DeleteShift

• id (path, required) — The UUID for the `Shift` being deleted.

/v2/labor/shifts/{id}

GetShift

• id (path, required) — The UUID for the `Shift` being retrieved.

/v2/labor/shifts/{id}

UpdateShift

• id (path, required) — The ID of the object being updated.

/v2/labor/team-member-wages

ListTeamMemberWages

• team_member_id (query) — Filter the returned wages to only those that are associated with the specified team member.
• limit (query, limit) — The maximum number of `TeamMemberWage` results to return per page. The number can range between 1 and 200. The default is 200.
• cursor (query) — A pointer to the next page of `EmployeeWage` results to fetch.

/v2/labor/team-member-wages/{id}

GetTeamMemberWage

• id (path, required) — The UUID for the `TeamMemberWage` being retrieved.

/v2/labor/workweek-configs/{id}

UpdateWorkweekConfig

• id (path, required) — The UUID for the `WorkweekConfig` object being updated.

/v2/locations

ListLocations

/v2/locations

CreateLocation

/v2/locations/{location_id}

RetrieveLocation

• location_id (path, required) — The ID of the location to retrieve. If you specify the string "main", then the endpoint returns the main location.

/v2/locations/{location_id}

UpdateLocation

• location_id (path, required) — The ID of the location to update.

/v2/locations/{location_id}/checkouts

CreateCheckout

• location_id (path, required) — The ID of the business location to associate the checkout with.

/v2/locations/{location_id}/transactions/{transaction_id}/refund

CreateRefund

• location_id (path, required) — The ID of the original transaction's associated location.
• transaction_id (path, required) — The ID of the original transaction that includes the tender to refund.

/v2/locations/{location_id}/transactions/{transaction_id}/void

VoidTransaction

• location_id (path, required)
• transaction_id (path, required)

/v2/locations/{location_id}/refunds

ListRefunds

• location_id (path, required) — The ID of the location to list refunds for.
• begin_time (query) — The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
• end_time (query) — The end of the requested reporting period, in RFC 3339 format. See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. Default value: The current time.
• sort_order (query) — The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.

/v2/locations/{location_id}/transactions

ListTransactions

• location_id (path, required) — The ID of the location to list transactions for.
• begin_time (query) — The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
• end_time (query) — The end of the requested reporting period, in RFC 3339 format. See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. Default value: The current time.
• sort_order (query) — The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.

/v2/locations/{location_id}/transactions

Charge

• location_id (path, required) — The ID of the location to associate the created transaction with.

/v2/locations/{location_id}/transactions/{transaction_id}

RetrieveTransaction

• location_id (path, required) — The ID of the transaction's associated location.
• transaction_id (path, required) — The ID of the transaction to retrieve.

/v2/locations/{location_id}/transactions/{transaction_id}/capture

CaptureTransaction

• location_id (path, required)
• transaction_id (path, required)

/v2/loyalty/accounts

CreateLoyaltyAccount

/v2/loyalty/accounts/search

SearchLoyaltyAccounts

/v2/loyalty/accounts/{account_id}

RetrieveLoyaltyAccount

• account_id (path, required) — The ID of the [loyalty account](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyAccount) to retrieve.

/v2/loyalty/accounts/{account_id}/accumulate

AccumulateLoyaltyPoints

• account_id (path, required) — The [loyalty account](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyAccount) ID to which to add the points.

/v2/loyalty/accounts/{account_id}/adjust

AdjustLoyaltyPoints

• account_id (path, required) — The ID of the [loyalty account](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyAccount) in which to adjust the points.

/v2/loyalty/events/search

SearchLoyaltyEvents

/v2/loyalty/programs

ListLoyaltyPrograms

/v2/loyalty/programs/{program_id}

RetrieveLoyaltyProgram

• program_id (path, required) — The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller.

/v2/loyalty/programs/{program_id}/calculate

CalculateLoyaltyPoints

• program_id (path, required) — The [loyalty program](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyProgram) ID, which defines the rules for accruing points.

/v2/loyalty/rewards

CreateLoyaltyReward

/v2/loyalty/rewards/search

SearchLoyaltyRewards

/v2/loyalty/rewards/{reward_id}

DeleteLoyaltyReward

• reward_id (path, required) — The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyReward) to delete.

/v2/loyalty/rewards/{reward_id}

RetrieveLoyaltyReward

• reward_id (path, required) — The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyReward) to retrieve.

/v2/loyalty/rewards/{reward_id}/redeem

RedeemLoyaltyReward

• reward_id (path, required) — The ID of the [loyalty reward](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyReward) to redeem.

/v2/merchants

ListMerchants

• cursor (query) — The cursor generated by the previous response.

/v2/merchants/{merchant_id}

RetrieveMerchant

• merchant_id (path, required) — The ID of the merchant to retrieve. If the string "me" is supplied as the ID, then retrieve the merchant that is currently accessible to this call.

/v2/orders

CreateOrder

/v2/orders/batch-retrieve

BatchRetrieveOrders

/v2/orders/calculate

CalculateOrder

/v2/orders/search

SearchOrders

/v2/orders/{order_id}

RetrieveOrder

• order_id (path, required) — The ID of the order to retrieve.

/v2/orders/{order_id}

UpdateOrder

• order_id (path, required) — The ID of the order to update.

/v2/orders/{order_id}/pay

PayOrder

• order_id (path, required) — The ID of the order being paid.

/v2/payments

ListPayments

• begin_time (query) — The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year.
• end_time (query) — The timestamp for the end of the reporting period, in RFC 3339 format. Default: The current time.
• sort_order (query) — The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
• location_id (query) — Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller.
• total (query) — The exact amount in the `total_money` for a payment.
• last_4 (query) — The last four digits of a payment card.
• card_brand (query) — The brand of the payment card (for example, VISA).
• limit (query, limit) — The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

/v2/payments

CreatePayment

/v2/payments/cancel

CancelPaymentByIdempotencyKey

/v2/payments/{payment_id}

GetPayment

• payment_id (path, required) — A unique ID for the desired payment.

/v2/payments/{payment_id}

UpdatePayment

• payment_id (path, required) — The ID of the payment to update.

/v2/payments/{payment_id}/cancel

CancelPayment

• payment_id (path, required) — The ID of the payment to cancel.

/v2/payments/{payment_id}/complete

CompletePayment

• payment_id (path, required) — The unique ID identifying the payment to be completed.

/v2/refunds

ListPaymentRefunds

• begin_time (query) — The timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year.
• end_time (query) — The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time.
• sort_order (query) — The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
• location_id (query) — Limit results to the location supplied. By default, results are returned for all locations associated with the seller.
• status (query) — If provided, only refunds with the given status are returned. For a list of refund status values, see [PaymentRefund](https://developer.squareup.com/reference/square_2021-08-18/objects/PaymentRefund). Default: If omitted, refunds are returned regardless of their status.
• source_type (query) — If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where `CARD` was specified as the payment source. Default: If omitted, refunds are returned regardless of the source type.
• limit (query, limit) — The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100

/v2/refunds

RefundPayment

/v2/refunds/{refund_id}

GetPaymentRefund

• refund_id (path, required) — The unique ID for the desired `PaymentRefund`.

/v2/sites

ListSites

/v2/sites/{site_id}/snippet

DeleteSnippet

• site_id (path, required) — The ID of the site that contains the snippet.

/v2/sites/{site_id}/snippet

RetrieveSnippet

• site_id (path, required) — The ID of the site that contains the snippet.

/v2/sites/{site_id}/snippet

UpsertSnippet

• site_id (path, required) — The ID of the site where you want to add or update the snippet.

/v2/subscriptions

CreateSubscription

/v2/subscriptions/search

SearchSubscriptions

/v2/subscriptions/{subscription_id}

RetrieveSubscription

• subscription_id (path, required) — The ID of the subscription to retrieve.

/v2/subscriptions/{subscription_id}

UpdateSubscription

• subscription_id (path, required) — The ID for the subscription to update.

/v2/subscriptions/{subscription_id}/cancel

CancelSubscription

• subscription_id (path, required) — The ID of the subscription to cancel.

/v2/subscriptions/{subscription_id}/events

ListSubscriptionEvents

• subscription_id (path, required) — The ID of the subscription to retrieve the events for.
• cursor (query) — A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
• limit (query, limit) — The upper limit on the number of subscription events to return in the response. Default: `200`

/v2/subscriptions/{subscription_id}/resume

ResumeSubscription

• subscription_id (path, required) — The ID of the subscription to resume.

/v2/team-members

CreateTeamMember

/v2/team-members/{team_member_id}/wage-setting

UpdateWageSetting

• team_member_id (path, required) — The ID of the team member for which to update the `WageSetting` object.

/v2/team-members/bulk-create

BulkCreateTeamMembers

/v2/team-members/bulk-update

BulkUpdateTeamMembers

/v2/team-members/search

SearchTeamMembers

/v2/team-members/{team_member_id}

RetrieveTeamMember

• team_member_id (path, required) — The ID of the team member to retrieve.

/v2/team-members/{team_member_id}

UpdateTeamMember

• team_member_id (path, required) — The ID of the team member to update.

/v2/team-members/{team_member_id}/wage-setting

RetrieveWageSetting

• team_member_id (path, required) — The ID of the team member for which to retrieve the wage setting.

/v2/terminals/checkouts

CreateTerminalCheckout

/v2/terminals/checkouts/search

SearchTerminalCheckouts

/v2/terminals/checkouts/{checkout_id}

GetTerminalCheckout

• checkout_id (path, required) — The unique ID for the desired `TerminalCheckout`.

/v2/terminals/checkouts/{checkout_id}/cancel

CancelTerminalCheckout

• checkout_id (path, required) — The unique ID for the desired `TerminalCheckout`.

/v2/terminals/refunds

CreateTerminalRefund

/v2/terminals/refunds/search

SearchTerminalRefunds

/v2/terminals/refunds/{terminal_refund_id}

GetTerminalRefund

• terminal_refund_id (path, required) — The unique ID for the desired `TerminalRefund`.

/v2/terminals/refunds/{terminal_refund_id}/cancel

CancelTerminalRefund

• terminal_refund_id (path, required) — The unique ID for the desired `TerminalRefund`.