Thomson Reuters International 5471 Schedule M (2018+) API

openapi: 3.2.0
info:
  title: ONESOURCE Income Tax Charts International 5471 Schedule M…
  description: 'Charts are used to identify Tax Return Code (TRC) and Tax Combination Code (TCC) accounts and adjustments for multiple entities and binders. Use REST APIs to automatically manipulate basic chart functions.


    The charts are related by using elements from other charts to create a set of charts. Each set of charts is then assigned to an entity to use for TRC/TCCs, accounts, and adjustments. Chart assignments are either Common or Separate.'
  termsOfService: ''
  version: v1
servers:
- url: https://api.onesourcetax.com/income-tax/charts
security:
- Authorization: []
tags:
- name: International 5471 Schedule M (2018+)
paths:
  /v1/fcoa/{chartId}/form5471-schedule-m/mapped-accounts:
    get:
      tags:
      - International 5471 Schedule M (2018+)
      summary: Returns the list of accounts mapped to Form 5471 Schedule M lines for the given…
      parameters:
      - name: chartId
        in: path
        description: 16-character chart ID, system-generated unique identifier for a chart
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Indicates the response content media type to return. application/json is currently the only option.
        required: true
        schema:
          type: string
          default: application/json
          enum:
          - application/json
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntlScheduleMMappedAccountsResponse'
              examples:
                mapped-accounts:
                  $ref: '#/components/examples/international-schedule-m-mapped-accounts'
        '400':
          description: Request failed due to validation errors.
        '401':
          description: Indicates a lack of authorization to perform this action on this resource. Check credentials and rights.
          content: {}
        '404':
          description: Not Found
          content: {}
        '500':
          description: Unexpected error occurred. Contact ONESOURCE Technical Support.
          content: {}
      operationId: getV1FcoaByChartIdForm5471ScheduleMMappedAccounts
      x-operation-id-source: derived
    patch:
      tags:
      - International 5471 Schedule M (2018+)
      summary: Adds and removes accounts mapped to Form 5471 Schedule M lines for the given…
      parameters:
      - name: chartId
        in: path
        description: 16-character chart ID, system-generated unique identifier for a chart
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Indicates the response content media type to return
        required: true
        schema:
          type: string
          default: application/json
          enum:
          - application/json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntlSchMPatchDocument'
            examples:
              international-schedule-m-patch-request:
                $ref: '#/components/examples/international-schedule-m-patch-request'
      responses:
        '200':
          description: All operations executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntlSchMPatchResponseDocument'
              examples:
                internatioanl-schedule-m-patch-success-response:
                  $ref: '#/components/examples/international-schedule-m-patch-sucess-response'
        '207':
          description: One or more operations failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntlSchMPatchResponseDocument'
              examples:
                internatioanl-schedule-m-patch-multiple-response:
                  $ref: '#/components/examples/international-schedule-m-patch-multiple-response'
        '400':
          description: Request failed due to validation errors.
        '404':
          description: Not Found
          content: {}
        '500':
          description: Unexpected error occurred. Contact ONESOURCE Technical Support.
          content: {}
      operationId: patchV1FcoaByChartIdForm5471ScheduleMMappedAccounts
      x-operation-id-source: derived
  /v1/fcoa/{chartId}/form5471-schedule-m/unmapped-accounts:
    get:
      tags:
      - International 5471 Schedule M (2018+)
      summary: Returns the list of accounts NOT mapped to Form 5471 Schedule M lines for the…
      parameters:
      - name: chartId
        in: path
        description: 16-character chart ID, system-generated unique identifier for a chart
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Indicates the response content media type to return. application/json is currently the only option.
        required: true
        schema:
          type: string
          default: application/json
          enum:
          - application/json
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntlScheduleCUnmappedAccountsResponse'
              examples:
                unmapped-accounts:
                  $ref: '#/components/examples/international-schedule-m-unmapped-accounts'
        '400':
          description: Request failed due to validation errors.
        '401':
          description: Indicates a lack of authorization to perform this action on this resource. Check credentials and rights.
          content: {}
        '404':
          description: Not Found
          content: {}
        '500':
          description: Unexpected error occurred. Contact ONESOURCE Technical Support.
          content: {}
      operationId: getV1FcoaByChartIdForm5471ScheduleMUnmappedAccounts
      x-operation-id-source: derived
components:
  schemas:
    IntlSchMPatchDocument:
      type: array
      items:
        $ref: '#/components/schemas/IntlSchMPatchModel'
    IntlSchMPatchResponse:
      type: object
      properties:
        op:
          type: string
        path:
          type: string
        value:
          type: object
          $ref: '#/components/schemas/IntlScheM'
        statusCode:
          type: integer
        fieldErrors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
        detail:
          type: string
    FieldError:
      type: object
      properties:
        fieldName:
          type: string
        messages:
          type: array
          items:
            type: string
        errorCode:
          type: integer
          format: int32
    IntlScheduleMMappedModel:
      type: object
      properties:
        form5471SchMLineNumber:
          type: string
        form5471SchMLineDescription:
          type: string
        form5471SchMFederalAccounts:
          type: array
          items:
            $ref: '#/components/schemas/IntlScheduleCUnmappedModel'
    IntlSchMPatchModel:
      type: object
      properties:
        value:
          type: object
          $ref: '#/components/schemas/IntlScheM'
        path:
          type: string
        op:
          type: string
    IntlScheM:
      type: object
      properties:
        form5471SchCLineNumber:
          type: string
        accountNumber:
          type: string
    IntlScheduleCUnmappedModel:
      type: object
      properties:
        accountId:
          type: number
        accountNumber:
          type: string
        accountDescription:
          type: string
        trcNumber:
          type: string
        trcDescription:
          type: string
        tccNumber:
          type: string
        tccDescription:
          type: string
    IntlSchMPatchResponseDocument:
      type: array
      items:
        $ref: '#/components/schemas/IntlSchMPatchResponse'
    IntlScheduleCUnmappedAccountsResponse:
      type: array
      items:
        $ref: '#/components/schemas/IntlScheduleCUnmappedModel'
    IntlScheduleMMappedAccountsResponse:
      type: array
      items:
        $ref: '#/components/schemas/IntlScheduleMMappedModel'
  examples:
    international-schedule-m-patch-multiple-response:
      value:
      - op: Add
        path: null
        value:
          form5471SchMLineNumber: 23b
          accountNumber: '10150'
        statusCode: 400
        detail: Validation Error
        fieldErrors:
        - fieldName: AccountCode
          messages:
          - Invalid Federal Account Number [10150].
          errorCode: 0
      - op: Remove
        path: null
        value:
          form5471SchMLineNumber: 23b
          accountNumber: '1015000'
        statusCode: 200
        detail: null
        fieldErrors: []
    international-schedule-m-unmapped-accounts:
      value:
      - accountId: 1811351
        accountNumber: '1020000'
        accountDescription: Other Income
        trcNumber: 10-100
        trcDescription: Cash
        tccNumber: 100
        tccDescription: Cash
      - accountId: 1811352
        accountNumber: '1021000'
        accountDescription: Other Deductions
        trcNumber: 10-100
        trcDescription: Cash
        tccNumber: 100
        tccDescription: Cash
    international-schedule-m-patch-request:
      value:
      - op: add
        path: /form5471SchMFederalAccounts
        value:
          form5471SchMLineNumber: 23b
          accountNumber: '1015000'
      - op: remove
        path: /form5471SchMFederalAccounts
        value:
          form5471SchMLineNumber: 23a
          accountNumber: '10140000'
    international-schedule-m-mapped-accounts:
      value:
      - form5471SchMLineNumber: 1a
        form5471SchMLineDescription: Gross receipts or sales
        form5471SchMFederalAccounts: []
      - form5471SchMLineNumber: 1b
        form5471SchMLineDescription: Cost of goods sold
        form5471SchMFederalAccounts:
        - accountId: 1811350
          accountNumber: '1019000'
          accountDescription: Cost of Goods Sold
          trcNumber: 10-100
          trcDescription: Cash
          tccNumber: 100
          tccDescription: Cash
    international-schedule-m-patch-sucess-response:
      value:
      - op: Add
        path: null
        value:
          form5471SchMLineNumber: 23a
          accountNumber: '10140000'
        statusCode: 200
        detail: null
        fieldErrors: []
      - op: Remove
        path: null
        value:
          form5471SchMLineNumber: 23a
          accountNumber: '10140000'
        statusCode: 200
        detail: null
        fieldErrors: []
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Thomson Reuters
  source: https://api.thomsonreuters.com/developer-experience/content/v1/documents/api-reference/346d881d-7933-5024-95c4-db58c2fbd0a6
  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)