Thomson Reuters Jurisdictions-📦 Version 1 Endpoints API

openapi: 3.2.0
info:
  title: Thomson Reuters Jurisdictions-📦 Version 1 Endpoints API
  version: '2.0'
  description: 'Operations tagged Jurisdictions-📦 Version 1 Endpoints across 2 of this provider''s published API definitions: thomson-reuters-api-documentation-for-jurisdictions-services-2-0-openapi.json, thomson-reuters-api-documentation-for-jurisdictions-services-2-0-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.onesourcetax.com/administration
  description: All V1 endpoints will be removed by Q2 2026. Please use V2
security:
- Authorization: []
tags:
- name: Jurisdictions-📦 Version 1 Endpoints
paths:
  /v1/jurisdictions:
    get:
      tags:
      - Jurisdictions-📦 Version 1 Endpoints
      summary: Retrieve a list of Jurisdictions
      description: 'Use this operation to fetch a standard list of jurisdictions in ONESOURCE. Warning: This API call may return large set of records, depending on your filter settings. Enter the type of jurisdiction to further filter the list. This endpoint will be deprecated by Q2 2026. Please start consuming the newly listed v2 endpoints for continued support and access to the latest features.'
      operationId: RetrieveAListOfJurisdictions
      parameters:
      - name: Accept-Language
        in: header
        description: Accept Language
        required: false
        schema:
          type: string
      - name: X-LoneStar-AccountId
        in: header
        description: AccountId you want to access if you are a support user
        required: false
        schema:
          type: string
      - name: clientId
        in: header
        description: Client Id of the tenant
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: The Jurisdiction type that will be searched.
        required: false
        schema:
          type: array
          items:
            type: string
        style: form
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JurisdictionSearchResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '404':
          description: Not Found
        '500':
          description: Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorV1'
      security:
      - Authorization: []
      x-operation-id-source: normalized
      x-operation-id-original: Retrieve a list of Jurisdictions
    servers:
    - url: https://api.onesourcetax.com/administration
      description: All V1 endpoints will be removed by Q2 2026. Please use V2
components:
  schemas:
    FailureDetailV1:
      type: object
      properties:
        cause:
          type: string
          description: The cause of a failure. This is used to identify what POJO field may be in error or what DB could not be reached.
        description:
          type: string
          description: A description of the failure. This is used to provide some meaningful description of the failure. The message should be considered internal and not customer facing.
        error_id:
          type: string
          description: The error identifier
        error_parameters:
          type: object
          description: The error parameter keys and values
          additionalProperties:
            type: string
        failure_type:
          type: string
          description: The general category of the type of failure.
          enum:
          - ERROR
          - WARNING
          - VALIDATION
        message:
          type: string
          description: The default message category
      description: Provides detail information about a failure.
    ErrorV1:
      type: object
      properties:
        code:
          type: string
          description: code
        message:
          type: string
          description: message
        error_count:
          type: integer
          format: int32
          description: error_count
        failures:
          type: array
          description: failures
          items:
            $ref: '#/components/schemas/FailureV1_object'
    FailureV1_object:
      type: object
      properties:
        detail_count:
          type: integer
          format: int32
          description: The number of failures that were encountered.
        details:
          type: array
          description: The collection of failures that were encountered.
          items:
            $ref: '#/components/schemas/FailureDetailV1'
        item:
          type: object
          description: The item associated with a failure. Typically this will be the POJO that encountered a failure such as a validation error.
      description: Contains information about a failure.
    ErrorV1_Jurisdiction:
      type: object
      properties:
        code:
          type: string
          description: code
        message:
          type: string
          description: message
        error_count:
          type: integer
          format: int32
          description: error_count
        failures:
          type: array
          description: failures
          items:
            $ref: '#/components/schemas/FailureV1_Jurisdiction'
    Jurisdiction:
      type: object
      properties:
        id:
          type: string
          description: The id of the Jurisdiction instance.
        three_digit_code:
          type: string
          description: The three digit code of the Jurisdiction instance.
        type:
          type: string
          description: The type of the Jurisdiction instance.
        name_local:
          type: string
          description: The name local of the Jurisdiction instance.
        two_digit_code:
          type: string
          description: The two digit code of the Jurisdiction instance.
        name:
          type: string
          description: The name short english of the Jurisdiction instance.
        located_in:
          type: string
          description: The located in of the Jurisdiction instance.
      description: The details about a Jurisdiction in the customer graph.
    FailureV1_Jurisdiction:
      type: object
      properties:
        detail_count:
          type: integer
          format: int32
          description: The number of failures that were encountered.
        details:
          type: array
          description: The collection of failures that were encountered.
          items:
            $ref: '#/components/schemas/FailureDetailV1'
        item:
          description: The item associated with a failure. Typically this will be the POJO that encountered a failure such as a validation error.
          $ref: '#/components/schemas/Jurisdiction'
      description: Contains information about a failure.
    JurisdictionSearchResponse:
      type: object
      properties:
        _meta:
          description: _meta
          $ref: '#/components/schemas/Meta'
        items:
          type: array
          description: items
          items:
            $ref: '#/components/schemas/Jurisdiction'
        error:
          description: error
          $ref: '#/components/schemas/ErrorV1_Jurisdiction'
    Meta:
      type: object
      properties:
        data_type:
          type: string
          description: data_type
        total_results:
          type: integer
          format: int32
          description: total_results
        items_count:
          type: integer
          format: int32
          description: items_count
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
x-refined-from:
- thomson-reuters-api-documentation-for-jurisdictions-services-2-0-openapi.json
- thomson-reuters-api-documentation-for-jurisdictions-services-2-0-openapi.yml
x-generator: NSwag v13.18.2.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v13.0.0.0))
x-provenance:
  method: harvested
  publisher: Thomson Reuters
  source: https://api.thomsonreuters.com/developer-experience/content/v1/documents/api-reference/0317e5fb-3a82-460e-a8f1-6fa96ee14e41
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)