Square Labor API

openapi: 3.2.0
info:
  version: '2.0'
  title: Square ApplePay Labor API
  description: 'Supercharge Square for sellers of every size. Our entire connected commerce platform  from elegant hardware to a rich suite of Square APIs  is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. '
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:
- name: Labor
paths:
  /v2/labor/break-types:
    get:
      tags:
      - Labor
      summary: Square List Break Types
      operationId: ListBreakTypes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a paginated list of `BreakType` instances for a business.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_READ
      parameters:
      - name: location_id
        description: 'Filter the returned `BreakType` results to only those that are associated with the

          specified location.'
        schema:
          type: string
        in: query
        required: false
      - name: limit
        description: 'The maximum number of `BreakType` results to return per page. The number can range between 1

          and 200. The default is 200.'
        schema:
          type: integer
        in: query
        required: false
      - name: cursor
        description: A pointer to the next page of `BreakType` results to fetch.
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBreakTypesResponse'
    post:
      tags:
      - Labor
      summary: Square Create Break Type
      operationId: CreateBreakType
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates a new `BreakType`.


        A `BreakType` is a template for creating `Break` objects.

        You must provide the following values in your request to this

        endpoint:


        - `location_id`

        - `break_name`

        - `expected_duration`

        - `is_paid`


        You can only have three `BreakType` instances per location. If you attempt to add a fourth

        `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of 3 breaks per location."

        is returned.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBreakTypeRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBreakTypeResponse'
  /v2/labor/break-types/{id}:
    delete:
      tags:
      - Labor
      summary: Square Delete Break Type
      operationId: DeleteBreakType
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Deletes an existing `BreakType`.


        A `BreakType` can be deleted even if it is referenced from a `Shift`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_WRITE
      parameters:
      - name: id
        description: The UUID for the `BreakType` being deleted.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBreakTypeResponse'
    get:
      tags:
      - Labor
      summary: Square Get Break Type
      operationId: GetBreakType
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a single `BreakType` specified by `id`.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_READ
      parameters:
      - name: id
        description: The UUID for the `BreakType` being retrieved.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBreakTypeResponse'
    put:
      tags:
      - Labor
      summary: Square Update Break Type
      operationId: UpdateBreakType
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Updates an existing `BreakType`.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_WRITE
        - TIMECARDS_SETTINGS_READ
      parameters:
      - name: id
        description: ' The UUID for the `BreakType` being updated.'
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBreakTypeRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBreakTypeResponse'
  /v2/labor/employee-wages:
    get:
      tags:
      - Labor
      summary: Square List Employee Wages
      operationId: ListEmployeeWages
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a paginated list of `EmployeeWage` instances for a business.
      x-release-status: DEPRECATED
      deprecated: true
      x-deprecation:
        deprecationDate: '2020-08-26'
        retirementDate: TBD
        replacedBy: ListTeamMemberWages
        guideUrl: https://developer.squareup.com/docs/labor-api/migrate-to-teams
      security:
      - oauth2:
        - EMPLOYEES_READ
      parameters:
      - name: employee_id
        description: Filter the returned wages to only those that are associated with the specified employee.
        schema:
          type: string
        in: query
        required: false
      - name: limit
        description: 'The maximum number of `EmployeeWage` results to return per page. The number can range between

          1 and 200. The default is 200.'
        schema:
          type: integer
        in: query
        required: false
      - name: cursor
        description: A pointer to the next page of `EmployeeWage` results to fetch.
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEmployeeWagesResponse'
  /v2/labor/employee-wages/{id}:
    get:
      tags:
      - Labor
      summary: Square Get Employee Wage
      operationId: GetEmployeeWage
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a single `EmployeeWage` specified by `id`.
      x-release-status: DEPRECATED
      deprecated: true
      x-deprecation:
        deprecationDate: '2020-08-26'
        retirementDate: TBD
        replacedBy: GetTeamMemberWage
        guideUrl: https://developer.squareup.com/docs/labor-api/migrate-to-teams
      security:
      - oauth2:
        - EMPLOYEES_READ
      parameters:
      - name: id
        description: The UUID for the `EmployeeWage` being retrieved.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEmployeeWageResponse'
  /v2/labor/shifts:
    post:
      tags:
      - Labor
      summary: Square Create Shift
      operationId: CreateShift
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates a new `Shift`.


        A `Shift` represents a complete workday for a single team member.

        You must provide the following values in your request to this

        endpoint:


        - `location_id`

        - `team_member_id`

        - `start_at`


        An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when:

        - The `status` of the new `Shift` is `OPEN` and the team member has another

        shift with an `OPEN` status.

        - The `start_at` date is in the future.

        - The `start_at` or `end_at` date overlaps another shift for the same team member.

        - The `Break` instances are set in the request and a break `start_at`

        is before the `Shift.start_at`, a break `end_at` is after

        the `Shift.end_at`, or both.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShiftRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShiftResponse'
  /v2/labor/shifts/search:
    post:
      tags:
      - Labor
      summary: Square Search Shifts
      operationId: SearchShifts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Returns a paginated list of `Shift` records for a business.

        The list to be returned can be filtered by:

        - Location IDs

        - Team member IDs

        - Shift status (`OPEN` or `CLOSED`)

        - Shift start

        - Shift end

        - Workday details


        The list can be sorted by:

        - `START_AT`

        - `END_AT`

        - `CREATED_AT`

        - `UPDATED_AT`'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_READ
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchShiftsRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchShiftsResponse'
  /v2/labor/shifts/{id}:
    delete:
      tags:
      - Labor
      summary: Square Delete Shift
      operationId: DeleteShift
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Deletes a `Shift`.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_WRITE
      parameters:
      - name: id
        description: The UUID for the `Shift` being deleted.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteShiftResponse'
    get:
      tags:
      - Labor
      summary: Square Get Shift
      operationId: GetShift
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a single `Shift` specified by `id`.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_READ
      parameters:
      - name: id
        description: The UUID for the `Shift` being retrieved.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetShiftResponse'
    put:
      tags:
      - Labor
      summary: Square Update Shift
      operationId: UpdateShift
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Updates an existing `Shift`.


        When adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have

        the `end_at` property set to a valid RFC-3339 datetime string.


        When closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at`

        set on each `Break`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_WRITE
        - TIMECARDS_READ
      parameters:
      - name: id
        description: The ID of the object being updated.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateShiftRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateShiftResponse'
  /v2/labor/team-member-wages:
    get:
      tags:
      - Labor
      summary: Square List Team Member Wages
      operationId: ListTeamMemberWages
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a paginated list of `TeamMemberWage` instances for a business.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_READ
      parameters:
      - name: team_member_id
        description: 'Filter the returned wages to only those that are associated with the

          specified team member.'
        schema:
          type: string
        in: query
        required: false
      - name: limit
        description: 'The maximum number of `TeamMemberWage` results to return per page. The number can range between

          1 and 200. The default is 200.'
        schema:
          type: integer
        in: query
        required: false
      - name: cursor
        description: A pointer to the next page of `EmployeeWage` results to fetch.
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTeamMemberWagesResponse'
  /v2/labor/team-member-wages/{id}:
    get:
      tags:
      - Labor
      summary: Square Get Team Member Wage
      operationId: GetTeamMemberWage
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a single `TeamMemberWage` specified by `id`.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_READ
      parameters:
      - name: id
        description: The UUID for the `TeamMemberWage` being retrieved.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamMemberWageResponse'
  /v2/labor/workweek-configs:
    get:
      tags:
      - Labor
      summary: Square List Workweek Configs
      operationId: ListWorkweekConfigs
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a list of `WorkweekConfig` instances for a business.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_READ
      parameters:
      - name: limit
        description: The maximum number of `WorkweekConfigs` results to return per page.
        schema:
          type: integer
        in: query
        required: false
      - name: cursor
        description: A pointer to the next page of `WorkweekConfig` results to fetch.
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkweekConfigsResponse'
  /v2/labor/workweek-configs/{id}:
    put:
      tags:
      - Labor
      summary: Square Update Workweek Config
      operationId: UpdateWorkweekConfig
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Updates a `WorkweekConfig`.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_WRITE
        - TIMECARDS_SETTINGS_READ
      parameters:
      - name: id
        description: The UUID for the `WorkweekConfig` object being updated.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkweekConfigRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkweekConfigResponse'
components:
  schemas:
    Currency:
      type: string
      enum:
      - UNKNOWN_CURRENCY
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYR
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LTL
      - LVL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SLE
      - SOS
      - SRD
      - SSP
      - STD
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - USS
      - UYI
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XTS
      - XXX
      - YER
      - ZAR
      - ZMK
      - ZMW
      - BTC
      - XUS
      x-enum-elements:
      - name: UNKNOWN_CURRENCY
        description: Unknown currency
      - name: AED
        description: United Arab Emirates dirham
      - name: AFN
        description: Afghan afghani
      - name: ALL
        description: Albanian lek
      - name: AMD
        description: Armenian dram
      - name: ANG
        description: Netherlands Antillean guilder
      - name: AOA
        description: Angolan kwanza
      - name: ARS
        description: Argentine peso
      - name: AUD
        description: Australian dollar
      - name: AWG
        description: Aruban florin
      - name: AZN
        description: Azerbaijani manat
      - name: BAM
        description: Bosnia and Herzegovina convertible mark
      - name: BBD
        description: Barbados dollar
      - name: BDT
        description: Bangladeshi taka
      - name: BGN
        description: Bulgarian lev
      - name: BHD
        description: Bahraini dinar
      - name: BIF
        description: Burundian franc
      - name: BMD
        description: Bermudian dollar
      - name: BND
        description: Brunei dollar
      - name: BOB
        description: Boliviano
      - name: BOV
        description: Bolivian Mvdol
      - name: BRL
        description: Brazilian real
      - name: BSD
        description: Bahamian dollar
      - name: BTN
        description: Bhutanese ngultrum
      - name: BWP
        description: Botswana pula
      - name: BYR
        description: Belarusian ruble
      - name: BZD
        description: Belize dollar
      - name: CAD
        description: Canadian dollar
      - name: CDF
        description: Congolese franc
      - name: CHE
        description: WIR Euro
      - name: CHF
        description: Swiss franc
      - name: CHW
        description: WIR Franc
      - name: CLF
        description: Unidad de Fomento
      - name: CLP
        description: Chilean peso
      - name: CNY
        description: Chinese yuan
      - name: COP
        description: Colombian peso
      - name: COU
        description: Unidad de Valor Real
      - name: CRC
        description: Costa Rican colon
      - name: CUC
        description: Cuban convertible peso
      - name: CUP
        description: Cuban peso
      - name: CVE
        description: Cape Verdean escudo
      - name: CZK
        description: Czech koruna
      - name: DJF
        description: Djiboutian franc
      - name: DKK
        description: Danish krone
      - name: DOP
        description: Dominican peso
      - name: DZD
        description: Algerian dinar
      - name: EGP
        description: Egyptian pound
      - name: ERN
        description: Eritrean nakfa
      - name: ETB
        description: Ethiopian birr
      - name: EUR
        description: Euro
      - name: FJD
        description: Fiji dollar
      - name: FKP
        description: Falkland Islands pound
      - name: GBP
        description: Pound sterling
      - name: GEL
        description: Georgian lari
      - name: GHS
        description: Ghanaian cedi
      - name: GIP
        description: Gibraltar pound
      - name: GMD
        description: Gambian dalasi
      - name: GNF
        description: Guinean franc
      - name: GTQ
        description: Guatemalan quetzal
      - name: GYD
        description: Guyanese dollar
      - name: HKD
        description: Hong Kong dollar
      - name: HNL
        description: Honduran lempira
      - name: HRK
        description: Croatian kuna
      - name: HTG
        description: Haitian gourde
      - name: HUF
        description: Hungarian forint
      - name: IDR
        description: Indonesian rupiah
      - name: ILS
        description: Israeli new shekel
      - name: INR
        description: Indian rupee
      - name: IQD
        description: Iraqi dinar
      - name: IRR
        description: Iranian rial
      - name: ISK
        description: Icelandic króna
      - name: JMD
        description: Jamaican dollar
      - name: JOD
        description: Jordanian dinar
      - name: JPY
        description: Japanese yen
      - name: KES
        description: Kenyan shilling
      - name: KGS
        description: Kyrgyzstani som
      - name: KHR
        description: Cambodian riel
      - name: KMF
        description: Comoro franc
      - name: KPW
        description: North Korean won
      - name: KRW
        description: South Korean won
      - name: KWD
        description: Kuwaiti dinar
      - name: KYD
        description: Cayman Islands dollar
      - name: KZT
        description: Kazakhstani tenge
      - name: LAK
        description: Lao kip
      - name: LBP
        description: Lebanese pound
      - name: LKR
        description: Sri Lankan rupee
      - name: LRD
        description: Liberian dollar
      - name: LSL
        description: Lesotho loti
      - name: LTL
        description: Lithuanian litas
      - name: LVL
        description: Latvian lats
      - name: LYD
        description: Libyan dinar
      - name: MAD
        description: Moroccan dirham
      - name: MDL
        description: Moldovan leu
      - name: MGA
        description: Malagasy ariary
      - name: MKD
        description: Macedonian denar
      - name: MMK
        description: Myanmar kyat
      - name: MNT
        description: Mongolian tögrög
      - name: MOP
        description: Macanese pataca
      - name: MRO
        description: Mauritanian ouguiya
      - name: MUR
        description: Mauritian rupee
      - name: MVR
        description: Maldivian rufiyaa
      - name: MWK
        description: Malawian kwacha
      - name: MXN
        description: Mexican peso
      - name: MXV
        description: Mexican Unidad de Inversion
      - name: MYR
        description: Malaysian ringgit
      - name: MZN
        description: Mozambican metical
      - name: NAD
        description: Namibian dollar
      - name: NGN
        description: Nigerian naira
      - name: NIO
        description: Nicaraguan córdoba
      - name: NOK
        description: Norwegian krone
      - name: NPR
        description: Nepalese rupee
      - name: NZD
        description: New Zealand dollar
      - name: OMR
        description: Omani rial
      - name: PAB
        description: Panamanian balboa
      - name: PEN
        description: Peruvian sol
      - name: PGK
        description: Papua New Guinean kina
      - name: PHP
        description: Philippine peso
      - name: PKR
        description: Pakistani rupee
      - name: PLN
        description: Polish zBoty
      - name: PYG
        description: Paraguayan guaraní
      - name: QAR
        description: Qatari riyal
      - name: RON
        description: Romanian leu
      - name: RSD
        description: Serbian dinar
      - name: RUB
        description: Russian ruble
      - name: RWF
        description: Rwandan franc
      - name: SAR
        description: Saudi riyal
      - name: SBD
        description: Solomon Islands dollar
      - name: SCR
        description: Seychelles rupee
      - name: SDG
        description: Sudanese pound
      - name: SEK
        description: Swedish krona
      - name: SGD
        description: Singapore dollar
      - name: SHP
        description: Saint Helena pound
      - name: SLL
        description: Sierra Leonean first leone
      - name: SLE
        description: Sierra Leonean second leone
      - name: SOS
        description: Somali shilling
      - name: SRD
        description: Surinamese dollar
      - name: SSP
        description: South Sudanese pound
      - name: STD
        description: São Tomé and Príncipe dobra
      - name: SVC
        description: Salvadoran colón
      - name: SYP
        description: Syrian pound
      - name: SZL
        description: Swazi lilangeni
      - name: THB
        description: Thai baht
      - name: TJS
        description: Tajikstani somoni
      - name: TMT
        description: Turkmenistan manat
      - name: TND
        description: Tunisian dinar
      - name: TOP
        description: Tongan pa'anga
      - name: TRY
        description: Turkish lira
      - name: TTD
        description: Trinidad and Tobago dollar
      - name: TWD
        description: New Taiwan dollar
      - name: TZS
        description: Tanzanian shilling
      - name: UAH
        description: Ukrainian hryvnia
      - name: UGX
        description: Ugandan shilling
      - name: USD
        description: United States dollar
      - name: USN
        description: United States dollar (next day)
      - name: USS
        description: United States dollar (same day)
      - name: UYI
        description: Uruguay Peso en Unidedades Indexadas
      - name: UYU
        description: Uruguyan peso
      - name: UZS
        description: Uzbekistan som
      - name: VEF
        description: Venezuelan bolívar soberano
      - name: VND
        description: Vietnamese ’Óng
      - name: VUV
        description: Vanuatu vatu
      - name: WST
        description: Samoan tala
      - name: XAF
        description: CFA franc BEAC
      - name: XAG
        description: Silver
      - name: XAU
        description: Gold
      - name: XBA
        description: European Composite Unit
      - name: XBB
        description: European Monetary Unit
      - name: XBC
        description: European Unit of Account 9
      - name: XBD
        description: European Unit of Account 17
      - name: XCD
        description: East Caribbean dollar
      - name: XDR
        description: Special drawing rights (International Monetary Fund)
      - name: XOF
        description: CFA franc BCEAO
      - name: XPD
        description: Palladium
      - name: XPF
        description: CFP franc
      - name: XPT
        description: Platinum
     

# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-labor-api-openapi.yml