generated: '2026-10-12'
method: derived
generator: derive-vocabulary.py
source:
- openapi/square-apple-pay-api-openapi.yml
- openapi/square-bank-accounts-api-openapi.yml
- openapi/square-bookingcustomattributes-api-openapi.yml
- openapi/square-bookings-api-openapi.yml
- openapi/square-cards-api-openapi.yml
vocabulary:
  name: Square Domain Vocabulary
  description: 'Terms declared by Square''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-12'
  terms:
  - term: RegisterDomainResponse
    definition: Defines the fields that are included in the response body of a request to the [RegisterDomain](api-endpoint:ApplePay-RegisterDomain)
      endpoint. Either `errors` or `status` are present in a given response (never both).
    tags:
    - Object
    source: openapi/square-apple-pay-api-openapi.yml#/components/schemas/RegisterDomainResponse
  - term: RegisterDomainResponseStatus
    definition: The status of the domain registration.
    tags:
    - Enumeration
    source: openapi/square-apple-pay-api-openapi.yml#/components/schemas/RegisterDomainResponseStatus
  - term: RegisterDomainRequest
    definition: Defines the parameters that can be included in the body of a request to the [RegisterDomain](api-endpoint:ApplePay-RegisterDomain)
      endpoint.
    tags:
    - Object
    source: openapi/square-apple-pay-api-openapi.yml#/components/schemas/RegisterDomainRequest
  - term: Error
    definition: Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors)
      for more information.
    tags:
    - Object
    source: openapi/square-apple-pay-api-openapi.yml#/components/schemas/Error
  - term: ErrorCode
    definition: Indicates the specific error that occurred during a request to a Square API.
    tags:
    - Enumeration
    source: openapi/square-apple-pay-api-openapi.yml#/components/schemas/ErrorCode
  - term: ErrorCategory
    definition: Indicates which high-level category of error has occurred during a request to the Connect API.
    tags:
    - Enumeration
    source: openapi/square-apple-pay-api-openapi.yml#/components/schemas/ErrorCategory
  - term: BankAccountType
    definition: Indicates the financial purpose of the bank account.
    tags:
    - Enumeration
    source: openapi/square-bank-accounts-api-openapi.yml#/components/schemas/BankAccountType
  - term: Country
    definition: Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).
    tags:
    - Enumeration
    source: openapi/square-bank-accounts-api-openapi.yml#/components/schemas/Country
  - term: Currency
    definition: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).
    tags:
    - Enumeration
    source: openapi/square-bank-accounts-api-openapi.yml#/components/schemas/Currency
  - term: GetBankAccountByV1IdResponse
    definition: Response object returned by GetBankAccountByV1Id.
    tags:
    - Object
    source: openapi/square-bank-accounts-api-openapi.yml#/components/schemas/GetBankAccountByV1IdResponse
  - term: ListBankAccountsResponse
    definition: Response object returned by ListBankAccounts.
    tags:
    - Object
    source: openapi/square-bank-accounts-api-openapi.yml#/components/schemas/ListBankAccountsResponse
  - term: BankAccountStatus
    definition: Indicates the current verification status of a `BankAccount` object.
    tags:
    - Enumeration
    source: openapi/square-bank-accounts-api-openapi.yml#/components/schemas/BankAccountStatus
  - term: GetBankAccountResponse
    definition: Response object returned by `GetBankAccount`.
    tags:
    - Object
    source: openapi/square-bank-accounts-api-openapi.yml#/components/schemas/GetBankAccountResponse
  - term: BankAccount
    definition: Represents a bank account. For more information about linking a bank account to a Square account, see [Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api).
    tags:
    - Object
    source: openapi/square-bank-accounts-api-openapi.yml#/components/schemas/BankAccount
  - term: ListBookingCustomAttributesResponse
    definition: Represents a [ListBookingCustomAttributes](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributes) response. Either
      `custom_attributes`, an empty object, or `errors` is present in the response. If additional results are available, the `cursor` field is
      also present along with `custom_attributes`.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/ListBookingCustomAttributesResponse
  - term: DeleteBookingCustomAttributeResponse
    definition: Represents a [DeleteBookingCustomAttribute](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttribute) response. Either
      an empty object `{}` (for a successful deletion) or `errors` is present in the response.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/DeleteBookingCustomAttributeResponse
  - term: RetrieveBookingCustomAttributeDefinitionResponse
    definition: Represents a [RetrieveBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttributeDefinition)
      response. Either `custom_attribute_definition` or `errors` is present in the response.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/RetrieveBookingCustomAttributeDefinitionResponse
  - term: ListBookingCustomAttributeDefinitionsResponse
    definition: Represents a [ListBookingCustomAttributeDefinitions](api-endpoint:BookingCustomAttributes-ListBookingCustomAttributeDefinitions)
      response. Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response. If additional results are available,
      the `cursor` field is also present along with `custom_attribute_definitions`.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/ListBookingCustomAttributeDefinitionsResponse
  - term: UpsertBookingCustomAttributeRequest
    definition: Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) request.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/UpsertBookingCustomAttributeRequest
  - term: BulkUpsertBookingCustomAttributesResponse
    definition: Represents a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) response,
      which contains a map of responses that each corresponds to an individual upsert request.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/BulkUpsertBookingCustomAttributesResponse
  - term: RetrieveBookingCustomAttributeResponse
    definition: Represents a [RetrieveBookingCustomAttribute](api-endpoint:BookingCustomAttributes-RetrieveBookingCustomAttribute) response. Either
      `custom_attribute_definition` or `errors` is present in the response.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/RetrieveBookingCustomAttributeResponse
  - term: CreateBookingCustomAttributeDefinitionRequest
    definition: Represents a [CreateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-CreateBookingCustomAttributeDefinition)
      request.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/CreateBookingCustomAttributeDefinitionRequest
  - term: BookingCustomAttributeUpsertResponse
    definition: Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes)
      operation.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/BookingCustomAttributeUpsertResponse
  - term: DeleteBookingCustomAttributeDefinitionResponse
    definition: Represents a [DeleteBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-DeleteBookingCustomAttributeDefinition)
      response containing error messages when errors occurred during the request. The successful response does not contain any payload.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/DeleteBookingCustomAttributeDefinitionResponse
  - term: CustomAttributeDefinitionVisibility
    definition: The level of permission that a seller or other applications requires to view this custom attribute definition. The `Visibility`
      field controls who can read and write the custom attribute values and custom attribute definition.
    tags:
    - Enumeration
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/CustomAttributeDefinitionVisibility
  - term: BulkDeleteBookingCustomAttributesRequest
    definition: Represents a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) request.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/BulkDeleteBookingCustomAttributesRequest
  - term: BulkUpsertBookingCustomAttributesRequest
    definition: Represents a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes) request.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/BulkUpsertBookingCustomAttributesRequest
  - term: BulkDeleteBookingCustomAttributesResponse
    definition: Represents a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes) response,
      which contains a map of responses that each corresponds to an individual delete request.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/BulkDeleteBookingCustomAttributesResponse
  - term: BookingCustomAttributeUpsertRequest
    definition: Represents an individual upsert request in a [BulkUpsertBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkUpsertBookingCustomAttributes)
      request. An individual request contains a booking ID, the custom attribute to create or update, and an optional idempotency key.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/BookingCustomAttributeUpsertRequest
  - term: UpdateBookingCustomAttributeDefinitionResponse
    definition: Represents an [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition)
      response. Either `custom_attribute_definition` or `errors` is present in the response.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/UpdateBookingCustomAttributeDefinitionResponse
  - term: BookingCustomAttributeDeleteResponse
    definition: Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes)
      operation.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/BookingCustomAttributeDeleteResponse
  - term: CreateBookingCustomAttributeDefinitionResponse
    definition: Represents a [CreateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-CreateBookingCustomAttributeDefinition)
      response. Either `custom_attribute_definition` or `errors` is present in the response.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/CreateBookingCustomAttributeDefinitionResponse
  - term: CustomAttributeDefinition
    definition: Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and
      other properties for a custom attribute.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/CustomAttributeDefinition
  - term: BookingCustomAttributeDeleteRequest
    definition: Represents an individual delete request in a [BulkDeleteBookingCustomAttributes](api-endpoint:BookingCustomAttributes-BulkDeleteBookingCustomAttributes)
      request. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/BookingCustomAttributeDeleteRequest
  - term: UpdateBookingCustomAttributeDefinitionRequest
    definition: Represents an [UpdateBookingCustomAttributeDefinition](api-endpoint:BookingCustomAttributes-UpdateBookingCustomAttributeDefinition)
      request.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/UpdateBookingCustomAttributeDefinitionRequest
  - term: UpsertBookingCustomAttributeResponse
    definition: Represents an [UpsertBookingCustomAttribute](api-endpoint:BookingCustomAttributes-UpsertBookingCustomAttribute) response. Either
      `custom_attribute_definition` or `errors` is present in the response.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/UpsertBookingCustomAttributeResponse
  - term: CustomAttribute
    definition: A custom attribute value. Each custom attribute value has a corresponding `CustomAttributeDefinition` object.
    tags:
    - Object
    source: openapi/square-bookingcustomattributes-api-openapi.yml#/components/schemas/CustomAttribute
  - term: BulkRetrieveBookingsResponse
    definition: Response payload for bulk retrieval of bookings.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BulkRetrieveBookingsResponse
  - term: ListLocationBookingProfilesResponse
    definition: 'Object declared by the contract with fields: location_booking_profiles, cursor, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/ListLocationBookingProfilesResponse
  - term: BookingBookingSource
    definition: Supported sources a booking was created from.
    tags:
    - Enumeration
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BookingBookingSource
  - term: RetrieveBusinessBookingProfileResponse
    definition: 'Object declared by the contract with fields: business_booking_profile, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/RetrieveBusinessBookingProfileResponse
  - term: BookingCreatorDetailsCreatorType
    definition: Supported types of a booking creator.
    tags:
    - Enumeration
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BookingCreatorDetailsCreatorType
  - term: BusinessAppointmentSettingsBookingLocationType
    definition: Supported types of location where service is provided.
    tags:
    - Enumeration
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BusinessAppointmentSettingsBookingLocationType
  - term: BookingStatus
    definition: Supported booking statuses.
    tags:
    - Enumeration
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BookingStatus
  - term: SearchAvailabilityResponse
    definition: 'Object declared by the contract with fields: availabilities, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/SearchAvailabilityResponse
  - term: BusinessBookingProfile
    definition: A seller's business booking profile, including booking policy, appointment settings, etc.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BusinessBookingProfile
  - term: BusinessBookingProfileBookingPolicy
    definition: Policies for accepting bookings.
    tags:
    - Enumeration
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BusinessBookingProfileBookingPolicy
  - term: BusinessAppointmentSettings
    definition: The service appointment settings, including where and how the service is provided.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BusinessAppointmentSettings
  - term: BusinessBookingProfileCustomerTimezoneChoice
    definition: Choices of customer-facing time zone used for bookings.
    tags:
    - Enumeration
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BusinessBookingProfileCustomerTimezoneChoice
  - term: SearchAvailabilityFilter
    definition: A query filter to search for buyer-accessible availabilities by.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/SearchAvailabilityFilter
  - term: SearchAvailabilityQuery
    definition: The query used to search for buyer-accessible availabilities of bookings.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/SearchAvailabilityQuery
  - term: RetrieveTeamMemberBookingProfileResponse
    definition: 'Object declared by the contract with fields: team_member_booking_profile, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/RetrieveTeamMemberBookingProfileResponse
  - term: CancelBookingRequest
    definition: 'Object declared by the contract with fields: idempotency_key, booking_version.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/CancelBookingRequest
  - term: UpdateBookingRequest
    definition: 'Object declared by the contract with fields: idempotency_key, booking.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/UpdateBookingRequest
  - term: ListBookingsResponse
    definition: 'Object declared by the contract with fields: bookings, cursor, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/ListBookingsResponse
  - term: TimeRange
    definition: Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be
      inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how
      time ranges are handled.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/TimeRange
  - term: CancelBookingResponse
    definition: 'Object declared by the contract with fields: booking, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/CancelBookingResponse
  - term: Address
    definition: Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/Address
  - term: TeamMemberBookingProfile
    definition: The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team
      member can be booked as a service provider.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/TeamMemberBookingProfile
  - term: CreateBookingResponse
    definition: 'Object declared by the contract with fields: booking, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/CreateBookingResponse
  - term: BulkRetrieveBookingsRequest
    definition: Request payload for bulk retrieval of bookings.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BulkRetrieveBookingsRequest
  - term: BusinessAppointmentSettingsAlignmentTime
    definition: Time units of a service duration for bookings.
    tags:
    - Enumeration
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BusinessAppointmentSettingsAlignmentTime
  - term: RetrieveBookingResponse
    definition: 'Object declared by the contract with fields: booking, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/RetrieveBookingResponse
  - term: LocationBookingProfile
    definition: The booking profile of a seller's location, including the location's ID and whether the location is enabled for online booking.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/LocationBookingProfile
  - term: FilterValue
    definition: A filter to select resources based on an exact field value. For any given value, the value can only be in one property. Depending
      on the field, either all properties can be set or only a subset will be available. Refer to the documentation of the field.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/FilterValue
  - term: Money
    definition: Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are
      signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose
      of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-a
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/Money
  - term: BulkRetrieveTeamMemberBookingProfilesResponse
    definition: Response payload for the [BulkRetrieveTeamMemberBookingProfiles](api-endpoint:Bookings-BulkRetrieveTeamMemberBookingProfiles)
      endpoint.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BulkRetrieveTeamMemberBookingProfilesResponse
  - term: SearchAvailabilityRequest
    definition: 'Object declared by the contract with fields: query.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/SearchAvailabilityRequest
  - term: Availability
    definition: Defines an appointment slot that encapsulates the appointment segments, location and starting time available for booking.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/Availability
  - term: UpdateBookingResponse
    definition: 'Object declared by the contract with fields: booking, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/UpdateBookingResponse
  - term: BookingCreatorDetails
    definition: Information about a booking creator.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BookingCreatorDetails
  - term: BusinessAppointmentSettingsCancellationPolicy
    definition: The category of the seller’s cancellation policy.
    tags:
    - Enumeration
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BusinessAppointmentSettingsCancellationPolicy
  - term: BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType
    definition: Types of daily appointment limits.
    tags:
    - Enumeration
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType
  - term: Booking
    definition: Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service at a given location
      to a requesting customer in one or more appointment segments.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/Booking
  - term: AppointmentSegment
    definition: Defines an appointment segment of a booking.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/AppointmentSegment
  - term: RetrieveLocationBookingProfileResponse
    definition: 'Object declared by the contract with fields: location_booking_profile, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/RetrieveLocationBookingProfileResponse
  - term: BulkRetrieveTeamMemberBookingProfilesRequest
    definition: Request payload for the [BulkRetrieveTeamMemberBookingProfiles](api-endpoint:Bookings-BulkRetrieveTeamMemberBookingProfiles) endpoint.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/BulkRetrieveTeamMemberBookingProfilesRequest
  - term: SegmentFilter
    definition: A query filter to search for buyer-accessible appointment segments by.
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/SegmentFilter
  - term: ListTeamMemberBookingProfilesResponse
    definition: 'Object declared by the contract with fields: team_member_booking_profiles, cursor, errors.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/ListTeamMemberBookingProfilesResponse
  - term: CreateBookingRequest
    definition: 'Object declared by the contract with fields: idempotency_key, booking.'
    tags:
    - Object
    source: openapi/square-bookings-api-openapi.yml#/components/schemas/CreateBookingRequest