Thomson Reuters Numerator Denominator Data API

openapi: 3.2.0
info:
  title: OSA OData Query Service Numerator Denominator Data API
  description: OData API for querying OSA collections including effective rates, reconciliation data, numerator/denominator data, state data, and everywhere data
  version: 1.0.0
  contact:
    name: OSA Team
    email: support@thomsonreuters.com
servers:
- url: https://api.onesourcetax.com/data-query-reporting/state-apportionment/odata/v1/
  description: AMERS endpoints
security:
- basicAuth: []
tags:
- name: Numerator Denominator Data
  description: Numerator Denominator – provides a high-level view of numerators, denominators, and apportionment percentages for every entity, group, and jurisdiction selected. Can be set to filter out entities without nexus in the selected jurisdictions.
paths:
  /odata/v1/numerator-denominator:
    get:
      summary: Query Numerator Denominator Data
      description: Retrieve numerator denominator data with OData query options
      operationId: getNumeratorDenominatorData
      parameters:
      - $ref: '#/components/parameters/FilterParam'
      - $ref: '#/components/parameters/SelectParam'
      - $ref: '#/components/parameters/OrderByParam'
      - $ref: '#/components/parameters/TopParam'
      - $ref: '#/components/parameters/SkipParam'
      - $ref: '#/components/parameters/CountParam'
      responses:
        '200':
          description: Numerator denominator data retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumeratorDenominatorDataCollection'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
      security:
      - basicAuth: []
      tags:
      - Numerator Denominator Data
components:
  parameters:
    OrderByParam:
      name: $orderby
      in: query
      description: OData orderby expression
      required: false
      schema:
        type: string
      example: year desc,jurisdiction asc
    TopParam:
      name: $top
      in: query
      description: OData top expression - maximum number of records to return
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 10000
      example: 100
    FilterParam:
      name: $filter
      in: query
      description: OData filter expression
      required: false
      schema:
        type: string
      example: year eq '2025' and jurisdiction eq 'CA'
    CountParam:
      name: $count
      in: query
      description: OData count expression - include total count in response
      required: false
      schema:
        type: boolean
      example: true
    SkipParam:
      name: $skip
      in: query
      description: OData skip expression - number of records to skip
      required: false
      schema:
        type: integer
        minimum: 0
      example: 50
    SelectParam:
      name: $select
      in: query
      description: OData select expression - comma-separated list of properties
      required: false
      schema:
        type: string
      example: ID,name,jurisdiction,year
  schemas:
    NumeratorDenominatorDataCollection:
      type: object
      properties:
        '@odata.context':
          type: string
          example: $metadata#numerator-denominator
        '@odata.count':
          type: integer
        value:
          type: array
          items:
            $ref: '#/components/schemas/NumeratorDenominatorData'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: Authentication failed
        message:
          type: string
          example: Username or password incorrect.
    NumeratorDenominatorData:
      type: object
      properties:
        ID:
          type: string
          description: Entity ID
        name:
          type: string
          description: Entity name
        fein:
          type: string
          description: Federal Employer Identification Number
        jurisdiction:
          type: string
          description: Tax jurisdiction
        type:
          type: string
          description: Entity type
        apportPercentage:
          type: number
          format: double
          description: Apportionment percentage
        propertyNum:
          type: number
          format: double
          description: Property numerator
        propertyDenom:
          type: number
          format: double
          description: Property denominator
        payrollNum:
          type: number
          format: double
          description: Payroll numerator
        payrollDenom:
          type: number
          format: double
          description: Payroll denominator
        salesNum:
          type: number
          format: double
          description: Sales numerator
        salesDenom:
          type: number
          format: double
          description: Sales denominator
        userDefinedNum:
          type: number
          format: double
          description: User defined numerator
        userDefinedDenom:
          type: number
          format: double
          description: User defined denominator
        entityGroup:
          type: string
          description: Entity group
        groupAssociation:
          type: string
          description: Group association
        year:
          type: string
          description: Tax year
        scenarioName:
          type: string
          description: Scenario name
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Basic Authentication using username and password
x-provenance:
  method: harvested
  publisher: Thomson Reuters
  source: https://api.thomsonreuters.com/developer-experience/content/v1/documents/api-reference/4c4b267e-720c-5086-a43a-a91a2c607687
  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)