openapi: 3.2.0
info:
  contact:
    name: Lavanya Appa
    email: LAVANYA.APPA@ADP.COM
  description: The ADP Workforce Now U.S. Tax Withholdings Application Programming Interface (API) enables users to add or change a worker's state tax withholding information. For more information refer U.S. State Tax Withholdings Guide for ADP Workforce Now.
  title: US Tax Profiles US State Tax Profile - Add State Income Tax…
  version: 2.0.2
  x-apievangelist-source: https://api-library-marketplace.adp.com/hcm-offrg-wfn/payroll/us-tax-profiles/v2/us-tax-profiles-swagger_v2-merged.json
  x-apievangelist-product: ADP Workforce Now (hcm-offrg-wfn)
  x-apievangelist-resource-path: payroll/us-tax-profiles/v2/us-tax-profiles
servers:
- url: https://api.adp.com
  description: 'ADP production API gateway (mutual-TLS). Source: https://developers.adp.com/getting-started/key-concepts/access-tokens'
- url: https://api.eu.adp.com
  description: ADP European API gateway
- url: https://uat-api.adp.com
  description: ADP UAT / sandbox gateway
tags:
- name: US State Tax Profile - Add State Income Tax Instruction
  description: APIs to manage the addition of a US tax profile state income tax instruction
paths:
  /events/payroll/v2/us-tax-profile.state-income-tax-instruction.add:
    x-adpPathData:
      uriTranslationIndicator: false
      featureCode: payrollInstructionManagement
      functionCode: taxProfileManagement
      serviceCode: payrollManagement
      serviceCategoryCode: payroll
      canonicalName: Add US Tax Profile State Income Tax Instruction
    post:
      summary: US State Tax Profile - Add State Income Tax Instruction
      x-adpOperationData:
        operationStateCode: active
        grantTypes:
        - authorization_code
        - urn:ietf:params:oauth:grant-type:saml2-bearer
        - urn:ietf:params:oauth:grant-type:jwt-bearer
        - client_credential
        asaFeatureCodes:
        - MobileESSUSTaxProfiles
        - MobilePSSUSTaxProfiles
        sorRequestTimeoutPolicies:
          cachedTimeout: 3
          notCachedTimeout: 10
        canonicalUri: payroll/payrollManagement/payrollInstructionManagement/taxProfileManagement/usTaxProfileStateIncomeTaxInstruction.add
        operationCode: usTaxProfileStateIncomeTaxInstruction.add
        operationId: e9e17835-005b-4555-91e7-e5f03838cb9c
        performAuthIndicator: true
        roleCodes:
        - employee
        - practitioner
        scenarios:
        - summary: Adding New Jersey as the <strong>workedIn</strong> state.
          name: 15. Add New Jersey as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding New Jersey as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/15._Add_New_Jersey_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494580.json
          description: Adding New Jersey as the <strong>workedIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/15._Add_New_Jersey_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46024.json
        - summary: <span>Adding California as the&nbsp;</span><strong>workedIn</strong><span>&nbsp;state.</span>
          name: 01.Add California as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Successful response when adding California as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/01.Add_California_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494566.json
          description: <span>Adding California as the&nbsp;</span><strong>workedIn</strong><span>&nbsp;state.</span>
          content:
            application/json:
              externalValue: ./examples/01.Add_California_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46010.json
        - summary: Adding Massachusetts as the <strong>live</strong><strong>dIn</strong> state.
          name: 20. Add Massachusetts as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Massachusetts as the livedIn state.
            content:
              application/json:
                externalValue: ./examples/20._Add_Massachusetts_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494585.json
          description: Adding Massachusetts as the <strong>live</strong><strong>dIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/20._Add_Massachusetts_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46029.json
        - summary: <span>Adding California as the Lived</span><strong>In</strong><span>&nbsp;state.</span>
          name: 02. Add California as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Successful response when adding California as the LivedIn state.
            content:
              application/json:
                externalValue: ./examples/02._Add_California_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494567.json
          description: <span>Adding California as the Lived</span><strong>In</strong><span>&nbsp;state.</span>
          content:
            application/json:
              externalValue: ./examples/02._Add_California_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46011.json
        - summary: Adding Massachusetts as the <strong>workedIn</strong> state.
          name: 19. Add Massachusetts as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Massachusetts as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/19._Add_Massachusetts_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494584.json
          description: Adding Massachusetts as the <strong>workedIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/19._Add_Massachusetts_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46028.json
        - summary: Add Illinois as the <strong>workedIn</strong> state.
          name: 07. Add Illinois as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of adding Illinois as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/07._Add_Illinois_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494572.json
          description: Add Illinois as the <strong>workedIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/07._Add_Illinois_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46016.json
        - summary: Adding Michigan as the <strong>livedIn</strong> state.
          name: 22. Add Michigan as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Michigan as the livedIn state.
            content:
              application/json:
                externalValue: ./examples/22._Add_Michigan_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494587.json
          description: Adding Michigan as the <strong>livedIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/22._Add_Michigan_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46031.json
        - summary: <span>Adding NewYork as the&nbsp;</span><strong>workedIn</strong><span>&nbsp;state.</span>
          name: 05. Add NewYork as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding NewYork as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/05._Add_NewYork_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494570.json
          description: <span>Adding NewYork as the&nbsp;</span><strong>workedIn</strong><span>&nbsp;state.</span>
          content:
            application/json:
              externalValue: ./examples/05._Add_NewYork_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46014.json
        - summary: Adding Virginia as the <strong>live</strong><strong>dIn</strong> state.
          name: 18. Add Virginia as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Virginia as the livedIn state.
            content:
              application/json:
                externalValue: ./examples/18._Add_Virginia_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494583.json
          description: Adding Virginia as the <strong>live</strong><strong>dIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/18._Add_Virginia_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46027.json
        - summary: Adding Invalid state code
          name: 03. Add Invalid state code
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '400'
            description: Unsuccessful response of adding invalid state code
            content:
              application/json:
                externalValue: ./examples/03._Add_Invalid_state_code_Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_400_494568.json
          description: Adding Invalid state code
          content:
            application/json:
              externalValue: ./examples/03._Add_Invalid_state_code_Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46012.json
        - summary: Adding NewYork as the <strong>live</strong><strong>dIn</strong> state.
          name: 06. Add NewYork as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding NewYork as the livedIn state.
            content:
              application/json:
                externalValue: ./examples/06._Add_NewYork_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494571.json
          description: Adding NewYork as the <strong>live</strong><strong>dIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/06._Add_NewYork_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46015.json
        - summary: Add Illinois as the <strong>live</strong><strong>dIn</strong> state.
          name: 08. Add Illinois as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Illinois as the livedIn state.
            content:
              application/json:
                externalValue: ./examples/08._Add_Illinois_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494573.json
          description: Add Illinois as the <strong>live</strong><strong>dIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/08._Add_Illinois_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46017.json
        - summary: Adding invalid itemid
          name: 04. Add invalid itemID
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '400'
            description: Unsuccessful response of adding invalid itemId
            content:
              application/json:
                externalValue: ./examples/04._Add_invalid_itemID_Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_400_494569.json
          description: Adding invalid itemid
          content:
            application/json:
              externalValue: ./examples/04._Add_invalid_itemID_Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46013.json
        - summary: Adding North Carolina as the <strong>workedIn</strong> state.
          name: 13. Add North Carolina as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding North Carolina as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/13._Add_North_Carolina_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494578.json
          description: Adding North Carolina as the <strong>workedIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/13._Add_North_Carolina_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46022.json
        - summary: <span>Adding Ohio as the&nbsp;</span><strong>workedIn</strong><span>&nbsp;state.</span>
          name: 09. Add Ohio as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Ohio as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/09._Add_Ohio_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494574.json
          description: <span>Adding Ohio as the&nbsp;</span><strong>workedIn</strong><span>&nbsp;state.</span>
          content:
            application/json:
              externalValue: ./examples/09._Add_Ohio_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46018.json
        - summary: Adding Michigan as the <strong>workedIn</strong> state.
          name: 21.Add Michigan as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Michigan as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/21.Add_Michigan_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494586.json
          description: Adding Michigan as the <strong>workedIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/21.Add_Michigan_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46030.json
        - summary: Adding North Carolina as the <strong>live</strong><strong>dIn</strong> state.
          name: 14. Add North Carolina as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding North Carolina as the livedIn state.
            content:
              application/json:
                externalValue: ./examples/14._Add_North_Carolina_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494579.json
          description: Adding North Carolina as the <strong>live</strong><strong>dIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/14._Add_North_Carolina_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46023.json
        - summary: New description scenario for the consumer of this API to better understand this example.
          name: 12. Add Georgia as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Georgia as the livedIn state.
            content:
              application/json:
                externalValue: ./examples/12._Add_Georgia_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494577.json
          description: New description scenario for the consumer of this API to better understand this example.
          content:
            application/json:
              externalValue: ./examples/12._Add_Georgia_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46021.json
        - summary: Add any state as livedin and workedin.
          name: 23. Add any state as livedin and workedin.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding any state as livedin and workedin.
            content:
              application/json:
                externalValue: ./examples/23._Add_any_state_as_livedin_and_workedin._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494595.json
          description: Add any state as livedin and workedin.
          content:
            application/json:
              externalValue: ./examples/23._Add_any_state_as_livedin_and_workedin._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46036.json
        - summary: Adding Virginia as the <strong>workedIn</strong> state.
          name: 17. Add Virginia as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Virginia as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/17._Add_Virginia_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494582.json
          description: Adding Virginia as the <strong>workedIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/17._Add_Virginia_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46026.json
        - summary: Adding Ohio as the <strong>live</strong><strong>dIn</strong> state.
          name: 10. Add Ohio as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Ohio as the livedIn state.
            content:
              application/json:
                externalValue: ./examples/10._Add_Ohio_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494575.json
          description: Adding Ohio as the <strong>live</strong><strong>dIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/10._Add_Ohio_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46019.json
        - summary: Adding Georgia as the <strong>workedIn</strong> state.
          name: 11. Add Georgia as the workedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding Georgia as the workedIn state.
            content:
              application/json:
                externalValue: ./examples/11._Add_Georgia_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494576.json
          description: Adding Georgia as the <strong>workedIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/11._Add_Georgia_as_the_workedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46020.json
        - summary: Adding New Jersey as the <strong>live</strong><strong>dIn</strong> state.
          name: 16. Adding New Jersey as the livedIn state.
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Response of Adding New Jersey as the livedIn state.
            content:
              application/json:
                externalValue: ./examples/16._Adding_New_Jersey_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494581.json
          description: Adding New Jersey as the <strong>live</strong><strong>dIn</strong> state.
          content:
            application/json:
              externalValue: ./examples/16._Adding_New_Jersey_as_the_livedIn_state._Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_request_46025.json
        visibilityCodes:
        - internal
        - external
        globalViewDevPortalIndicator: true
      requestBody:
        description: posted contents
        content:
          application/json:
            schema:
              $ref: ./schemas/events_payroll.worker.usTaxProfile.stateIncomeTaxInstruction.add_schema_v02_00_rev001.json
        required: true
      responses:
        '200':
          headers:
            ADP-Acting-Session-Expires:
              schema:
                type: string
              description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
            Cache-Control:
              schema:
                type: string
              description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
              x-adpParameterData:
                visibilityCodes:
                - internal
                - external
              required: false
            sm_transactionid:
              schema:
                type: string
              description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
            ETag:
              schema:
                type: string
              description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
              x-adpParameterData:
                visibilityCodes:
                - internal
                - external
              required: false
            ADP-Acting-SessionID:
              schema:
                type: string
              description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
            Content-Type:
              schema:
                type: string
              description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
              x-adpParameterData:
                visibilityCodes:
                - internal
                - external
              required: false
          description: Add a new US tax profile state income tax instruction
          content:
            application/json:
              schema:
                $ref: ./schemas/events_payroll.worker.usTaxProfile.stateIncomeTaxInstruction.add_schema_v02_00_rev001.json
        '201':
          description: accepted
          content:
            application/json: {}
        '400':
          $ref: '#/components/responses/400'
        '500':
          $ref: '#/components/responses/500'
        '401':
          $ref: '#/components/responses/401'
        '412':
          $ref: '#/components/responses/412'
        '403':
          $ref: '#/components/responses/403'
        '503':
          $ref: '#/components/responses/503'
        '405':
          $ref: '#/components/responses/405'
        '504':
          $ref: '#/components/responses/504'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      description: Add a new US tax profile state income tax instruction
      operationId: e9e17835-005b-4555-91e7-e5f03838cb9c
      parameters:
      - schema:
          default: ''
          type: string
        in: header
        name: ConsumerAppOID
        description: Identifier for the service consumer application.  This header is required, if the actor (Service Consumer) is an application or the actor is internal to ADP
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: SOR
        description: SOR where the call is routed to - usuall injected by the API proxy, with few exceptions
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: orgoid
        description: Organization OID of the requestor as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Act-As-AssociateOID
        description: Associate OID of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: employee
          type: string
          enum:
          - employee
          - ' manager'
          - ' practitioner'
          - ' administrator'
          - ' supervisor'
        in: header
        name: roleCode
        description: 'The role the user is playing during the transaction.  Possible values: employee,manager,practitioner,administrator,supervisor.  The roleCode header should be passed in all calls.'
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: true
      - schema:
          default: en-US
          type: string
        in: header
        name: Accept-Language
        description: 'Accept-Language'' '': '' ( language | ''*'' ) ['';'' ''q'' ''=''qvalue]. Specifies the language(s) that are acceptable for the response. The optional qvalue represents a quality level for acceptable languages.'
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Act-As-OrgOID
        description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: Authorization
        description: Provides the client's authorization token to access the resource representation at a URI
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: SORContext
        description: Context within an SOR that the call should be routed to
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Acting-SessionID
        description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: G4O73G9Z62SL2NFM
          type: string
        in: header
        name: associateoid
        description: Associate OID of the requestor as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: sm_user
        description: 'SiteMinder user ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_user: JJohns@Abc'
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Consumer-ApplicationID
        description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: sm_userdn
        description: 'SiteMinder user LDAP distinguished name.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_userdn: uid=JJohns@Abc,ou=Users,o=Abc'
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-On-Behalf-Of-AssociateOID
        description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: sm_auth_level
        description: 'SiteMinder autorization level.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_auth_level: 10'
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: sm_transactionid
        description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: sm_serversessionid
        description: 'SiteMinder session ID.   Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_serversessionid: SoFpy8UMyhtXY6YsEumvXJbznFA='
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-On-Behalf-Of-OrgOID
        description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: SORUri
        description: Actual Uri within the SOR
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Context-ExpressionID
        description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ISI
          type: string
        in: header
        name: realm
        description: The identity management realm, e.g. ISI
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      tags:
      - US State Tax Profile - Add State Income Tax Instruction
  /events/payroll/v2/us-tax-profile.state-income-tax-instruction.add/meta:
    x-adpPathData:
      uriTranslationIndicator: false
      featureCode: payrollInstructionManagement
      functionCode: taxProfileManagement
      serviceCode: payrollManagement
      serviceCategoryCode: payroll
      canonicalName: Add US Tax Profile State Income Tax Instruction
    get:
      summary: US State Tax Profile - Add State Income Tax Instruction Meta
      x-adpOperationData:
        operationStateCode: active
        grantTypes:
        - authorization_code
        - urn:ietf:params:oauth:grant-type:saml2-bearer
        - urn:ietf:params:oauth:grant-type:jwt-bearer
        - client_credential
        asaFeatureCodes:
        - MobileESSUSTaxProfiles
        - MobilePSSUSTaxProfiles
        sorRequestTimeoutPolicies:
          cachedTimeout: 3
          notCachedTimeout: 10
        canonicalUri: payroll/payrollManagement/payrollInstructionManagement/taxProfileManagement/usTaxProfileStateIncomeTaxInstruction.add
        operationCode: usTaxProfileStateIncomeTaxInstruction.add
        operationId: 62fc3ab7-fa4d-49d2-9fd9-07c3a0f9f9db
        performAuthIndicator: true
        roleCodes:
        - employee
        - practitioner
        scenarios:
        - summary: <p>Retrieving state income tax instruction add API meta. We can use below filter criteria to fetch meta response.</p><p><span data-offset-key="bf6ve-1-0"><span data-text="true">/events/payroll/v2/us-tax-profile.state-income-tax-instruction.add/meta?pfid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="bf6ve-2-0"><span data-text="true">{{pfID}}</span></span></span></p><p><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="bf6ve-2-0"><span data-text="true"><span data-offset-key="4j1gm-1-0"><span data-text="true">/events/payroll/v2/us-tax-profile.state-income-tax-instruction.add/meta?pfid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="4j1gm-2-0"><span data-text="true">{{pfID}}</span></span></span><span data-offset-key="4j1gm-3-0"><span data-text="true">&amp;aoid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="4j1gm-4-0"><span data-text="true">{{employeeAOID}}</span></span></span></span></span></span></p><p><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="bf6ve-2-0"><span data-text="true"><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="4j1gm-4-0"><span data-text="true"><span data-offset-key="6keoe-1-0"><span data-text="true">/events/payroll/v2/us-tax-profile.state-income-tax-instruction.add/meta?pfid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="6keoe-2-0"><span data-text="true">{{pfID}}</span></span></span><span data-offset-key="6keoe-3-0"><span data-text="true">&amp;state=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="6keoe-4-0"><span data-text="true">{{stateCode}}</span></span></span></span></span></span></span></span></span></p><p><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="bf6ve-2-0"><span data-text="true"><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="4j1gm-4-0"><span data-text="true"><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="6keoe-4-0"><span data-text="true"><span data-offset-key="984qh-1-0"><span data-text="true">/events/payroll/v2/us-tax-profile.state-income-tax-instruction.add/meta?pfid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="984qh-2-0"><span data-text="true">{{pfID}}</span></span></span><span data-offset-key="984qh-3-0"><span data-text="true">&amp;aoid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="984qh-4-0"><span data-text="true">{{employeeAOID}}</span></span></span><span data-offset-key="984qh-5-0"><span data-text="true">&amp;state=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="984qh-6-0"><span data-text="true">{{stateCode}}</span></span></span></span></span></span></span></span></span></span></span></span></p>
          name: 01. Retrieving state income tax instruction add API meta
          responses:
          - headers:
              ADP-Acting-Session-Expires: unset
              Cache-Control: unset
              sm_transactionid: unset
              ETag: unset
              ADP-Acting-SessionID: unset
              Content-Type: unset
            code: '200'
            description: Returns state income tax instruction add API meta.
            content:
              application/json:
                externalValue: ./examples/01._Retrieving_state_income_tax_instruction_add_API_meta_Custom_Example_usTaxProfileStateIncomeTaxInstruction.add_200_494588.json
          description: <p>Retrieving state income tax instruction add API meta. We can use below filter criteria to fetch meta response.</p><p><span data-offset-key="bf6ve-1-0"><span data-text="true">/events/payroll/v2/us-tax-profile.state-income-tax-instruction.add/meta?pfid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="bf6ve-2-0"><span data-text="true">{{pfID}}</span></span></span></p><p><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="bf6ve-2-0"><span data-text="true"><span data-offset-key="4j1gm-1-0"><span data-text="true">/events/payroll/v2/us-tax-profile.state-income-tax-instruction.add/meta?pfid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="4j1gm-2-0"><span data-text="true">{{pfID}}</span></span></span><span data-offset-key="4j1gm-3-0"><span data-text="true">&amp;aoid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="4j1gm-4-0"><span data-text="true">{{employeeAOID}}</span></span></span></span></span></span></p><p><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="bf6ve-2-0"><span data-text="true"><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="4j1gm-4-0"><span data-text="true"><span data-offset-key="6keoe-1-0"><span data-text="true">/events/payroll/v2/us-tax-profile.state-income-tax-instruction.add/meta?pfid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="6keoe-2-0"><span data-text="true">{{pfID}}</span></span></span><span data-offset-key="6keoe-3-0"><span data-text="true">&amp;state=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="6keoe-4-0"><span data-text="true">{{stateCode}}</span></span></span></span></span></span></span></span></span></p><p><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="bf6ve-2-0"><span data-text="true"><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="4j1gm-4-0"><span data-text="true"><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="6keoe-4-0"><span data-text="true"><span data-offset-key="984qh-1-0"><span data-text="true">/events/payroll/v2/us-tax-profile.state-income-tax-instruction.add/meta?pfid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="984qh-2-0"><span data-text="true">{{pfID}}</span></span></span><span data-offset-key="984qh-3-0"><span data-text="true">&amp;aoid=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="984qh-4-0"><span data-text="true">{{employeeAOID}}</span></span></span><span data-offset-key="984qh-5-0"><span data-text="true">&amp;state=</span></span><span data-testid="resolvedVariable" spellcheck="false"><span data-offset-key="984qh-6-0"><span data-text="true">{{stateCode}}</span></span></span></span></span></span></span></span></span></span></span></span></p>
        visibilityCodes:
        - internal
        - external
        globalViewDevPortalIndicator: true
      responses:
        '200':
          headers:
            ADP-Acting-Session-Expires:
              schema:
                type: string
              description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
            Cache-Control:
              schema:
                type: string
              description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
              x-adpParameterData:
                visibilityCodes:
                - internal
                - external
              required: false
            sm_transactionid:
              schema:
                type: string
              description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
            ETag:
              schema:
                type: string
              description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
              x-adpParameterData:
                visibilityCodes:
                - internal
                - external
              required: false
            ADP-Acting-SessionID:
              schema:
                type: string
              description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
            Content-Type:
              schema:
                type: string
              description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
              x-adpParameterData:
                visibilityCodes:
                - internal
                - external
              required: false
          description: Returns an event metadata
          content:
            application/json:
              schema:
                $ref: ./schemas/events_payroll.worker.usTaxProfile.stateIncomeTaxInstruction.add_meta_schema_v02_00_rev001.json
        '400':
          $ref: '#/components/responses/400'
        '412':
          $ref: '#/components/responses/412'
        '500':
          $ref: '#/components/responses/500'
        '401':
          $ref: '#/components/responses/401'
        '413':
          $ref: '#/components/responses/413'
        '403':
          $ref: '#/components/responses/403'
        '304':
          $ref: '#/components/responses/304'
        '503':
          $ref: '#/components/responses/503'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '504':
          $ref: '#/components/responses/504'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      description: Returns an event metadata
      operationId: 62fc3ab7-fa4d-49d2-9fd9-07c3a0f9f9db
      parameters:
      - schema:
          default: ''
          type: string
        in: header
        name: ConsumerAppOID
        description: Identifier for the service consumer application.  This header is required, if the actor (Service Consumer) is an application or the actor is internal to ADP
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: SOR
        description: SOR where the call is routed to - usuall injected by the API proxy, with few exceptions
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: orgoid
        description: Organization OID of the requestor as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Act-As-AssociateOID
        description: Associate OID of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: query
        name: $filter
        description: The OData $filter parameter MUST be used to specify the filter criterion.  Please refer RESTful Web API Design Standard document for this query parameter specification details.
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: false
      - schema:
          default: employee
          type: string
          enum:
          - employee
          - ' manager'
          - ' practitioner'
          - ' administrator'
          - ' supervisor'
        in: header
        name: roleCode
        description: 'The role the user is playing during the transaction.  Possible values: employee,manager,practitioner,administrator,supervisor.  The roleCode header should be passed in all calls.'
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: true
      - schema:
          default: en-US
          type: string
        in: header
        name: Accept-Language
        description: 'Accept-Language'' '': '' ( language | ''*'' ) ['';'' ''q'' ''=''qvalue]. Specifies the language(s) that are acceptable for the response. The optional qvalue represents a quality level for acceptable languages.'
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Act-As-OrgOID
        description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: Authorization
        description: Provides the client's authorization token to access the resource representation at a URI
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: SORContext
        description: Context within an SOR that the call should be routed to
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Acting-SessionID
        description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: G4O73G9Z62SL2NFM
          type: string
        in: header
        name: associateoid
        description: Associate OID of the requestor as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: sm_user
        description: 'SiteMinder user ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_user: JJohns@Abc'
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Consumer-ApplicationID
        description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: sm_userdn
        description: 'SiteMinder user LDAP distinguished name.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_userdn: uid=JJohns@Abc,ou=Users,o=Abc'
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-On-Behalf-Of-AssociateOID
        description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: sm_auth_level
        description: 'SiteMinder autorization level.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_auth_level: 10'
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: sm_transactionid
        description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: sm_serversessionid
        description: 'SiteMinder session ID.   Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_serversessionid: SoFpy8UMyhtXY6YsEumvXJbznFA='
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-On-Behalf-Of-OrgOID
        description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: SORUri
        description: Actual Uri within the SOR
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Context-ExpressionID
        description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ISI
          type: string
        in: header
        name: realm
        description: The identity management realm, e.g. ISI
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      tags:
      - US State Tax Profile - Add State Income Tax Instruction
components:
  responses:
    '429':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '406':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Not Acceptable
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '403':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '405':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Method Not Allowed
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '500':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '404':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Not Found
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '304':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Not Modified
    '400':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '503':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Service Unavailable
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '412':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Precondition Failed
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '504':
      description: Gateway Timeout
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
    '413':
      headers:
        ADP-Acting-Session-Expires:
          schema:
            type: string
          description: Specifies the date and time the representational state of the resource is considered stale in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Cache-Control:
          schema:
            type: string
          description: Specifies directives that must be obeyed by all caching mechanisms along the request/response chain.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        sm_transactionid:
          schema:
            type: string
          description: 'SiteMinder transaction ID.  Required for requests where conversation was initiated from a service consumer, external to ADP, and that consumer was authenticated by SMS. Example - sm_transactionid: 1aaf14ac-7083-54c0186f-4680c940-82b33ca3'
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        ETag:
          schema:
            type: string
          description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
        ADP-Acting-SessionID:
          schema:
            type: string
          description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Content-Type:
          schema:
            type: string
          description: 'Content-Type'' '': '' type ''/'' subtype. Describes the media type and subtype of an entity-body.'
          x-adpParameterData:
            visibilityCodes:
            - internal
            - external
          required: false
      description: Request Entity Too Large
      content:
        application/json:
          schema:
            $ref: ../../../common/responses/v1/schemas/confirmMessage_schema_v01_00_rev008.json
x-adpSpecData:
  domain: Payroll
  specId: 1b535108-b9c3-4479-83e0-f716cf05bdb9
  canonicalSpecId: 7e5e38e8-bf27-4b0f-bff4-a2e53f849ea4
  specStatusCode: publishing
  specTypeCode: REST
  specStateCode: active
  nonStandardIndicator: false
  visibilityCodes:
  - internal
  - external
  filename: us-tax-profiles-swagger_v2-merged.json
  serviceProviderId: WFN
  resourcePath: payroll/us-tax-profiles/v2
  libraryVersion: ''
  businessRules:
  - rule: R5.0
    ruleTitle: Meta returns the context rules for each data section
    visibilityCodes:
    - internal
  - rule: R2.0
    ruleTitle: creationDateTime is the date that the event is created.  If a System of Record creates the event instance then it sets the creationDateTime.
    visibilityCodes:
    - internal
  - rule: R3.3
    ruleTitle: /data/output communicates the result of the event instance.
    visibilityCodes:
    - internal
  - rule: R11.1
    ruleTitle: '''associateoid'' in the uri pattern should match the ''associateoid'' in the request header parameter'
    visibilityCodes:
    - internal
  - rule: R3.1
    ruleTitle: /data/input is optional.  Input communicates data that is needed to complete recording the event instance.  An example is a benefits.enroll event.  The input communicates the benefitOfferings (the choices) that the user has to make which are communicated in the transform.
    visibilityCodes:
    - internal
  - rule: R6.1
    ruleTitle: An event instance which is being 'worked on' has an event.status.code=inprogress
    visibilityCodes:
    - internal
  - rule: R15.1
    ruleTitle: 'An SOR may return an HTTP 503 when they are down for a scheduled maintenance or for an outage.If an SOR is planning a maintenance window then they should plan on having an end point available to return the 503 with a standard confirmMessage.  The confirmMessage will contain a message stating the date and timeframe that the maintenance window is for.The SOR should return the Retry-After response-header field with the Date and Time when they expect the system to be available.  E.g. Retry-After: Fri, 31 Dec 1999 23:59:59 GMT  This does not need to be handled dynamically.  They can set the time that their maintenance window ends.'
    visibilityCodes:
    - internal
  - rule: R5.1
    ruleTitle: The only information that must be valued in the meta for the events header are the standard codelist references for priorityCode, eventStatusCode, and serviceCategoryCode
    visibilityCodes:
    - internal
  - rule: R2.4
    ruleTitle: If there is no effective date from a business perspective then the effective date should be set equal to the record date time.
    visibilityCodes:
    - internal
  - rule: R3.0
    ruleTitle: /data/schemaContext communicates the keys and properties that relate the event instance to a concrete concept (e.g. associate).
    visibilityCodes:
    - internal
  - rule: R0.2
    ruleTitle: If request contains ADP-On-Behalf-Of-OrgOID, ADP-On-Behalf-Of-AssociateOID and ADP-Acting-SessionID header values, SOR MUST use ADP-On-Behalf-Of-AssociateOID header value to authorize the data requested, NOT associateoid header value to authorize the data.
    visibilityCodes:
    - internal
  - rule: R2.2
    ruleTitle: The recordDateTime is the date time which the event is recorded in the system of record with an event.status.code=complete
    visibilityCodes:
    - internal
  - rule: R2.1
    ruleTitle: If the event is declared by an actor then the creationDateTime is the date time when the first call is made to the System of Record.
    visibilityCodes:
    - internal
  - rule: R3.2
    ruleTitle: /data/transform is only used during the recording of the event.  The transform is the data that is provided by a user/machine to complete the recording of the event.
    visibilityCodes:
    - internal
  - rule: R1.0
    ruleTitle: event.id is generated once an event is recorded with a event.status.code=complete
    visibilityCodes:
    - internal
  - rule: R0.3
    ruleTitle: 'For Act-As or On-Behalf-Of requests, header ''Cache-Control: no-store'' MUST be set to indicate on server or on UI the response object SHOULD not be cached'
    visibilityCodes:
    - internal
  - rule: R8.1
    ruleTitle: An event notification includes the /data/eventContext and /data/output objects.
    visibilityCodes:
    - internal
  - rule: R8.2
    ruleTitle: An event notification does not include the transform or meta objects.
    visibilityCodes:
    - internal
  - rule: R4.0
    ruleTitle: All envelope data is set by the System of Record (e.g. event.ID, creationDateTime, recordDateTime, event.status.code, etc...
    visibilityCodes:
    - internal
  - rule: R3.6
    ruleTitle: An event which is being recorded includes the /data/eventContext and the /data/transform during the composition phase (i.e. recording of the event).
    visibilityCodes:
    - internal
  - rule: R6.0
    ruleTitle: An event instance may be created by a System of record for a user to complete. This event instance will have a event.status.code=created
    visibilityCodes:
    - internal
  - rule: R0.1
    ruleTitle: If request contains ADP-Act-As-OrgOID, ADP-Act-As-AssociateOID and ADP-Acting-SessionID header values, SOR MUST use ADP-Act-As-AssociateOID header value to authorize the data requested, NOT associateoid header value to authorize the data.
    visibilityCodes:
    - internal
  - rule: R8.3
    ruleTitle: 'A self link is included in the /data/links with 1 links item with the following 2 properties: rel=''self'' href=''/events-notifications/{domain}/v1/{event-name}/{eventID}'''
    visibilityCodes:
    - internal
  - rule: R2.3
    ruleTitle: effectiveDateTime is the date that the event is effective from a business perspective
    visibilityCodes:
    - internal
  - rule: R3.5
    ruleTitle: A complete event has /data/eventContext and /data/output
    visibilityCodes:
    - internal
  - rule: R6.2
    ruleTitle: An event instance which has been recorded has an event.status.code=complete
    visibilityCodes:
    - internal
  - rule: R3.4
    ruleTitle: /data/output may be provided during the recording of the event showing the intermediary results.
    visibilityCodes:
    - internal
  testCaseCollection:
    example:
      href: WFN-CG_USStateTaxProfile.postman_collection.json
    description: Us state tax profile postman collection
  publicationContext:
    products:
    - productId: hcm-offrg-wfn
      productName: workforce now
      marketplaceProductName: ADP Workforce Now®
  specCategoryCode: ''